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.dev.org.tw/material-ui/api/dialog/">Dialog</a></li>
<li><a href="https://mui.dev.org.tw/material-ui/api/drawer/">Drawer</a></li>
<li><a href="https://mui.dev.org.tw/material-ui/api/menu/">Menu</a></li>
<li><a href="https://mui.dev.org.tw/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.dev.org.tw/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&lt;any&gt; | 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 }

名稱	類型	預設值	描述
children*	React.ReactElement<any> \| undefined \| null	-	單一子內容元素。
open*	boolean	-	如果為 `true`，則顯示元件。
rootRef*	React.Ref<Element>	-
aria-hidden	React.AriaAttributes['aria-hidden']	-
closeAfterTransition	boolean	false	當設定為 true 時，Modal 會等到巢狀轉場效果完成後才關閉。
container	PortalProps['container']	-	一個 HTML 元素或返回一個元素的函式。`container` 將會附加 portal 子元素。您也可以提供一個回呼函式，該函式會在 React layout effect 中被呼叫。這讓您可以從 ref 設定 container，並使伺服器端渲染成為可能。預設情況下，它使用頂層文件物件的 body，所以大多數時候它只是 `document.body`。
disableEscapeKeyDown	boolean	false	如果為 `true`，按下 Escape 鍵將不會觸發 `onClose` 回呼函式。
disableScrollLock	boolean	false	停用滾動鎖定行為。
onClose	{ bivarianceHack(event: {}, reason: 'backdropClick' \| 'escapeKeyDown'): void }['bivarianceHack']	-	當元件請求關閉時觸發的回呼函式。`reason` 參數可以選擇性地用於控制對 `onClose` 的回應。
onKeyDown	React.KeyboardEventHandler	-
onTransitionEnter	() => void	-	當轉場效果進入時呼叫的函式。
onTransitionExited	() => void	-	當轉場效果已退出時呼叫的函式。

名稱	類型	描述
exited	boolean	如果為 `true`，則退出轉場效果已完成（用於卸載元件）。
getBackdropProps	<TOther extends EventHandlers = {}>(externalProps?: TOther) => UseModalBackdropSlotProps<TOther>	backdrop slot props 的解析器。
getRootProps	<TOther extends EventHandlers = {}>(externalProps?: TOther) => UseModalRootSlotProps<TOther>	root slot props 的解析器。
getTransitionProps	<TOther extends EventHandlers = {}>(externalProps?: TOther) => { onEnter: () => void; onExited: () => void }	轉場效果相關 props 的解析器。
hasTransition	boolean	如果為 `true`，則元件的子元素是轉場效果元件。
isTopModal	() => boolean	如果為 `true`，則 modal 是最頂層的 modal。
portalRef	React.RefCallback<Element> \| null	元件 portal DOM 元素的 ref。
rootRef	React.RefCallback<Element> \| null	元件 root DOM 元素的 ref。

Modal 視窗

useModal API

匯入

參數

回傳值