Skip to content

Collapse API

API documentation for the React Collapse component. Learn about the available props, and the CSS API.

Import

import Collapse from '@material-ui/core/Collapse';
// or
import { Collapse } from '@material-ui/core';
You can 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.

Component name

The name MuiCollapse can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
childrennodeThe content node to be collapsed.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
collapsedSizenumber
| string
'0px'The width (horizontal) or height (vertical) of the container when collapsed.
componentelement typeThe component used for the root node. Either a string to use a HTML element or a component.
⚠️ Needs to be able to hold a ref.
inboolfalseIf true, the component will transition in.
orientation'horizontal'
| 'vertical'
'vertical'The transition orientation.
timeout'auto'
| number
| { appear?: number, enter?: number, exit?: number }
duration.standardThe 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).

Inheritance

While not explicitly documented above, the props of the Transition component from react-transition-group are also available on Collapse. You can take advantage of this to target nested components.

CSS

Rule nameGlobal classDescription
root.MuiCollapse-rootStyles applied to the root element.
horizontal.MuiCollapse-horizontalPseudo-class applied to the root element if orientation="horizontal".
entered.MuiCollapse-enteredStyles applied to the root element when the transition has entered.
hidden.MuiCollapse-hiddenStyles applied to the root element when the transition has exited and collapsedSize = 0px.
wrapper.MuiCollapse-wrapperStyles applied to the outer wrapper element.
wrapperInner.MuiCollapse-wrapperInnerStyles applied to the inner wrapper element.

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos