Slide API

API reference docs for the React Slide component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import Slide from '@mui/material/Slide';
// or
import { Slide } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

The Slide transition is used by the Drawer component. It uses react-transition-group internally.

Props

Props of the Transition component are also available.

Name	Type	Default	Description
children*	element	-	A single child content element. This needs to be able to hold a ref.
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 `in` is also `true`. Set this to `false` to disable this behavior.
container	HTML element \| func	-	An HTML element, or a function that returns one. It's used to set the container the Slide is transitioning from.
direction	'down' \| 'left' \| 'right' \| 'up'	'down'	Direction the child node will enter from.
easing	{ enter?: string, exit?: string } \| string	{ enter: theme.transitions.easing.easeOut, exit: theme.transitions.easing.sharp, }	The transition timing function. You may specify a single easing or a object containing enter and exit values.
in	bool	-	If `true`, the component will transition in.
timeout	number \| { appear?: number, enter?: number, exit?: number }	{ enter: theme.transitions.duration.enteringScreen, exit: theme.transitions.duration.leavingScreen, }	The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.

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 in Slide. 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.