Modal API

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

Import

import Modal from '@mui/material/Modal';
// 或
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.

名称	类型	默认值	描述
children^*	element		A single child content element. ⚠️ Needs to be able to hold a ref.
open^*	bool	false	Control the popup` open state.
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.
BackdropProps	object		Props applied to the `Backdrop` element.
classes	object		Override or extend the styles applied to the component. See CSS 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	{ Root?: elementType }	{}	The components used for each slot inside the Modal. Either a string to use a HTML element or a component.
componentsProps	object	{}	The props used for each slot inside the Modal.
container	HTML element \| func		A 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.
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 inside 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.
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.
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"`.
sx	func \| object		The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

ref 则会被传递到根元素中。

CSS

Rule name	Global class	描述
root	.MuiModal-root	Styles applied to the root element.
hidden	.MuiModal-hidden	Styles 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.

Demos

Modal