Modal API

API reference docs for the React Modal component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Modal

Import

import Modal from '@mui/material/Modal';
// or
import { Modal } from '@mui/material';

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.

Props

Props of the native component are also available.

Name	Type	Default	Description
children*	element	-	A single child content element. This needs to be able to hold a ref.
open*	bool	-	If `true`, the component is shown.
BackdropComponent	elementType	styled(Backdrop, { name: 'MuiModal', slot: 'Backdrop', overridesResolver: (props, styles) => { return styles.backdrop; }, })({ zIndex: -1, })	A backdrop component. This prop enables custom backdrop rendering. Deprecated－Use `slots.backdrop` instead. While this prop currently works, it will be removed in the next major version.
BackdropProps	object	-	Props applied to the `Backdrop` element. Deprecated－Use `slotProps.backdrop` instead.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
closeAfterTransition	bool	false	When set to true the Modal waits until a nested Transition is completed before closing.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
components	{ Backdrop?: elementType, Root?: elementType }	{}	The components used for each slot inside. Deprecated－Use the `slots` prop instead. This prop will be removed in v7. See Migrating from deprecated APIs for more details.
componentsProps	{ backdrop?: func \| object, root?: func \| object }	{}	The extra props for the slot components. You can override the existing props or add new ones. Deprecated－Use the `slotProps` prop instead. This prop will be removed in v7. See Migrating from deprecated APIs for more details.
container	HTML element \| func	-	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.
disableAutoFocus	bool	false	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.
disableEnforceFocus	bool	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.
disableEscapeKeyDown	bool	false	If `true`, hitting escape will not fire the `onClose` callback.
disablePortal	bool	false	The `children` will be under the DOM hierarchy of the parent component.
disableRestoreFocus	bool	false	If `true`, the modal will not restore focus to previously focused element once modal is hidden or unmounted.
disableScrollLock	bool	false	Disable the scroll lock behavior.
hideBackdrop	bool	false	If `true`, the backdrop is not rendered.
keepMounted	bool	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.
onBackdropClick	func	-	Callback fired when the backdrop is clicked. Deprecated－Use the `onClose` prop with the `reason` argument to handle the `backdropClick` events.
onClose	func	-	Callback fired when the component requests to be closed. The `reason` parameter can optionally be used to control the response to `onClose`. Signature:`function(event: object, reason: string) => void` `event` The event source of the callback. `reason` Can be: `"escapeKeyDown"`, `"backdropClick"`.
onTransitionEnter	func	-	A function called when a transition enters.
onTransitionExited	func	-	A function called when a transition has exited.
slotProps	{ backdrop?: func \| object, root?: func \| object }	{}	The props used for each slot inside the Modal.
slots	{ backdrop?: elementType, root?: elementType }	{}	The components used for each slot inside the Modal. Either a string to use a HTML element or a component.
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.

The ref is forwarded to the root element.

Slots

Slot name	Class name	Default component	Description
root	.MuiModal-root	`'div'`	The component that renders the root.
backdrop	.MuiModal-backdrop		The component that renders the backdrop.

CSS classes

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
.MuiModal-hidden	hidden	Class name applied to the root element if the `Modal` has exited.

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.

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.