The accordion component is a collection of vertically collapsing header and body elements that can be used to show and hide information based on the Tailwind CSS utility classes and JavaScript.
A popular use case would be the “Frequently Asked Questions” section of a website or page when you can show questions and answers for each child element.
Setup
<script lang="ts">
import { AccordionItem, Accordion } from '.';
</script> Default accordion
Accordion uses the single selection mode by default i.e. it collapses every other child element when expanding a one.
To prevent that behavior set multiple property to true.
<script lang="ts">
import { AccordionItem, Accordion } from '.';
</script>
<Accordion>
<AccordionItem>
{#snippet header()}My Header 1{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
<p class="text-gray-500 dark:text-gray-400">
Check out this guide to learn how to <a
href="/"
target="_blank"
rel="noreferrer"
class="text-blue-600 hover:underline dark:text-blue-500">get started</a
>
and start developing websites even faster with components on top of Tailwind CSS.
</p>
</AccordionItem>
<AccordionItem>
{#snippet header()}My Header 2{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
<p class="mb-2 text-gray-500 dark:text-gray-400">Learn more about these technologies:</p>
<ul class="list-disc ps-5 text-gray-500 dark:text-gray-400">
<li>
<a
href="/"
target="_blank"
rel="noreferrer"
class="text-blue-600 hover:underline dark:text-blue-500">Lorem ipsum</a
>
</li>
<li>
<a
href="https://tailwindui.com/"
rel="noreferrer"
target="_blank"
class="text-blue-600 hover:underline dark:text-blue-500">Tailwind UI</a
>
</li>
</ul>
</AccordionItem>
</Accordion> Always open
Use the open prop to make an item open on mount.
<script lang="ts">
import { AccordionItem, Accordion } from '.';
</script>
<Accordion>
<AccordionItem open>
{#snippet header()}Header 2-1{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
</AccordionItem>
<AccordionItem>
{#snippet header()}Header 2-2{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
</AccordionItem>
</Accordion> Color option
You can control the look and feel of AccordionItems by overwriting the activeClass and inactiveClass properties. You can define them in Accordion so that they will apply to all children or set them individually on each AccordionItem.
<script lang="ts">
import { AccordionItem, Accordion } from '.';
</script>
<Accordion
activeClass="bg-blue-100 dark:bg-gray-800 text-blue-600 dark:text-white focus:ring-4 focus:ring-blue-200 dark:focus:ring-blue-800"
inactiveClass="text-gray-500 dark:text-gray-400 hover:bg-blue-100 dark:hover:bg-gray-800"
>
<AccordionItem>
{#snippet header()}Header 2-1{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
</AccordionItem>
<AccordionItem>
{#snippet header()}Header 2-2{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
</AccordionItem>
</Accordion> Flush accordion
Use flush prop to remove the rounded borders.
<script lang="ts">
import { AccordionItem, Accordion } from '.';
</script>
<Accordion flush>
<AccordionItem>
{#snippet header()}Header 2-1{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
</AccordionItem>
<AccordionItem>
{#snippet header()}Header 2-2{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
</AccordionItem>
</Accordion> Arrow style
Use the arrowup and arrowdown snippets to set up and down icons.
<script lang="ts">
import { AccordionItem, Accordion } from '.';
</script>
<Accordion>
<AccordionItem>
{#snippet header()}Header 2-1{/snippet}
{#snippet arrowup()}
<iconify-icon class="-me-0.5 h-6 w-6"></iconify-icon>
{/snippet}
{#snippet arrowdown()}
<iconify-icon class="-me-0.5 h-6 w-6"></iconify-icon>
{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
</AccordionItem>
<AccordionItem>
{#snippet header()}Header 2-2{/snippet}
{#snippet arrowup()}
<ChevronDoubleUpOutline class="-me-0.5 h-6 w-6" />
{/snippet}
{#snippet arrowdown()}
<ChevronDoubleDownOutline class="-me-0.5 h-6 w-6" />
{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
</AccordionItem>
</Accordion> Icon Accordion
Use header snippet to add your icon and title.
<script lang="ts">
import { AccordionItem, Accordion } from '.';
</script>
<Accordion>
<AccordionItem>
{#snippet header()}
<div class="flex items-center gap-2">
<iconify-icon icon="name_of_icon"></iconify-icon>
<span>My Header 1</span>
</div>
{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo...
</p>
<p class="text-gray-500 dark:text-gray-400">
Check out this guide to learn how to <a
href="/"
target="_blank"
rel="noreferrer"
class="text-blue-600 hover:underline dark:text-blue-500">get started</a
>
and start websites even faster with components on top of Tailwind CSS.
</p>
</AccordionItem>
<AccordionItem>
{#snippet header()}
<div class="flex items-center gap-2">
<iconify-icon icon="name_of_icon"></iconify-icon>
<span>My Header 2</span>
</div>
{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus
sintexplicabo...
</p>
</AccordionItem>
</Accordion> Multiple mode
Use multiple to open all accordion items.
<script lang="ts">
import { Accordion, AccordionItem } from '.';
</script>
<Accordion multiple>
<AccordionItem open>
{#snippet header()}
Header 1-1
{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
</AccordionItem>
<AccordionItem open>
{#snippet header()}
Header 1-2
{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
</AccordionItem>
</Accordion> Another example how to use the multiple option together with expand all behavior.
<script lang="ts">
import { AccordionItem, Accordion, Button, P } from '.';
const items = $state([false, false, false]);
const open_all = () => items.forEach((_, i) => (items[i] = true));
const close_all = () => items.forEach((_, i) => (items[i] = false));
</script>
<Button onclick={open_all}>Open all</Button>
<Button onclick={close_all}>Close all</Button>
<Accordion multiple>
<AccordionItem bind:open={items[0]}>
{#snippet header()}My Header 1{/snippet}
<P class="mb-2"
>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...</P
>
<P class="text-gray-500 dark:text-gray-400">
Check out this guide to learn how to <a
href="/"
target="_blank"
rel="noreferrer"
class="text-blue-600 hover:underline dark:text-blue-500">get started</a
>
and start developing websites even faster with components on top of Tailwind CSS.
</P>
</AccordionItem>
<AccordionItem bind:open={items[1]}>
{#snippet header()}My Header 2{/snippet}
<P class="mb-2"
>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...</P
>
<P class="mb-2"
>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...</P
>
<P class="mb-2">Learn more about these technologies:</P>
</AccordionItem>
<AccordionItem bind:open={items[2]}>
{#snippet header()}My Header 3{/snippet}
<P>Something more</P>
</AccordionItem>
</Accordion> Custom transitions
The default transition of AccordionItems is slide. Use the transitionType and transitionParams prop to make custom transitions.
<script lang="ts">
import { AccordionItem, Accordion } from '.';
import { blur, fade } from 'svelte/transition';
</script>
<Accordion>
<AccordionItem transitionParams={{ duration: 1000 }}>
{#snippet header()}Slide duration:1000{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
</AccordionItem>
<AccordionItem transitionType={blur} transitionParams={{ duration: 300 }}>
{#snippet header()}Blur duration:300{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
</AccordionItem>
<AccordionItem transitionType={fade} transitionParams={{ duration: 300 }}>
{#snippet header()}Fade duration:300{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
</AccordionItem>
</Accordion> Nesting accordions
Accordions can be nested. All of the mentioned options are supported.
<Accordion>
<AccordionItem open>
{#snippet header()}My Header 1{/snippet}
<Accordion>
<AccordionItem>
{#snippet header()}My Header 1{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
<p class="text-gray-500 dark:text-gray-400">
Check out this guide to learn how to <a
href="/"
target="_blank"
rel="noreferrer"
class="text-blue-600 hover:underline dark:text-blue-500">get started</a
>
and start developing websites even faster with components on top of Tailwind CSS.
</p>
</AccordionItem>
<AccordionItem>
{#snippet header()}My Header 2{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
<p class="mb-2 text-gray-500 dark:text-gray-400">Learn more about these technologies:</p>
<ul class="list-disc ps-5 text-gray-500 dark:text-gray-400">
<li>
<a
href="/"
target="_blank"
rel="noreferrer"
class="text-blue-600 hover:underline dark:text-blue-500">Lorem ipsum</a
>
</li>
<li>
<a
href="https://tailwindui.com/"
rel="noreferrer"
target="_blank"
class="text-blue-600 hover:underline dark:text-blue-500">Tailwind UI</a
>
</li>
</ul>
</AccordionItem>
</Accordion>
</AccordionItem>
<AccordionItem>
{#snippet header()}My Header 2{/snippet}
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
<p class="mb-2 text-gray-500 dark:text-gray-400">
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo ab necessitatibus sint
explicabo ...
</p>
<p class="mb-2 text-gray-500 dark:text-gray-400">Learn more about these technologies:</p>
<ul class="list-disc ps-5 text-gray-500 dark:text-gray-400">
<li>
<a
href="/"
target="_blank"
rel="noreferrer"
class="text-blue-600 hover:underline dark:text-blue-500">Lorem ipsum</a
>
</li>
<li>
<a
href="https://tailwindui.com/"
rel="noreferrer"
target="_blank"
class="text-blue-600 hover:underline dark:text-blue-500">Tailwind UI</a
>
</li>
</ul>
</AccordionItem>
</Accordion> Using transitionType="none"
When you set transitionType="none" on an Accordion or an AccordionItem, it disables Svelte transitions completely and instead uses CSS display properties (block/hidden) to show or hide content. It prevents Svelte from completely destroying and recreating components when toggling the accordion.
<script lang="ts">
import { AccordionItem, Accordion } from '.';
</script>
<Accordion transitionType="none">
<AccordionItem>
{#snippet header()}My Header 1{/snippet}
Content A
</AccordionItem>
<AccordionItem>
{#snippet header()}My Header 2{/snippet}
Content B
</AccordionItem>
</Accordion>
<Accordion>
<AccordionItem transitionType="none">
{#snippet header()}transitionType: "none"{/snippet}
Content C
</AccordionItem>
<AccordionItem>
{#snippet header()}transitionType: default{/snippet}
Content D
</AccordionItem>
</Accordion> Composition notes
- Nest
AccordionItemonly underAccordion. Context sharesflush,activeClass,inactiveClass, andtransitionType. - Item-level
activeClass/inactiveClass/transitionTypeoverride the parent. - Customize the toggle affordance with
arrowup/arrowdownsnippets; useheaderfor the title row.
Props
AccordionProps
| Prop | Type | Default | Description |
|---|---|---|---|
children | Snippet | — | One or more AccordionItems |
multiple | boolean | false | Allow several open panels |
flush | boolean | false | Borderless flush layout |
color | primary | secondary | — | Accent color token |
activeClass | string | — | Classes for open item headers |
inactiveClass | string | — | Classes for closed item headers |
transitionType | TransitionFunc | 'none' | slide (default impl) | Panel transition; 'none' uses CSS show/hide |
class | ClassValue | — | Root classes |
…rest | div attrs | — | Forwarded to the root |
AccordionItemProps
| Prop | Type | Default | Description |
|---|---|---|---|
children | Snippet | — | Panel body |
open | boolean | false | Bindable expanded state |
header | Snippet | — | Header / trigger content |
arrowup | Snippet | — | Icon when open |
arrowdown | Snippet | — | Icon when closed |
activeClass | string | — | Override open header classes |
inactiveClass | string | — | Override closed header classes |
transitionType | TransitionFunc | 'none' | inherited | Per-item transition |
transitionParams | ParamsType | — | Transition params |
headerClass | string | — | Extra header button classes |
contentClass | string | — | Extra panel content classes |
flush | boolean | inherited | Item flush variant |
class | ClassValue | — | Root classes |
…rest | div attrs | — | Forwarded to the root |
Snippets
| Snippet | Component | Description |
|---|---|---|
children | Accordion | Accordion items |
children | AccordionItem | Expanded body |
header | AccordionItem | Trigger label / content |
arrowup | AccordionItem | Open-state indicator |
arrowdown | AccordionItem | Closed-state indicator |