Checkboxes.md

@slack/web-api / Checkboxes

Interface: Checkboxes

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

Description

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

See

• Checkboxes element reference.
• This is an interactive component - see our guide to enabling interactivity.

Extends

• Actionable.Confirmable.Focusable

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

optional initial_options: Option[];

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

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.

---

options

options: Option[];

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

Description

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

---

type

type: "checkboxes";

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

Description

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

Overrides

Actionable.type