Storybook
SketchExamples
Code
React
An accordion is made up of one <Accordion> component wrapping one or more <AccordionItem> components. See the sections below for information on each.
<Accordion> component
| Name | Type | Default | Description |
|---|---|---|---|
bordered | boolean | Applies a border to the accordion content. | |
children | React.ReactNode | ||
className | string | Class to be applied to the outer |
<AccordionItem> component
| Name | Type | Default | Description |
|---|---|---|---|
buttonClassName | string | Class to be applied to the header | |
children | React.ReactNode | ||
contentClassName | string | Class to be applied to the content | |
defaultOpen | boolean | Boolean to expand the accordion. | |
headingrequired | React.ReactNode | string | Text for the accordion item heading. | |
headingLevel | '1' | '2' | '3' | '4' | '5' | '6' | '2' | Heading type to override default |
id | string | If not provided, a unique id will be automatically generated and used. | |
isControlledOpen | boolean | Sets the accordion panel's open state. Use this in combination with | |
onChange | () => void | A callback function that's invoked when a controlled accordion panel is selected or deselected. | |
closeIcon | React.ReactNode | <RemoveIcon
className="ds-c-accordion__button-icon"
title={t('accordion.close')}
ariaHidden={false}
/> | Icon to overwrite default close icon |
openIcon | React.ReactNode | <AddIcon
className="ds-c-accordion__button-icon"
title={t('accordion.open')}
ariaHidden={false}
/> | Icon to overwrite default open icon |
Styles
The following Sass variables can be overridden to customize Accordion components:
Guidance
When to use
- Use an accordion to see an overview of multiple, related sections of content
- Use an accordion to show and hide sections as needed
When to consider alternatives
Accordions hide content from users and not everyone will notice them or understand how they work. Accordions increase cognitive load and interaction cost, as users have to make decisions about what headers to click on.
- Don't use an accordion if users need to see most or all of the information on a page.
- Don't use an accordion if there is not enough content to warrant condensing.
Usage
- Make the entire header selectable. Allow users to click anywhere in the header area to expand or collapse the content; a larger target is easier to manipulate.
- Give interactive elements enough space. Make sure interactive elements within the collapsible region are far enough from the headers that users don’t accidentally trigger a collapse.
Accessibility
Keyboard support for the Accordion header includes:
EnterorSpacebar- Changes the collapsed/expanded state of the associated accordion panelArrow Down- Moves focus to the next accordion headerArrow Up- Moves focus to the previous accordion header
Component maturity
For more information about how we tested and validated our work for each checklist item, read our component maturity documentation.