Confirm Dialog Config

Confirmation config is used by action confirm. This page documents the schema-level FluiKitConfirmConfig/FluiKitConfirmStepConfig shape, not the FluiKitConfirmDialog component's own props (open, tone, onConfirm, onCancel, etc.) — see Component Props for the rendered dialog component.

Types

type FluiKitConfirmStepConfig = {
  title?: string;
  description?: string;
  confirmLabel?: string;
  cancelLabel?: string;
  icon?: string;
};

type FluiKitConfirmConfig = FluiKitConfirmStepConfig & {
  secondConfirm?: boolean | FluiKitConfirmStepConfig;
};

Properties

Property	Type	Required	Description
`title`	`string`	No	Dialog title.
`description`	`string`	No	Dialog body text.
`confirmLabel`	`string`	No	Confirm button text.
`cancelLabel`	`string`	No	Cancel button text.
`icon`	`string`	No	Iconify icon.
`secondConfirm`	`boolean \| FluiKitConfirmStepConfig`	No	Optional second confirmation step.

Example

delete: {
  enabled: true,
  variant: "danger",
  confirm: {
    title: "Delete user?",
    description: "This action cannot be undone.",
    confirmLabel: "Continue",
    secondConfirm: {
      title: "Confirm permanent delete",
      confirmLabel: "Delete permanently"
    }
  }
}