Skip to main content

Interface: Checkboxes

Description​

Allows users to choose multiple items from a list of options.

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_options?​

optional initial_options: Option[];

Description​

An array of Option objects that exactly matches one or more of the options within options. These options will be selected when the checkbox group initially loads.

Defined in​

block-kit/block-elements.ts:80

options​

options: Option[];

Description​

An array of Option objects. A maximum of 10 options are allowed.

Defined in​

block-kit/block-elements.ts:84

type​

type: "checkboxes";

Description​

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

Overrides​

Actionable.type

Defined in​

block-kit/block-elements.ts:75