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/material/Accordion';
// or
import { Accordion } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the Paper component are also available.

Name	Type	Default	Description
children*	node	-	The content of the component.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
defaultExpanded	bool	false	If `true`, expands the accordion by default.
disabled	bool	false	If `true`, the component is disabled.
disableGutters	bool	false	If `true`, it removes the margin between two expanded accordion items and the increase of height.
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	{ heading?: func \| object, transition?: func \| object }	{}	The props used for each slot inside.
slots	{ heading?: elementType, transition?: elementType }	{}	The components used for each slot inside.
square	bool	false	If `true`, rounded corners are disabled.
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.
TransitionComponent	elementType	-	The component used for the transition. Follow this guide to learn more about the requirements for this component.
TransitionProps	object	-	Props applied to the transition element. By default, the element is based on this `Transition` component.

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the Paper component are also available in Accordion. You can take advantage of this to target nested components.

Theme default props

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

Slots

Slot name	Class name	Default component	Description
heading	.MuiAccordion-heading	`'h3'`	The component that renders the heading.
transition		`Collapse`	The component that renders the transition. Follow this guide to learn more about the requirements for this component.

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		State class applied to the root element if `disabled={true}`.
.Mui-expanded		State class applied to the root element if `expanded={true}`.
.MuiAccordion-gutters	gutters	Styles applied to the root element unless `disableGutters={true}`.
.MuiAccordion-region	region	Styles applied to the region element, the container of the children.
.MuiAccordion-root	root	Styles applied to the root element.
.MuiAccordion-rounded	rounded	Styles applied to the root element unless `square={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.