Backdrop API

API reference docs for the React Backdrop 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:

Backdrop

Import

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

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

Props

Props of the Fade component are also available.

Name	Type	Default	Description
open*	bool		If `true`, the component is shown.
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.
component	elementType		The component used for the root node. Either a string to use a HTML element or a component.
components	{ Root?: elementType }	{}	The components used for each slot inside. This prop is an alias for the `slots` prop. It's recommended to use the `slots` prop instead.
componentsProps	{ root?: object }	{}	The extra props for the slot components. You can override the existing props or add new ones. This prop is an alias for the `slotProps` prop. It's recommended to use the `slotProps` prop instead, as `componentsProps` will be deprecated in the future.
invisible	bool	false	If `true`, the backdrop is invisible. It can be used when rendering a popover or a custom select component.
slotProps	{ root?: object }	{}	The extra props for the slot components. You can override the existing props or add new ones. This prop is an alias for the `componentsProps` prop, which will be deprecated in the future.
slots	{ root?: elementType }	{}	The components used for each slot inside. This prop is an alias for the `components` prop, which will be deprecated in the future.
sx	Array<func \| object \| bool> \| func \| object		The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
TransitionComponent	elementType	Fade	The component used for the transition. Follow this guide to learn more about the requirements for this component.
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.

Inheritance

While not explicitly documented above, the props of the Fade component are also available in Backdrop. You can take advantage of this to target nested components.

Theme default props

You can use MuiBackdrop to change the default props of this component with the theme.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

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

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.