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:

Accordion

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.

Props

Props of the native component are also available.

Name	Type	Default	Description
accordionId	string	-	The id to be used in the AccordionDetails which is controlled by the AccordionSummary. If not provided, the id is autogenerated.
children	node	-	Used to render icon or text elements inside the Accordion if `src` is not set. This can be an element, or just a string.
color	'danger' \| 'neutral' \| 'primary' \| 'success' \| 'warning'	'neutral'	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.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
defaultExpanded	bool	false	If `true`, expands the accordion by default.
disabled	bool	false	If `true`, the component is disabled.
expanded	bool	-	If `true`, expands the accordion, otherwise collapse it. Setting this prop enables control over the accordion.
onChange	func	-	Callback fired when the expand/collapse state is changed. 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	{ root?: func \| object }	{}	The props used for each slot inside.
slots	{ root?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
sx	Array<func \| object \| bool> \| func \| object	-	The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid'	'plain'	The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

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.

Slot name	Class name	Default component	Description
root	.MuiAccordion-root	`'div'`	The component that renders the root.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.Mui-disabled		Class name applied to the root element if `disabled` is true.
.Mui-expanded		Class name applied to the root element if `expanded` is true.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.