Skip to content
Edit this page

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:

Import

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

Props

Props of the native component are also available.

A single child content element.

Type:

element

If true, the component is shown.

Type:

bool

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType

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 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", "closeClick".

The props used for each slot inside.

Type:

{ backdrop?: func | object, root?: func | object }

Default:

{}

The components used for each slot inside.

See Slots API below for more details.

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
The ref is forwarded to the root element.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


Class name applied to the root element.

Class name applied to the backdrop element.

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

Slots

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: 'div'

Global class: .MuiModal-backdrop

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