import Collapse from '@mui/material/Collapse';
// or
import { Collapse } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.
The Collapse transition is used by the Vertical Stepper StepContent component. It uses react-transition-group internally.
Props of the Transition component are also available.
| Name | Type | Default | Description |
|---|---|---|---|
| addEndListener | func | - | Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine-grained transition end logic. Note: Timeouts are still used as a fallback if provided. |
| children | node | - | The content node to be collapsed. |
| classes | object | - | Override or extend the styles applied to the component. See CSS classes API below for more details. |
| collapsedSize | number | string | ‘0px’ | The width (horizontal) or height (vertical) of the container when collapsed. |
| component | element type | - | The component used for the root node. Either a string to use a HTML element or a component. |
| easing | { enter?: string, exit?: string } | string | - | The transition timing function. You may specify a single easing or an object containing enter and exit values. |
| in | bool | - | If true, the component will transition in. |
| orientation | ‘horizontal’ | ‘vertical’ | ‘vertical’ | The transition orientation. |
| 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. |
| timeout | ‘auto’ | number | { appear?: number, enter?: number, exit?: number } | duration.standard | The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object. Set to ‘auto’ to automatically calculate transition time based on height. |
The ref is forwarded to the root element.
While not explicitly documented above, the props of the Transition component from react-transition-group are also available in Collapse. You can take advantage of this to target nested components.
You can use MuiCollapse to change the default props of this component with the theme.
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 |
|---|---|---|
| .MuiCollapse-entered | entered | Styles applied to the root element when the transition has entered. |
| .MuiCollapse-hidden | hidden | Styles applied to the root element when the transition has exited and collapsedSize = 0px. |
| .MuiCollapse-horizontal | horizontal | State class applied to the root element if orientation="horizontal". |
| .MuiCollapse-root | root | Styles applied to the root element. |
| .MuiCollapse-wrapper | wrapper | Styles applied to the outer wrapper element. |
| .MuiCollapse-wrapperInner | wrapperInner | Styles applied to the inner wrapper element. |
You can override the style of the component using one of these customization options:
styleOverrides property in a custom theme.If you did not find the information in this page, consider having a look at the implementation of the component for more detail.