Skip to content

Backdrop API

API documentation for the React Backdrop component. Learn about the available props, and the CSS API.

Import

import Backdrop from '@material-ui/core/Backdrop';
// or
import { Backdrop } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiBackdrop can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
open*boolfalseIf true, the component is shown.
childrennodeThe content of the component.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
componentelementTypeThe 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 the Backdrop. Either a string to use a HTML element or a component.
componentsPropsobject{}The props used for each slot inside the Backdrop.
invisibleboolfalseIf true, the backdrop is invisible. It can be used when rendering a popover or a custom select component.
sxobjectThe system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
transitionDurationnumber
| { 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 (Fade).

Inheritance

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

CSS

Rule nameGlobal classDescription
root.MuiBackdrop-rootStyles applied to the root element.
invisible.MuiBackdrop-invisibleStyles applied to the root element if invisible={true}.

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

Demos