Skip to main content

Interface: ChannelsSelect

Description

This select menu will populate its options with a list of public channels visible to the current user in the active workspace.

See

Extends

Properties

action_id?

optional action_id: string;

@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

Defined in

block-kit/extensions.ts:15


confirm?

optional confirm: ConfirmationDialog;

Description

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

Inherited from

Confirmable.confirm

Defined in

block-kit/extensions.ts:25


focus_on_load?

optional focus_on_load: boolean;

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

Defined in

block-kit/extensions.ts:42


initial_channel?

optional initial_channel: string;

Description

The ID of any valid public channel to be pre-selected when the menu loads.

Defined in

block-kit/block-elements.ts:407


placeholder?

optional placeholder: PlainTextElement;

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

Defined in

block-kit/extensions.ts:57


response_url_enabled?

optional response_url_enabled: boolean;

Description

When set to true, the view_submission payload from the menu's parent view will contain a response_url. This response_url can be used for message responses. The target conversation for the message will be determined by the value of this select menu.

Inherited from

URLRespondable.response_url_enabled

Defined in

block-kit/extensions.ts:67


type

type: "channels_select";

Description

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

Overrides

Actionable.type

Defined in

block-kit/block-elements.ts:403