Skip to content
Edit this page

Accordion API

API reference docs for the React Accordion component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import Accordion from '@mui/joy/Accordion';
// or
import { Accordion } from '@mui/joy';
Learn about the difference by reading this guide on minimizing bundle size.

⚠️ Accordion must be used as a direct child of the Card component.

Props

Props of the native component are also available.

accordionId

The id to be used in the AccordionDetails which is controlled by the AccordionSummary. If not provided, the id is autogenerated.

Type:

string
children

Used to render icon or text elements inside the Accordion if src is not set. This can be an element, or just a string.

Type:

node
color

The color of the component. It supports those theme colors that make sense for this component.

To learn how to add your own colors, check out Themed components—Extend colors.

Type:

'danger' | 'neutral' | 'primary' | 'success' | 'warning'

Default:

'neutral'
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
defaultExpanded

If true, expands the accordion by default.

Type:

bool

Default:

false
disabled

If true, the component is disabled.

Type:

bool

Default:

false
expanded

If true, expands the accordion, otherwise collapse it. Setting this prop enables control over the accordion.

Type:

bool
onChange

Callback fired when the expand/collapse state is changed.

Type:

func

Signature:

function(event: React.SyntheticEvent, expanded: boolean) => void
  • event The event source of the callback. Warning: This is a generic event not a change event.
  • expanded The expanded state of the accordion.
slotProps

The props used for each slot inside.

Type:

{ root?: func | object }

Default:

{}
slots

The components used for each slot inside.

See Slots API below for more details.

Type:

{ root?: elementType }

Default:

{}
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
variant

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

Type:

'outlined' | 'plain' | 'soft' | 'solid'

Default:

'plain'
The ref is forwarded to the root element.

Theme default props

You can use JoyAccordion to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

root

The component that renders the root.

Default: 'div'

Global class: .MuiAccordion-root

You can override the style of the component using one of these customization options:

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.Mui-disabledSTATE

Class name applied to the root element if disabled is true.

.Mui-expandedSTATE

Class name applied to the root element if expanded is true.