Slide API

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

Component 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.

childrenRequired

A single child content element.

This needs to be able to hold a ref.

Type:element

addEndListener

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.

Type:func

appear

Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.

Type:bool

Default:true

container

An HTML element, or a function that returns one. It's used to set the container the Slide is transitioning from.

Type:HTML element | func

direction

Direction the child node will enter from.

Type:'down' | 'left' | 'right' | 'up'

Default:'down'

easing

The transition timing function. You may specify a single easing or a object containing enter and exit values.

Type:{ enter?: string, exit?: string } | string

Default:{ enter: theme.transitions.easing.easeOut, exit: theme.transitions.easing.sharp, }

If true, the component will transition in.

Type:bool

timeout

The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.

Type:number | { appear?: number, enter?: number, exit?: number }

Default:{ enter: theme.transitions.duration.enteringScreen, exit: theme.transitions.duration.leavingScreen, }

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.