Props

A backdrop component. This prop enables custom backdrop rendering.

Props applied to the Backdrop element.

A single child content element.

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

A HTML element, component instance, or function that returns either. 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.

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, clicking the backdrop will not fire onClose.

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 onClose.

Disable the portal behavior. The children stay within it's parent DOM hierarchy.

If true, the modal will not restore focus to previously focused element once modal is hidden.

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

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

Callback fired when the escape key is pressed, disableEscapeKeyDown is false and the modal is in focus.

Callback fired once the children has been mounted into the container. It signals that the open={true} prop took effect.

This prop will be removed in v5, the ref can be used instead.

If true, the modal is open.