ConfirmConfig

View as Markdown

Confirmation prompt shown before a destructive / significant Control action runs.

TypeScript
export interface

Properties

PropertyTypeDescriptionDefault
cancelLabelstringLabel for the cancel button'Cancel'
confirmLabelstringLabel for the confirm button'Confirm'
messageValueOrFunction<string, CTX>Body message of the confirmation prompt - static or a function of the context.
titleValueOrFunction<string, CTX>Title of the confirmation prompt - static or a function of the context.
tone'default' | 'danger'Visual tone of the prompt'default'

Property Details

cancelLabel

Label for the cancel button

TypeScript
cancelLabel?: string;
Default Value

'Cancel'

Property Value

string

confirmLabel

Label for the confirm button

TypeScript
confirmLabel?: string;
Default Value

'Confirm'

Property Value

string

message

Body message of the confirmation prompt - static or a function of the context.

TypeScript
message?: ValueOrFunction<string, CTX>;
Property Value

ValueOrFunction<string, CTX>

title

Title of the confirmation prompt - static or a function of the context.

TypeScript
title?: ValueOrFunction<string, CTX>;
Property Value

ValueOrFunction<string, CTX>

tone

Visual tone of the prompt

TypeScript
tone?: 'default' | 'danger';
Default Value

'default'

Property Value

'default' | 'danger'