checkbox_element: Checkbox Group

In samterfa/slackme: Create Slack Apps

Checkbox Group

Description

A checkbox group that allows a user to choose multiple items from a list of possible options. Checkboxes are only supported in the following app surfaces: Home tabs, Modals, and Messages. To use interactive components, you will need to make some changes to prepare your app. Read our guide to enabling interactivity. Works with block types: Section Actions Input

Usage

checkbox_element(action_id, options, initial_options = NULL, confirm = NULL)

Arguments

action_id	An identifier for the action triggered when the checkbox group is changed. 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.
options	A list of option_objects. A maximum of 10 options are allowed.
initial_options	A list 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.
confirm	A confirm_object that defines an optional confirmation dialog that appears after clicking one of the checkboxes in this element.

See Also

https://api.slack.com/reference/block-kit/block-elements#checkboxes

Other Elements: button_element(), channels_multi_select_menu(), channels_select_menu(), conversations_multi_select_menu(), conversations_select_menu(), datepicker_element(), external_multi_select_menu(), external_select_menu(), image_element(), overflow_menu_element(), plain_text_input_element(), radio_button_group_element(), static_multi_select_menu(), static_select_menu(), timepicker_element(), users_multi_select_menu(), users_select_menu()

samterfa/slackme documentation built on April 11, 2022, 3:29 a.m.