Skip to main content

@slack/web-api / ConfirmationDialog

Interface: ConfirmationDialog

Defined in: packages/types/dist/block-kit/composition-objects.d.ts:46

Description​

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

See​

Confirmation dialog object reference.

Extends​

Properties​

confirm?​

optional confirm?: PlainTextElement;

Defined in: packages/types/dist/block-kit/composition-objects.d.ts:29

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

deny?​

optional deny?: PlainTextElement;

Defined in: packages/types/dist/block-kit/composition-objects.d.ts:34

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

style?​

optional style?: ColorScheme;

Defined in: packages/types/dist/block-kit/composition-objects.d.ts:40

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

text​

text: 
  | PlainTextElement
  | MrkdwnElement;

Defined in: packages/types/dist/block-kit/composition-objects.d.ts:24

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

title?​

optional title?: PlainTextElement;

Defined in: packages/types/dist/block-kit/composition-objects.d.ts:19

Description​

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

Inherited from​

Confirm.title