Grow API
API reference docs for the React Grow component. Learn about the props, CSS, and other APIs of this exported module.
import Grow from '@mui/material/Grow';
// or
import { Grow } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.
The Grow transition is used by the Tooltip and Popover components. It uses react-transition-group internally.
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. 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. |
appear | bool | true | Perform the enter transition when it first mounts 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.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.
If you did not find the information in this page, consider having a look at the implementation of the component for more detail.