Class: Slack::BlockKit::Element::ExternalSelect

Inherits:
Object
  • Object
show all
Includes:
Composition::ConfirmationDialog::Confirmable
Defined in:
lib/slack/block_kit/element/external_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 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 options array, or an option_groups array.

api.slack.com/reference/messaging/block-elements#external-select

Constant Summary collapse

TYPE = 
'external_select'

Instance Method Summary collapse

Methods included from Composition::ConfirmationDialog::Confirmable

#confirmation_dialog, included

Constructor Details

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

Returns a new instance of ExternalSelect.

Yields:

  • (_self)

Yield Parameters:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/slack/block_kit/element/external_select.rb', line 26

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

  yield(self) if block_given?
end

Instance Method Details

#as_json ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/slack/block_kit/element/external_select.rb', line 43

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