Modal
The Modal component lets you create dialogs, popovers, lightboxes, and other elements that force the user to take action before continuing.
Modal API
Import
import { Modal } from '@mui/base/Modal';
// or
import { Modal } from '@mui/base';Props of the native component are also available.
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.
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.
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
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
function(event: object, reason: string) => voideventThe event source of the callback.reasonCan be:"escapeKeyDown","backdropClick".
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:{}
ref is forwarded to the root element.To learn how to customize the slot, check out the Overriding component structure guide.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.