Accordion API
API documentation for the React Accordion component. Learn about the available props and the CSS API.
Import
import Accordion from '@mui/material/Accordion';
// or
import { Accordion } from '@mui/material';
Component name
The nameMuiAccordion
can be used when providing default props or style overrides in the theme.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 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 | false | 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. | |
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 | Collapse | 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 on Accordion. You can take advantage of this to target nested components.CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiAccordion-root | Styles applied to the root element. |
rounded | .MuiAccordion-rounded | Styles applied to the root element unless square={true} . |
expanded | .Mui-expanded | State class applied to the root element if expanded={true} . |
disabled | .Mui-disabled | State class applied to the root element if disabled={true} . |
gutters | .MuiAccordion-gutters | Styles applied to the root element unless disableGutters={true} . |
region | .MuiAccordion-region | Styles applied to the region element, the container of the children. |
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.