Modal API
API reference docs for the React Modal component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import Modal from '@mui/material/Modal';
// or
import { Modal } from '@mui/material';
Modal is a lower-level construct that is leveraged by the following components:
If you are creating a modal dialog, you probably want to use the Dialog component rather than directly using Modal.
This component shares many concepts with react-overlays.
Props of the native component are also available.
A backdrop component. This prop enables custom backdrop rendering.
Type:elementType
Default:styled(Backdrop, {
name: 'MuiModal',
slot: 'Backdrop',
overridesResolver: (props, styles) => {
return styles.backdrop;
},
})({
zIndex: -1,
})
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
When set to true the Modal waits until a nested Transition is completed before closing.
Type:bool
Default:false
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:{ Backdrop?: elementType, 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:{ backdrop?: func
| object, root?: func
| object }
Default:{}
An HTML element or function that returns one. The container
will have the portal children appended to it.
You can also provide a callback, which is called in a React layout effect. This lets you set the container from a ref, and also makes server-side rendering possible.
By default, it uses the body of the top-level document object, so it's simply document.body
most of the time.
Type:HTML element
| func
If true
, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus
prop.
Generally this should never be set to true
as it makes the modal less accessible to assistive technologies, like screen readers.
Type:bool
Default:false
If true
, the modal will not prevent focus from leaving the modal while open.
Generally this should never be set to true
as it makes the modal less accessible to assistive technologies, like screen readers.
Type:bool
Default:false
If true
, hitting escape will not fire the onClose
callback.
Type:bool
Default:false
The children
will be under the DOM hierarchy of the parent component.
Type:bool
Default:false
If true
, the modal will not restore focus to previously focused element once modal is hidden or unmounted.
Type:bool
Default:false
Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.
Type:bool
Default:false
Callback fired when the component requests to be closed. The reason
parameter can optionally be used to control the response to onClose
.
Type:func
function(event: object, reason: string) => void
event
The event source of the callback.reason
Can be:"escapeKeyDown"
,"backdropClick"
.
The props used for each slot inside the Modal.
Type:{ backdrop?: func
| object, root?: func
| object }
Default:{}
The components used for each slot inside the Modal. Either a string to use a HTML element or a component.
Type:{ backdrop?: elementType, 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
ref
is forwarded to the root element.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.