Grow API
API reference docs for the React Grow component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import Grow from '@mui/material/Grow';
// or
import { Grow } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.
Props of the Transition component are also available.
| Name | Type | Default | Description |
|---|---|---|---|
| children* | element | - |
A single child content element. |
| addEndListener | func | - |
Add a custom transition end trigger. Use it when you need custom logic to decide when the transition has ended. Note: Timeouts are still used as a fallback if provided.
Signature:
function(node:
HTMLElement, done:
Function) =>
void
|
| appear | bool | true |
Perform the enter transition
when it first mounts if
|
| disablePrefersReducedMotion | bool | false |
If |
| easing |
{ enter?: string, exit?:
string } | string |
- |
The transition timing function. You may specify a single easing or a object containing enter and exit values. |
| in | bool | - |
If |
| timeout |
'auto' | number | { appear?: number, enter?: number, exit?: number } |
'auto' |
The duration for the
transition, in milliseconds.
You may specify a single
timeout for all transitions,
or individually with an
object. |
ref is forwarded to the root
element.
Inheritance
While not explicitly documented above, the props of the Transition component from react-transition-group are also available in Grow. You can take advantage of this to target nested components.
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.