conversations_multi_select_menu: Conversations List Multi-Select Menu Element

View source: R/block_elements.R

conversations_multi_select_menuR Documentation

Conversations List Multi-Select Menu Element

Description

This multi-select menu will populate its options with a list of public and private channels, DMs, and MPIMs visible to the current user in the active workspace. 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

conversations_multi_select_menu(
  placeholder,
  action_id,
  initial_conversations = NULL,
  default_to_current_conversation = NULL,
  confirm = NULL,
  max_selected_items = NULL,
  filter = 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.

initial_conversations

A list of one or more IDs of any valid conversations to be pre-selected when the menu loads. If default_to_current_conversation is also supplied, initial_conversations will be ignored.

default_to_current_conversation

Pre-populates the select menu with the conversation that the user was viewing when they opened the modal, if available. Default is false.

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.

filter

A filter_object that reduces the list of available conversations using the specified criteria.

See Also

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

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