Skip to content

Search documentation

Search guides, examples, and component APIs.

Quick links
↑↓ NavigateEnter OpenEsc Close
Get started

Documentation navigation

Components / Navigation

Accordion

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.

Interactive showcase

Standard delivery takes three to five business days.

Install

Run in your project
bunx --bun @getweini/cli@latest add accordion

Start with this example

Import 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.

Billing details

Vue
<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.

When to use it

Frequently asked questions

Reveal answers on demand in a compact list.

Grouped settings

Allow several independent setting sections to remain open.

More examples

FAQ

One question stays open at a time.

FAQ
<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>

Multiple sections

Use an array model when several panels can stay expanded.

Multiple sections
<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>

Complete API

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.

Accordion

Complete API for Accordion
NameType or signatureDefaultWhat it does
multiplepropboolean | undefinedNot setAllow more than one item or file to be selected.
collapsiblepropboolean | undefinedNot setAllow this panel to collapse.
disabledpropboolean | undefinedNot setPrevent interaction and show the disabled state.
modelValuemodelstring | 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{}OptionalContent shown inside Accordion.

AccordionContent

Complete API for AccordionContent
NameType or signatureDefaultWhat it does
defaultslot{}OptionalContent shown inside AccordionContent.

AccordionItem

Complete API for AccordionItem
NameType or signatureDefaultWhat it does
valuepropstringRequiredValue represented by this control or option.
disabledpropboolean | undefinedNot setPrevent interaction and show the disabled state.
defaultslot{ open: boolean; }OptionalContent shown inside AccordionItem.

AccordionTrigger

Complete API for AccordionTrigger
NameType or signatureDefaultWhat it does
headingLevelprop2 | 3 | 4 | 5 | 6 | undefined3Choose the heading level used for this title.
defaultslot{}OptionalContent shown inside AccordionTrigger.
Public type definitions
Public types
// 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
}

Implementation notes

  • Choose collapsible when a single-selection accordion should allow every panel to close.
  • Use multiple for independent sections, and give each item a stable value.

Accessibility and localization

  • Triggers and panels have linked ARIA relationships; arrow keys, Home, and End navigate enabled triggers.

Source contract and editing guidance