Skip to main content
U.S. Flag

An official website of the United States government

Accordion

An accordion is a list of headers that hide or reveal additional content when selected.

Warning: draftGithubStorybook logoStorybookSketch logoSketch

Examples

Loading

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

React Properties Documentation
NameTypeDefaultDescription
borderedboolean

Applies a border to the accordion content.

childrenReact.ReactNode
classNamestring

Class to be applied to the outer <div> that contains all accordion items.

<AccordionItem> component

React Properties Documentation
NameTypeDefaultDescription
buttonClassNamestring

Class to be applied to the header <button> of an accordion item.

childrenReact.ReactNode
contentClassNamestring

Class to be applied to the content <div> tag of an accordion item.

defaultOpenboolean

Boolean to expand the accordion.

headingrequiredReact.ReactNode | string

Text for the accordion item heading.

headingLevel'1' | '2' | '3' | '4' | '5' | '6''2'

Heading type to override default <h2>.

idstring

If not provided, a unique id will be automatically generated and used.

isControlledOpenboolean

Sets the accordion panel's open state. Use this in combination with onChange for a controlled accordion; otherwise, set defaultOpen.

onChange() => void

A callback function that's invoked when a controlled accordion panel is selected or deselected.

closeIconReact.ReactNode<RemoveIcon className="ds-c-accordion__button-icon" title={t('accordion.close')} ariaHidden={false} />

Icon to overwrite default close icon

openIconReact.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:

Sass variables for accordion
VariableDefault Core Theme Value
$accordion__color$color-base
$accordion__background-color$color-gray-lightest
$accordion__background-color--hover$color-border
$accordion__border-color$color-gray-lightest
$accordion-button__color$color-base
$accordion-content__background-color$color-white

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:

  • Enter or Spacebar - Changes the collapsed/expanded state of the associated accordion panel
  • Arrow Down - Moves focus to the next accordion header
  • Arrow Up - Moves focus to the previous accordion header