Collapse API
The API documentation of the Collapse React component. Learn more about the props and the CSS customization points.
Import
import Collapse from '@material-ui/core/Collapse';
// or
import { Collapse } from '@material-ui/core';You can learn more about the difference by reading this guide.
The Collapse transition is used by the Vertical Stepper StepContent component. It uses react-transition-group internally.
Component name
The MuiCollapse name can be used for providing default props or style overrides at the theme level.
Props
| Name | Type | Default | Description |
|---|---|---|---|
| children | node | The content node to be collapsed. | |
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| oneOfType([PropTypes.number | Deprecated. The prop was renamed to support the vertical orientation, use collapsedSize insteadThe height of the container when collapsed. |
||
| collapsedSize | number | string |
'0px' | The height of the container when collapsed. |
| component | elementType | 'div' | The component used for the root node. Either a string to use a HTML element or a component. |
| disableStrictModeCompat | bool | false | Enable this prop if you encounter 'Function components cannot be given refs', use unstable_createStrictModeTheme, and can't forward the ref in the passed Component. |
| in | bool | If true, the component will transition in. |
|
| 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.
Any other props supplied will be provided to the root element (Transition).
CSS
| Rule name | Global class | Description |
|---|---|---|
| root | .MuiCollapse-root | Styles applied to the root element. |
| entered | .MuiCollapse-entered | Styles applied to the root element when the transition has entered. |
| hidden | .MuiCollapse-hidden | Styles applied to the root element when the transition has exited and collapsedSize != 0px. |
| wrapper | .MuiCollapse-wrapper | Styles applied to the outer wrapper element. |
| wrapperInner | .MuiCollapse-wrapperInner | Styles applied to the inner wrapper element. |
You can override the style of the component thanks to one of these customization points:
- With a rule name of the
classesobject prop. - With a global class name.
- With a theme and an
overridesproperty.
If that's not sufficient, you can check the implementation of the component for more detail.
Inheritance
The props of the Transition component, from react-transition-group, are also available. You can take advantage of this behavior to target nested components.