ModalProps

Extends

• PropsWithChildren

Properties

Property	Type	Default value	Description
actions?	ReactNode	undefined	The buttons, in a row under the pane and outside it, where a thumb reaches them on a phone and the pane holds only what to read.
className?	string	undefined	An override on the pane, over the variant’s: its colours, its padding, its alignment.
classNames?	ModalClassNames	undefined	An override per part, over className for the pane and dialogClassName for the dialog.
dialogClassName?	string	undefined	An override on the dialog around the pane and the buttons: the backdrop’s utilities, such as "backdrop:bg-black/70" over the default backdrop:bg-black/40, and what the pane and the buttons share, such as their alignment.
freeCursor?	boolean	true	Frees the cursor while it is open, so its buttons take a click under a camera that captures the cursor, as Roblox frees the mouse for a Modal button and Unreal’s menus switch to UI input. The camera takes the cursor back once it closes. Off only for a modal with nothing to click, which a player then reads without losing the mouse-look.
onClose?	() => void	undefined	A click on the backdrop. Inside a Game, Escape opens the engine’s menu instead, which takes the key before any dialog. Left out, the modal closes only from inside.
open	boolean	undefined	Whether it is on the stack.
overline?	string	undefined	A small line above the heading that says where the player is, such as “Level 2 of 4”.
pause?	boolean	false	Holds the world still while it is open: the loop steps nothing and the day clock stops. Off unless asked, as a Roblox menu leaves the world running: a game with anyone else in it cannot stop for one player’s dialog.
title	string	undefined	The heading, and the dialog’s name for a screen reader.
variant?	ModalVariant	ModalVariant.Glass	The pane’s look.