Class: Slack::BlockKit::Element::UsersSelect

Inherits:
Object
  • Object
show all
Includes:
Composition::ConfirmationDialog::Confirmable
Defined in:
lib/slack/block_kit/element/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 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/messaging/block-elements#users-select

Constant Summary collapse

TYPE = 
'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, focus_on_load: nil) {|_self| ... } ⇒ UsersSelect

Returns a new instance of UsersSelect.

Yields:

  • (_self)

Yield Parameters:



20
21
22
23
24
25
26
27
 
# File 'lib/slack/block_kit/element/users_select.rb', line 20

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

  yield(self) if block_given?
end

Instance Method Details

#as_json ⇒ Object 



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/slack/block_kit/element/users_select.rb', line 29

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