Backdrop API
Import
import Backdrop from '@mui/material/Backdrop';
// or
import { Backdrop } from '@mui/material';
Component name
The nameMuiBackdrop
can be used when providing default props or style overrides in the theme.Props
Props of the Fade component are also available.
Name | Type | Default | Description |
---|---|---|---|
open* | bool | false | 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. | |
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 on Backdrop. You can take advantage of this to target nested components.CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiBackdrop-root | Styles applied to the root element. |
invisible | .MuiBackdrop-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.