Class name applied to {{nodeName}} if {{conditions}}.

Modal is a lower-level construct that is leveraged by the following components:
<ul>
<li><a href="https://mui.com/material-ui/api/dialog/">Dialog</a></li>
<li><a href="https://mui.com/material-ui/api/drawer/">Drawer</a></li>
<li><a href="https://mui.com/material-ui/api/menu/">Menu</a></li>
<li><a href="https://mui.com/material-ui/api/popover/">Popover</a></li>
</ul>
If you are creating a modal dialog, you probably want to use the <a href="https://mui.com/material-ui/api/dialog/">Dialog</a> component
rather than directly using Modal.
This component shares many concepts with <a href="https://react-bootstrap.github.io/react-overlays/#modals">react-overlays</a>.

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

An HTML element or function that returns one. The <code>container</code> 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&#39;s simply <code>document.body</code> most of the time.

If <code>true</code>, 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 <code>disableAutoFocus</code> prop. Generally this should never be set to <code>true</code> as it makes the modal less accessible to assistive technologies, like screen readers.

If <code>true</code>, the modal will not prevent focus from leaving the modal while open. Generally this should never be set to <code>true</code> as it makes the modal less accessible to assistive technologies, like screen readers.

If <code>true</code>, hitting escape will not fire the <code>onClose</code> callback.

The <code>children</code> will be under the DOM hierarchy of the parent component.

If <code>true</code>, the modal will not restore focus to previously focused element once modal is hidden or unmounted.

If <code>true</code>, 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 <code>reason</code> parameter can optionally be used to control the response to <code>onClose</code>.

A function called when a transition enters.

A function called when a transition has exited.

If <code>true</code>, 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.

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

Modal

custom

bool

union

func

{ backdrop?: func &#124;&nbsp;object, root?: func &#124;&nbsp;object }

shape

{ backdrop?: elementType, root?: elementType }

root

backdrop

If <code>true</code>, the exiting transition finished (to be used for unmounting the component).

Resolver for the backdrop slot&#39;s props.

Resolver for the transition related props.

If <code>true</code>, the component&#39;s child is transition component.

If <code>true</code>, the modal is the top most one.

A ref to the component&#39;s portal DOM element.

A ref to the component&#39;s root DOM element.

useModal

React.AriaAttributes[&#39;aria-hidden&#39;]

React.ReactElement | undefined | null

boolean

PortalProps[&#39;container&#39;]

{
  bivarianceHack(event: {}, reason: &#39;backdropClick&#39; | &#39;escapeKeyDown&#39;): void
}[&#39;bivarianceHack&#39;]

React.KeyboardEventHandler

() =&gt; void

React.Ref&lt;Element&gt;

&lt;TOther extends EventHandlers = {}&gt;(externalProps?: TOther) =&gt; UseModalBackdropSlotProps&lt;TOther&gt;

&lt;TOther extends EventHandlers = {}&gt;(externalProps?: TOther) =&gt; UseModalRootSlotProps&lt;TOther&gt;

&lt;TOther extends EventHandlers = {}&gt;(externalProps?: TOther) =&gt; { onEnter: () =&gt; void; onExited: () =&gt; void }

Name	Type	Default	Description
children*	React.ReactElement \| undefined \| null	-	A single child content element.
open*	boolean	-	If `true`, the component is shown.
rootRef*	React.Ref<Element>	-
aria-hidden	React.AriaAttributes['aria-hidden']	-
closeAfterTransition	boolean	false	When set to true the Modal waits until a nested Transition is completed before closing.
container	PortalProps['container']	-	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.
disableEscapeKeyDown	boolean	false	If `true`, hitting escape will not fire the `onClose` callback.
disableScrollLock	boolean	false	Disable the scroll lock behavior.
onClose	{ bivarianceHack(event: {}, reason: 'backdropClick' \| 'escapeKeyDown'): void }['bivarianceHack']	-	Callback fired when the component requests to be closed. The `reason` parameter can optionally be used to control the response to `onClose`.
onKeyDown	React.KeyboardEventHandler	-
onTransitionEnter	() => void	-	A function called when a transition enters.
onTransitionExited	() => void	-	A function called when a transition has exited.

Name	Type	Description
exited	boolean	If `true`, the exiting transition finished (to be used for unmounting the component).
getBackdropProps	<TOther extends EventHandlers = {}>(externalProps?: TOther) => UseModalBackdropSlotProps<TOther>	Resolver for the backdrop slot's props.
getRootProps	<TOther extends EventHandlers = {}>(externalProps?: TOther) => UseModalRootSlotProps<TOther>	Resolver for the root slot's props.
getTransitionProps	<TOther extends EventHandlers = {}>(externalProps?: TOther) => { onEnter: () => void; onExited: () => void }	Resolver for the transition related props.
hasTransition	boolean	If `true`, the component's child is transition component.
isTopModal	() => boolean	If `true`, the modal is the top most one.
portalRef	React.RefCallback<Element> \| null	A ref to the component's portal DOM element.
rootRef	React.RefCallback<Element> \| null	A ref to the component's root DOM element.

Modal

useModal API

Import

Parameters

Return value