Skip to content
Edit this page

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:

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.

openRequired

If true, the component is shown.

Type:

bool
children

The content of the component.

Type:

node
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
components

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.

Type:

{ Root?: elementType }

Default:

{}
componentsProps

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.

Type:

{ root?: object }

Default:

{}
invisible

If true, the backdrop is invisible. It can be used when rendering a popover or a custom select component.

Type:

bool

Default:

false
slotProps

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.

Type:

{ root?: object }

Default:

{}
slots

The components used for each slot inside.
This prop is an alias for the components prop, which will be deprecated in the future.

Type:

{ root?: elementType }

Default:

{}
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
TransitionComponent

The component used for the transition. Follow this guide to learn more about the requirements for this component.

Type:

elementType

Default:

Fade
transitionDuration

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


.MuiBackdrop-rootroot

Styles applied to the root element.

.MuiBackdrop-invisibleinvisible

Styles applied to the root element if invisible={true}.

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