Skip to main content

@slack/types / Dialog

Interface: Dialog

Defined in: dialog.ts:5

Reusable shapes for argument values

Deprecated​

Dialogs are a deprecated surface in Slack. For more details on how to upgrade, check out our Upgrading outmoded dialogs to modals guide. This will be removed in the next major version.

Properties​

callback_id​

callback_id: string;

Defined in: dialog.ts:7

elements​

elements: object[];

Defined in: dialog.ts:8

data_source?​

optional data_source?: "users" | "channels" | "conversations" | "external";

hint?​

optional hint?: string;

label​

label: string;

max_length?​

optional max_length?: number;

min_length?​

optional min_length?: number;

min_query_length?​

optional min_query_length?: number;

name​

name: string;

option_groups?​

optional option_groups?: object[];

optional?​

optional optional?: boolean;

options?​

optional options?: SelectOption[];

placeholder?​

optional placeholder?: string;

selected_options?​

optional selected_options?: SelectOption[];

subtype?​

optional subtype?: "number" | "url" | "email" | "tel";

type​

type: "text" | "textarea" | "select";

value?​

optional value?: string;

notify_on_cancel?​

optional notify_on_cancel?: boolean;

Defined in: dialog.ts:31

state?​

optional state?: string;

Defined in: dialog.ts:32

submit_label?​

optional submit_label?: string;

Defined in: dialog.ts:30

title​

title: string;

Defined in: dialog.ts:6