Skip to content

Modal API

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


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

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.

Component name

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


Props of the native component are also available.

A single child content element.
⚠️ Needs to be able to hold a ref.
If true, the component is shown.
BackdropComponentelementTypestyled(Backdrop, { name: 'MuiModal', slot: 'Backdrop', overridesResolver: (props, styles) => { return styles.backdrop; }, })({ zIndex: -1, })
A backdrop component. This prop enables custom backdrop rendering.
Props applied to the Backdrop element.
Override or extend the styles applied to the component. See CSS API below for more details.
When set to true the Modal waits until a nested Transition is completed before closing.
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 the Modal. Either a string to use a HTML element or a component.
The props used for each slot inside the Modal.
containerHTML element
| func
An HTML element or function that returns one. The container will have the portal children appended to it.
By default, it uses the body of the top-level document object, so it's simply document.body most of the time.
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.
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.
If true, hitting escape will not fire the onClose callback.
The children will be under the DOM hierarchy of the parent component.
If true, the modal will not restore focus to previously focused element once modal is hidden.
Disable the scroll lock behavior.
If true, the backdrop is not rendered.
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.
Callback fired when the backdrop is clicked.
Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

function(event: object, reason: string) => void
event: The event source of the callback.
reason: Can be: "escapeKeyDown", "backdropClick".
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

The ref is forwarded to the root element.


Rule nameGlobal classDescription
root.MuiModal-rootStyles applied to the root element.
hidden.MuiModal-hiddenStyles applied to the root element if the Modal has exited.

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