Frequently asked questions
Reveal answers on demand in a compact list.
Components / Navigation
A keyboard-navigable disclosure group with single or multiple open sections.
Last changed in version 0.14.2: Improve keyboard navigation, action feedback, and selected colors across Vue components.
bunx --bun @getweini/cli@latest add accordionImport the files copied by the install command, then place the component in your Vue template. The text and values in the example belong to your app; change them to fit your task.
<script setup lang="ts">
import { ref } from 'vue'
import Accordion from './components/ui/accordion/Accordion.vue'
import AccordionContent from './components/ui/accordion/AccordionContent.vue'
import AccordionItem from './components/ui/accordion/AccordionItem.vue'
import AccordionTrigger from './components/ui/accordion/AccordionTrigger.vue'
const openSection = ref('billing')
</script>
<template>
<Accordion v-model="openSection" collapsible>
<AccordionItem value="billing">
<AccordionTrigger>Billing</AccordionTrigger>
<AccordionContent>Billing details</AccordionContent>
</AccordionItem>
<AccordionItem value="security">
<AccordionTrigger>Security</AccordionTrigger>
<AccordionContent>Security settings</AccordionContent>
</AccordionItem>
</Accordion>
</template>Each trigger is linked to its panel. Arrow keys, Home, and End move between enabled triggers. Place AccordionItem, AccordionTrigger, and AccordionContent inside Accordion.
Reveal answers on demand in a compact list.
Allow several independent setting sections to remain open.
One question stays open at a time.
<script setup lang="ts">
import Accordion from './components/ui/accordion/Accordion.vue'
import AccordionContent from './components/ui/accordion/AccordionContent.vue'
import AccordionItem from './components/ui/accordion/AccordionItem.vue'
import AccordionTrigger from './components/ui/accordion/AccordionTrigger.vue'
</script>
<template>
<Accordion collapsible>
<AccordionItem value="invite">
<AccordionTrigger>How do I invite a teammate?</AccordionTrigger>
<AccordionContent>Open Members and choose Invite.</AccordionContent>
</AccordionItem>
<AccordionItem value="export">
<AccordionTrigger>Can I export data?</AccordionTrigger>
<AccordionContent>Use Export from the project settings page.</AccordionContent>
</AccordionItem>
</Accordion>
</template>Use an array model when several panels can stay expanded.
<script setup lang="ts">
import { ref } from 'vue'
import Accordion from './components/ui/accordion/Accordion.vue'
import AccordionContent from './components/ui/accordion/AccordionContent.vue'
import AccordionItem from './components/ui/accordion/AccordionItem.vue'
import AccordionTrigger from './components/ui/accordion/AccordionTrigger.vue'
const open = ref<string[]>(['profile'])
</script>
<template>
<Accordion v-model="open" multiple>
<AccordionItem value="profile">
<AccordionTrigger>Profile</AccordionTrigger>
<AccordionContent>Public details</AccordionContent>
</AccordionItem>
<AccordionItem value="privacy">
<AccordionTrigger>Privacy</AccordionTrigger>
<AccordionContent>Visibility settings</AccordionContent>
</AccordionItem>
</Accordion>
</template>Every public prop, model, event, slot, and exposed member of the installed Vue parts is listed below. “Not set” means you can leave that value out; “Required” means you must provide it. Native HTML attributes also work where the component uses a native element.
| Name | Type or signature | Default | What it does |
|---|---|---|---|
multipleprop | boolean | undefined | Not set | Allow more than one item or file to be selected. |
collapsibleprop | boolean | undefined | Not set | Allow this panel to collapse. |
disabledprop | boolean | undefined | Not set | Prevent interaction and show the disabled state. |
modelValuemodel | string | string[] | undefined | "" | Current value. Use v-model to keep it in sync with your page. |
update:modelValueevent | [value: string | string[]] | — | Requests a new model value from the parent. |
defaultslot | {} | Optional | Content shown inside Accordion. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
defaultslot | {} | Optional | Content shown inside AccordionContent. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
valueprop | string | Required | Value represented by this control or option. |
disabledprop | boolean | undefined | Not set | Prevent interaction and show the disabled state. |
defaultslot | { open: boolean; } | Optional | Content shown inside AccordionItem. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
headingLevelprop | 2 | 3 | 4 | 5 | 6 | undefined | 3 | Choose the heading level used for this title. |
defaultslot | {} | Optional | Content shown inside AccordionTrigger. |
// packages/frameworks/vue/components/accordion/types.ts
export interface AccordionProps {
multiple?: boolean
collapsible?: boolean
disabled?: boolean
}
export interface AccordionItemProps {
value: string
disabled?: boolean
}
export interface AccordionTriggerProps {
headingLevel?: 2 | 3 | 4 | 5 | 6
}