OptionalautoOptionalautoQuery selector for the element to focus on show.
OptionalcancelThe cancel option (Esc key), matched against the options by identity. Gets special styling.
OptionalcontextOptionaldefaultThe option that is the default (Enter key), matched against the options by identity
(a string matches an option's id/string form, an InputOption matches by reference).
OptionaldescriptionDisplay text information for the user to make a decision.
OptionaldisableIf true the window will not be automatically destroyed when closed.
OptionaliconAn icon beside the description, in place of the one type implies. A string is an icon
key.
OptionalinitialA default position for the window. The default is center at %50, %50.
OptionalinitialA value the window can use to display.
OptionalisIf true show a backdrop.
OptionalonOptionalonOptionalonOptionalonAllow for tracking of key down events.
OptionalonCall when an option is selected. option is the selected option's IDENTITY (its id if provided,
else the string form, else the InputOption object).
OptionalonOptionalonOptionalonCall when an option is selected. If false is returned, the dialog will not close. INotifier is not
provided but can be supplied via the textFieldProps helperText property. option is the selected
option's identity (see onOption).
OptionalopenOptionaloptionsThe dialog buttons: plain identity strings or rich InputOptions (mixable).
OptionalprewarmMount the window hidden (do not reveal it) so a later real open is an instant reuse. Implies disableAutoDestroy (a prewarmed window must be kept alive). Use at idle to move the heavy first-mount cost off the user's open. A no-op if an instance already exists.
OptionalrestoreWhether closing returns the keyboard to whatever held it when the window opened.
false leaves focus alone — for a window whose OUTCOME moves the keyboard itself (Insert
Function seeds =NAME( and puts the user in the cell's editor). The restore is a queued frame,
so it lands after the new owner has taken focus and quietly takes it away again.
A thunk is read as the window exits, which is what a window whose answer depends on how it was dismissed needs — cancel restores, an insert that starts an edit does not. A boolean would have to be in state, and there is no guaranteed render between the option being taken and the exit transition starting.
OptionalrevealMonotonic token bumped by the host each time a keep-alive window should re-show. An effect
re-reveals the window whenever this changes. Prop-based (not imperative on the DOM element,
whose identity is fragile across re-renders/StrictMode) and survives updateModal (which only
strips open). Ignored on first mount.
OptionalslotThe extra props for the slot components. You can override the existing props or add new ones.
OptionalslotsThe components used for each slot inside.
OptionalstartMount hidden and suppress the initial auto-reveal (used for prewarming — mounting + positioning a
keep-alive window ahead of its first real open). The window stays hidden until revealToken
is bumped (or this flips false). Needed because mui-modal-provider's SHOW force-sets open:true,
so open alone can't keep a prewarmed window hidden.
OptionalsuspendTemporarily SUSPEND the modality of an isModal window: the backdrop is not rendered, so the
application behind stays clickable, while the window itself remains open, visible and draggable.
The focus trap is already soft (it only enforces while the window has focus), so focus may move
to the application and back freely.
OptionaltitleThe title of the options panel
OptionalTransitionOptionaltypeWhat kind of message this is. info, warning, error and success show the matching icon
beside the description; default (or omitted) shows none.
Query selector for the element to focus on show.