Skip to main content

Interface: ConfirmationDialog

Description

Defines a dialog that adds a confirmation step to interactive elements.

See

Confirmation dialog object reference.

Extends

Properties

confirm?

optional confirm: PlainTextElement;

Description

A PlainTextElement text object to define the text of the button that confirms the action. Maximum length for the text in this field is 30 characters.

Inherited from

Confirm.confirm

Defined in

block-kit/composition-objects.ts:34


deny?

optional deny: PlainTextElement;

Description

A PlainTextElement text object to define the text of the button that cancels the action. Maximum length for the text in this field is 30 characters.

Inherited from

Confirm.deny

Defined in

block-kit/composition-objects.ts:39


style?

optional style: ColorScheme;

Description

Defines the color scheme applied to the confirm button. A value of danger will display the button with a red background on desktop, or red text on mobile. A value of primary will display the button with a green background on desktop, or blue text on mobile. If this field is not provided, the default value will be primary.

Inherited from

Confirm.style

Defined in

block-kit/composition-objects.ts:45


text

text: PlainTextElement | MrkdwnElement;

Description

A PlainTextElement text object that defines the explanatory text that appears in the confirm dialog. Maximum length for the text in this field is 300 characters.

Inherited from

Confirm.text

Defined in

block-kit/composition-objects.ts:29


title?

optional title: PlainTextElement;

Description

A PlainTextElement text object that defines the dialog's title. Maximum length for this field is 100 characters.

Inherited from

Confirm.title

Defined in

block-kit/composition-objects.ts:24