Skip to main content

Interface: Confirm

Deprecated

Confirm aliased to ConfirmationDialog in order to make the construct clearer and line up terminology with api.slack.com.

Description

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

See

Confirmation dialog object reference.

Extended by

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.

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.

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.

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.

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.

Defined in

block-kit/composition-objects.ts:24