components/dialog
@fungi.computer/caps / components/dialog
components/dialog
Section titled “components/dialog”Type Aliases
Section titled “Type Aliases”DialogChangeDetails
Section titled “DialogChangeDetails”DialogChangeDetails =
BaseDialog.Root.ChangeEventDetails
Details supplied to a Dialog open-change callback.
DialogChangeReason
Section titled “DialogChangeReason”DialogChangeReason =
BaseDialog.Root.ChangeEventReason
Supported DialogChangeReason values.
DialogInteractionOwner
Section titled “DialogInteractionOwner”DialogInteractionOwner =
"host"|"local"
Supported DialogInteractionOwner values.
DialogProps
Section titled “DialogProps”DialogProps<
Payload> > =BaseDialog.Root.Props<Payload> > &object
Props accepted by Dialog.
Type Declaration
Section titled “Type Declaration”interactionOwner?
Section titled “interactionOwner?”
optionalinteractionOwner?:DialogInteractionOwner
Type Parameters
Section titled “Type Parameters”Payload
Section titled “Payload”Payload = unknown
DialogContentProps
Section titled “DialogContentProps”DialogContentProps =
BaseDialog.Popup.Props&Pick<BaseDialog.Portal.Props,"container"|"keepMounted">>
Props accepted by DialogContent.
Variables
Section titled “Variables”DialogTrigger
Section titled “DialogTrigger”
constDialogTrigger:ForwardRefExoticComponent<Omit<Props<unknown>>,"ref"> > &RefAttributes<HTMLButtonElement>>>>
The trigger control for a Dialog.
DialogPortal
Section titled “DialogPortal”
constDialogPortal:ForwardRefExoticComponent<Omit<DialogPortalProps,"ref"> > &RefAttributes<HTMLDivElement>> >> =BaseDialog.Portal
The native portal, including caller-selected container and mount lifetime.
DialogBackdrop
Section titled “DialogBackdrop”
constDialogBackdrop:ForwardRefExoticComponent<Omit<DialogBackdropProps,"ref"> > &RefAttributes<HTMLDivElement>>>>
The styled backdrop for a composed Dialog.
DialogPopup
Section titled “DialogPopup”
constDialogPopup:ForwardRefExoticComponent<Omit<DialogPopupProps,"ref"> > &RefAttributes<HTMLDivElement>>>>
The styled popup with Base UI composition and caller-controlled focus targets.
DialogContent
Section titled “DialogContent”
constDialogContent:ForwardRefExoticComponent<Omit<DialogContentProps,"ref"> > &RefAttributes<HTMLDivElement>>>>
The default portal, backdrop and popup composition for a Dialog. Keeps child state across closes. Like Base UI, only full modal mode has a backdrop.
DialogTitle
Section titled “DialogTitle”
constDialogTitle:ForwardRefExoticComponent<Omit<DialogTitleProps,"ref"> > &RefAttributes<HTMLHeadingElement>>>>
The accessible title for a Dialog.
DialogDescription
Section titled “DialogDescription”
constDialogDescription:ForwardRefExoticComponent<Omit<DialogDescriptionProps,"ref"> > &RefAttributes<HTMLParagraphElement>>>>
The accessible description for a Dialog.
DialogClose
Section titled “DialogClose”
constDialogClose:ForwardRefExoticComponent<Omit<DialogCloseProps,"ref"> > &RefAttributes<HTMLButtonElement>>>>
A control that requests a Dialog to close.
Functions
Section titled “Functions”Dialog()
Section titled “Dialog()”Dialog<
Payload>>(__namedParameters):Element
A dialog controller with explicit controlled or uncontrolled open state.
Type Parameters
Section titled “Type Parameters”Payload
Section titled “Payload”Payload = unknown
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”DialogProps<Payload>
Returns
Section titled “Returns”Element
DialogFooter()
Section titled “DialogFooter()”DialogFooter(
__namedParameters):Element
A footer layout for caller-provided Dialog actions.
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”HTMLAttributes<HTMLDivElement>
Returns
Section titled “Returns”Element
DialogHeader()
Section titled “DialogHeader()”DialogHeader(
__namedParameters):Element
A header layout for caller-provided Dialog content.
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”HTMLAttributes<HTMLDivElement>
Returns
Section titled “Returns”Element