Full Screen Modal

A full-screen modal with an app-stack transition animation. The background content pushes back and dims while the modal scales up from the center.

#

#

#

NameDefaultDescription
isOpen

boolean

Whether the modal is open.

onClose

() => void

Callback invoked to close the modal.

children

ReactNode

Modal content.

containerRef

RefObject<HTMLElement>

Ref to the app container element that receives the push-back effect. Defaults to `document.body.firstElementChild`.

closeOnEsctrueboolean

Close modal on escape key press.

On this page

  • Import
  • Example
  • Props