Props

A backdrop component. This prop enables custom backdrop rendering.

A single child content element.

Override or extend the styles applied to the component.

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.

The components used for each slot inside.

This prop is an alias for the slots prop. It's recommended to use the slots prop instead.

The extra props for the slot components. You can override the existing props or add new ones.

This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.

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.

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 or unmounted.

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 component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

A function called when a transition enters.

A function called when a transition has exited.

If true, the component is shown.

The props used for each slot inside the Modal.

The components used for each slot inside the Modal. Either a string to use a HTML element or a component.

The system prop that allows defining system overrides as well as additional CSS styles.

Props applied to the Backdrop element.

Callback fired when the backdrop is clicked.