0 Tk

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 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 classes 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.
componentsProps { root?: object } {} The extra props for the slot components. You can override the existing props or add new ones.
invisible bool false If true, the backdrop is invisible. It can be used when rendering a popover or a custom select component.
slotProps { root?: func | object, transition?: func | object } {} The props used for each slot inside.
slots { root?: elementType, transition?: elementType } {} The components used for each slot inside.
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.

Slot name Class name Default component Description
root .MuiBackdrop-root 'div' The component that renders the root.
transition - Fade The component that renders the transition. Follow this guide to learn more about the requirements for this component.

These class names are useful for styling with CSS. They are applied to the component’s slots when specific states are triggered.

Class name Rule name Description
.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:

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.