Skip to main content

Interface: Overflow

Defined in: block-kit/block-elements.ts:518

Description​

Allows users to press a button to view a list of options. Unlike the select menu, there is no typeahead field, and the button always appears with an ellipsis ('…') rather than customizable text. As such, it is usually used if you want a more compact layout than a select menu, or to supply a list of less visually important actions after a row of buttons. You can also specify simple URL links as overflow menu options, instead of actions.

See​

Extends​

Properties​

action_id?​

optional action_id: string;

Defined in: block-kit/extensions.ts:15

@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: block-kit/extensions.ts:25

Description​

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

Inherited from​

Confirmable.confirm

options​

options: PlainTextOption[];

Defined in: block-kit/block-elements.ts:527

Description​

An array of up to 5 PlainTextOption to display in the menu.

type​

type: "overflow";

Defined in: block-kit/block-elements.ts:522

Description​

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

Overrides​

Actionable.type