external_multi_select_menu: External Data Source Multi-Select Menu Element

View source: R/block_elements.R

external_multi_select_menuR Documentation

External Data Source Multi-Select Menu Element

Description

This menu will load its options from an external data source, allowing for a dynamic list of options. Each time a select menu of this type is opened or the user starts typing in the typeahead field, we'll send a request to your specified URL. Your app should return an HTTP 200 OK response, along with an application/json post body with an object containing either an option_object list, or an option_groups list. A multi-select menu allows a user to select multiple items from a list of options. Just like regular select menus, multi-select menus also include type-ahead functionality, where a user can type a part or all of an option string to filter the list. 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 Input

Usage

external_multi_select_menu(
  placeholder,
  action_id,
  min_query_length = NULL,
  initial_options = NULL,
  confirm = NULL,
  max_selected_items = NULL
)

Arguments

placeholder

A plain_text only text_object that defines the placeholder text shown on the menu. Maximum length for the text in this field is 150 characters.

action_id

An identifier for the action triggered when a menu option is selected. 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.

min_query_length

When the typeahead field is used, a request will be sent on every character change. If you prefer fewer requests or more fully ideated queries, use the min_query_length attribute to tell Slack the fewest number of typed characters required before dispatch. The default value is 3.

initial_options

A list of link{option_object}s that exactly match one or more of the options within options or option_groups. These options will be selected when the menu initially loads.

confirm

A confirm_object that defines an optional confirmation dialog that appears before the multi-select choices are submitted.

max_selected_items

Specifies the maximum number of items that can be selected in the menu. Minimum number is 1.

See Also

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

Other Elements: button_element(), channels_multi_select_menu(), channels_select_menu(), checkbox_element(), conversations_multi_select_menu(), conversations_select_menu(), datepicker_element(), 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.