Collapsible
One section that opens and closes.
In Accessible first
See it live
Start Storybook to see it live:
npm run storybookWhen to use it
In Accessible first: Optional help a person can open.
- Use it when: A single block of extra detail people may want: more filters, advanced options.
- Not when: Several stacked sections (accordion), or content everyone needs.
Instead:
- Accordion: A stack of sections.
Words
- Use common words. Explain any term you must use.
- One idea per sentence. Put the action first.
- Never blame the person.
- Use: Continue, Change, Start, You. Avoid: Invalid, Utilise, Submit, Error code.
The labels components use, from the voice tokens:
content.action.commit: Continuecontent.action.cancel: Go backcontent.action.destroy: Deletecontent.action.retry: Try againcontent.action.empty-action: Start a new application
See Voice and tone for the whole voice.
Accessibility and keyboard
| Keyboard | What happens | Not |
|---|---|---|
| undefined | Enter or Space opens and closes. | undefined |
Test before you ship:
- The trigger is a button that says whether it is open. undefined
Use it in code
npx open-ds add collapsible
The component reads only component keys and semantic tokens, so it follows the brand and mode on <html>.
Tokens it reads
Collapsible sets no colors, corners or shadows of its own; it takes them from the components inside it.