ExternalSelect.md

@slack/web-api / ExternalSelect

Interface: ExternalSelect

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:364

Description

This select menu will load its options from an external data source, allowing for a dynamic list of options.

See

• Select menu of external data source reference.
• This is an interactive component - see our guide to enabling interactivity.

Extends

• Actionable.Confirmable.Focusable.Placeholdable

Properties

action_id?

optional action_id: string;

Defined in: node_modules/@slack/types/dist/block-kit/extensions.d.ts:12

@description: An identifier for this action. You can use this when you receive an interaction payload to identify the source of the action. Should be unique among all other action_ids in the containing block. Maximum length for this field is 255 characters.

Inherited from

Actionable.action_id

---

confirm?

optional confirm: ConfirmationDialog;

Defined in: node_modules/@slack/types/dist/block-kit/extensions.d.ts:21

Description

A Confirm object that defines an optional confirmation dialog after the element is interacted with.

Inherited from

Confirmable.confirm

---

focus_on_load?

optional focus_on_load: boolean;

Defined in: node_modules/@slack/types/dist/block-kit/extensions.d.ts:36

Description

Indicates whether the element will be set to auto focus within the `view` object. Only one element can be set to true. Defaults to false.

Inherited from

Focusable.focus_on_load

---

initial_option?

optional initial_option: PlainTextOption;

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:372

Description

A single option to be selected when the menu initially loads.

---

min_query_length?

optional min_query_length: number;

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:378

Description

When the typeahead field is used, a request will be sent on every character change. If you prefer fewer requests or more fully ideated queries, use the min_query_length attribute to tell Slack the fewest number of typed characters required before dispatch. The default value is 3.

---

placeholder?

optional placeholder: PlainTextElement;

Defined in: node_modules/@slack/types/dist/block-kit/extensions.d.ts:49

Description

A PlainTextElement object that defines the placeholder text shown on the element. Maximum length for the text field in this object is 150 characters.

Inherited from

Placeholdable.placeholder

---

type

type: "external_select";

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:368

Description

The type of element. In this case type is always external_select.

Overrides

Actionable.type