Class: Slack::BlockKit::Element::MultiUsersSelect

Inherits:
Object
  • Object
show all
Includes:
Composition::ConfirmationDialog::Confirmable
Defined in:
lib/slack/block_kit/element/multi_users_select.rb

Overview

A select menu, just as with a standard HTML <select> tag, creates a drop down menu with a list of options for a user to choose. The select menu also includes type-ahead functionality, where a user can type a part or all of an option string to filter the list.

This multi-select menu will populate its options with a list of Slack users visible to the current user in the active workspace.

api.slack.com/reference/block-kit/block-elements#users_multi_select

Constant Summary collapse

TYPE = 
'multi_users_select'

Instance Method Summary collapse

Methods included from Composition::ConfirmationDialog::Confirmable

#confirmation_dialog, included

Constructor Details

#initialize(placeholder:, action_id:, initial: nil, emoji: nil, max_selected_items: nil, focus_on_load: nil) {|_self| ... } ⇒ MultiUsersSelect

Returns a new instance of MultiUsersSelect.

Yields:

  • (_self)

Yield Parameters:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/slack/block_kit/element/multi_users_select.rb', line 20

def initialize(
  placeholder:,
  action_id:,
  initial: nil,
  emoji: nil,
  max_selected_items: nil,
  focus_on_load: nil
)
  @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
  @action_id = action_id
  @initial_users = initial
  @max_selected_items = max_selected_items
  @focus_on_load = focus_on_load

  yield(self) if block_given?
end

Instance Method Details

#as_json ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/slack/block_kit/element/multi_users_select.rb', line 37

def as_json(*)
  {
    type: TYPE,
    placeholder: @placeholder.as_json,
    action_id: @action_id,
    initial_users: @initial_users,
    focus_on_load: @focus_on_load,
    confirm: confirm&.as_json,
    max_selected_items: @max_selected_items
  }.compact
end