Backdrop API

The API documentation of the Backdrop React component. Learn more about the props and the CSS customization points.

Import

import Backdrop from '@material-ui/core/Backdrop';
// or
import { Backdrop } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Props

Name	Type	Default	Description
backgroundColor	'black' | 'white'	'black'	The background color.
children	node		The content of the component.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
invisible	bool	false	If true, the backdrop is invisible. It can be used when rendering a popover or a custom select component.
open *	bool		If true, the backdrop is open.
transitionDuration	number | { appear?: number, enter?: number, exit?: number }		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.

Any other props supplied will be provided to the root element (native element).

CSS

• Style sheet name: MuiBackdrop.
• Style sheet details:

Rule name	Global class	Description
root	.MuiBackdrop-root	Styles applied to the root element.
invisible	.MuiBackdrop-invisible	Styles applied to the root element if invisible={true}.
black	.MuiBackdrop-black	Styles applied to the root element if backgroundColor="black.
white	.MuiBackdrop-white	Styles applied to the root element if backgroundColor="white.

You can override the style of the component thanks to one of these customization points:

• With a rule name of the classes object prop.
• With a global class name.
• With a theme and an overrides property.

If that's not sufficient, you can check the implementation of the component for more detail.

Demos

• Backdrop