Skip to content

ConfirmOptions

ConfirmOptions = object

Defined in: packages/ui/src/types.ts:1049

Options for the imperative confirmation dialog.

Passed to the function returned by useConfirm(), which resolves to true (confirmed) or false (cancelled). Also accepted by ActionButtonProps via the confirmation prop.

ConfirmDialogSlotProps for the underlying dialog slot.

optional cancelLabel: string

Defined in: packages/ui/src/types.ts:1057

Label for the cancel button. Defaults to “Cancel”.


optional confirmLabel: string

Defined in: packages/ui/src/types.ts:1055

Label for the confirm button. Defaults to “Confirm”.


optional description: string

Defined in: packages/ui/src/types.ts:1053

Optional description body.


title: string

Defined in: packages/ui/src/types.ts:1051

Dialog title text.


optional variant: "default" | "danger"

Defined in: packages/ui/src/types.ts:1059

Visual variant; “danger” uses warning colors for destructive actions.