Skip to content
Edit this page
+

Modal

The Modal component lets you create dialogs, popovers, lightboxes, and other elements that force the user to take action before continuing.

DemosComponents APIHooks API
import { Modal } from '@mui/base/Modal';
// or
import { Modal } from '@mui/base';
Learn about the difference by reading this guide on minimizing bundle size.

Props of the native component are also available.

A single child content element.

Type:

element

If true, the component is shown.

Type:

bool

When set to true the Modal waits until a nested Transition is completed before closing.

Type:

bool

Default:

false

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.

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

Disable the scroll lock behavior.

Type:

bool

Default:

false

If true, the backdrop is not rendered.

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 backdrop is clicked.

Type:

func

Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

Type:

func

Signature:

function(event: object, reason: string) => void
  • event The event source of the callback.
  • reason Can be: "escapeKeyDown", "backdropClick".

A function called when a transition enters.

Type:

func

A function called when a transition has exited.

Type:

func

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.

See Slots API below for more details.

Type:

{ backdrop?: elementType, root?: elementType }

Default:

{}

The ref is forwarded to the root element.

To learn how to customize the slot, check out the Overriding component structure guide.

The component that renders the root.

Default: 'div'

Global class: .MuiModal-root

The component that renders the backdrop.

Default:

Global class: .MuiModal-backdrop


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

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

Class name applied to the root element if the Modal has exited.