Skip to content

Grow API

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

Import

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

Props of the Transition component are also available.

NameTypeDefaultDescription
appearbooltrue
Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.
childrenelement
A single child content element.
⚠️ Needs to be able to hold a ref.
easing{ enter?: string, exit?: string }
| string
The transition timing function. You may specify a single easing or a object containing enter and exit values.
inboolfalse
If true, the component will transition in.
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.
Set to 'auto' to automatically calculate transition time based on height.

The 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 on Grow. You can take advantage of this to target nested components.

Demos