CMS Design System

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

`<Accordion>`

Code snippet

Props

React Properties Documentation
Name	Type	Description
`bordered`	`boolean`	Applies a border to the accordion content.
`children`	`React.ReactNode`
`className`	`string`	Class to be applied to the outer `<div>` that contains all accordion items.

`<AccordionItem>`

View Source File

AccordionItem renders the Accordion element.

Accordion Item Props

React Properties Documentation
Name	Type	Default	Description
`buttonClassName`	`string`		Class to be applied to the header `<button>` of an accordion item.
`children`	`React.ReactNode`
`contentClassName`	`string`		Class to be applied to the content `<div>` tag of an accordion item.
`defaultOpen`	`boolean`		Boolean to expand the accordion.
`heading`required	`React.ReactNode \| string`		Text for the accordion item heading.
`headingLevel`	`'1' \| '2' \| '3' \| '4' \| '5' \| '6'`	`'2'`	Heading type to override default `<h2>`.
`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` for a controlled accordion; otherwise, set `defaultOpen`.
`onChange`	`() => void`		A callback function that's invoked when a controlled accordion panel is selected or deselected.

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

Customization

The following Sass variables can be overridden to customize Accordion components:

Variable	Default 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`