Backdrop API
API reference docs for the React Backdrop component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import Backdrop from '@mui/material/Backdrop';
// or
import { Backdrop } from '@mui/material';
Props of the Fade component are also available.
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
The component used for the root node. Either a string to use a HTML element or a component.
Type: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.
Type:{ Root?: elementType }
Default:{}
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:{}
If true
, the backdrop is invisible. It can be used when rendering a popover or a custom select component.
Type:bool
Default:false
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:{}
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:{}
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
The component used for the transition. Follow this guide to learn more about the requirements for this component.
Type:elementType
Default:Fade
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.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
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.