Class: Slack::BlockKit::Layout::Section

Inherits:
Object
  • Object
show all
Includes:
MultiSelectElements
Defined in:
lib/slack/block_kit/layout/section.rb,
lib/slack/block_kit/layout/section/multi_select_elements.rb

Overview

A section is one of the most flexible blocks available - it can be used as a simple text block, in combination with text fields, or side-by-side with any of the available block elements.

api.slack.com/reference/messaging/blocks#section rubocop:disable Metrics/ClassLength

Defined Under Namespace

Modules: MultiSelectElements

Constant Summary collapse

TYPE = 
'section'

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MultiSelectElements

#multi_channels_select, #multi_conversations_select, #multi_external_select, #multi_static_select, #multi_users_select

Constructor Details

#initialize(block_id: nil) {|_self| ... } ⇒ Section

Returns a new instance of Section.

Yields:

  • (_self)

Yield Parameters:



22
23
24
25
26
27
28
 
# File 'lib/slack/block_kit/layout/section.rb', line 22

def initialize(block_id: nil)
  @block_id = block_id
  @fields = nil
  @accessory = nil

  yield(self) if block_given?
end

Instance Attribute Details

#accessory ⇒ Object

Returns the value of attribute accessory.



20
21
22
 
# File 'lib/slack/block_kit/layout/section.rb', line 20

def accessory
  @accessory
end

#fields ⇒ Object

Returns the value of attribute fields.



20
21
22
 
# File 'lib/slack/block_kit/layout/section.rb', line 20

def fields
  @fields
end

#text ⇒ Object

Returns the value of attribute text.



20
21
22
 
# File 'lib/slack/block_kit/layout/section.rb', line 20

def text
  @text
end

Instance Method Details

#accessorise(element) ⇒ Object 



163
164
165
166
167
 
# File 'lib/slack/block_kit/layout/section.rb', line 163

def accessorise(element)
  @accessory = element

  self
end

#as_json ⇒ Object 



169
170
171
172
173
174
175
176
177
 
# File 'lib/slack/block_kit/layout/section.rb', line 169

def as_json(*)
  {
    type: TYPE,
    text: @text.as_json,
    block_id: @block_id,
    fields: @fields&.map(&:as_json),
    accessory: @accessory&.as_json
  }.compact
end

#button(text:, action_id:, style: nil, emoji: nil, url: nil, value: nil) {|element| ... } ⇒ Object

Yields:

  • (element) 


58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/slack/block_kit/layout/section.rb', line 58

def button(text:, action_id:, style: nil, emoji: nil, url: nil, value: nil)
  element = Element::Button.new(
    text: text,
    action_id: action_id,
    style: style,
    emoji: emoji,
    url: url,
    value: value
  )

  yield(element) if block_given?

  accessorise(element)
end

#channel_select(placeholder:, action_id:, initial: nil, emoji: nil) {|element| ... } ⇒ Object

Yields:

  • (element) 


73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/slack/block_kit/layout/section.rb', line 73

def channel_select(placeholder:, action_id:, initial: nil, emoji: nil)
  element = Element::ChannelsSelect.new(
    placeholder: placeholder,
    action_id: action_id,
    initial: initial,
    emoji: emoji
  )

  yield(element) if block_given?

  accessorise(element)
end

#conversation_select(placeholder:, action_id:, initial: nil, emoji: nil) {|element| ... } ⇒ Object

Yields:

  • (element) 


86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/slack/block_kit/layout/section.rb', line 86

def conversation_select(placeholder:, action_id:, initial: nil, emoji: nil)
  element = Element::ConversationsSelect.new(
    placeholder: placeholder,
    action_id: action_id,
    initial: initial,
    emoji: emoji
  )

  yield(element) if block_given?

  accessorise(element)
end

#date_picker(action_id:, placeholder: nil, initial: nil, emoji: nil) {|element| ... } ⇒ Object

Yields:

  • (element) 


99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/slack/block_kit/layout/section.rb', line 99

def date_picker(action_id:, placeholder: nil, initial: nil, emoji: nil)
  element = Element::DatePicker.new(
    placeholder: placeholder,
    action_id: action_id,
    initial: initial,
    emoji: emoji
  )

  yield(element) if block_given?

  accessorise(element)
end

#external_select(placeholder:, action_id:, initial: nil, min_query_length: nil, emoji: nil) {|element| ... } ⇒ Object

Yields:

  • (element) 


112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/slack/block_kit/layout/section.rb', line 112

def external_select(placeholder:, action_id:, initial: nil, min_query_length: nil, emoji: nil)
  element = Element::ExternalSelect.new(
    placeholder: placeholder,
    action_id: action_id,
    initial: initial,
    min_query_length: min_query_length,
    emoji: emoji
  )

  yield(element) if block_given?

  accessorise(element)
end

#image(url:, alt_text:) ⇒ Object 



159
160
161
 
# File 'lib/slack/block_kit/layout/section.rb', line 159

def image(url:, alt_text:)
  accessorise(Element::Image.new(image_url: url, alt_text: alt_text))
end

#mrkdwn(text:, verbatim: nil) ⇒ Object 



52
53
54
55
56
 
# File 'lib/slack/block_kit/layout/section.rb', line 52

def mrkdwn(text:, verbatim: nil)
  @text = Composition::Mrkdwn.new(text: text, verbatim: verbatim)

  self
end

#mrkdwn_field(text:, verbatim: nil) ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/slack/block_kit/layout/section.rb', line 38

def mrkdwn_field(text:, verbatim: nil)
  @fields ||= []

  @fields << Composition::Mrkdwn.new(text: text, verbatim: verbatim)

  self
end

#overflow_menu(action_id:) {|element| ... } ⇒ Object

Yields:

  • (element) 


126
127
128
129
130
131
132
 
# File 'lib/slack/block_kit/layout/section.rb', line 126

def overflow_menu(action_id:)
  element = Element::OverflowMenu.new(action_id: action_id)

  yield(element) if block_given?

  accessorise(element)
end

#plain_text(text:, emoji: nil) ⇒ Object 



46
47
48
49
50
 
# File 'lib/slack/block_kit/layout/section.rb', line 46

def plain_text(text:, emoji: nil)
  @text = Composition::PlainText.new(text: text, emoji: emoji)

  self
end

#plaintext_field(text:, emoji: nil) ⇒ Object 



30
31
32
33
34
35
36
 
# File 'lib/slack/block_kit/layout/section.rb', line 30

def plaintext_field(text:, emoji: nil)
  @fields ||= []

  @fields << Composition::PlainText.new(text: text, emoji: emoji)

  self
end

#static_select(placeholder:, action_id:, emoji: nil) {|element| ... } ⇒ Object

Yields:

  • (element) 


134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/slack/block_kit/layout/section.rb', line 134

def static_select(placeholder:, action_id:, emoji: nil)
  element = Element::StaticSelect.new(
    placeholder: placeholder,
    action_id: action_id,
    emoji: emoji
  )

  yield(element) if block_given?

  accessorise(element)
end

#users_select(placeholder:, action_id:, initial: nil, emoji: nil) {|element| ... } ⇒ Object

Yields:

  • (element) 


146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/slack/block_kit/layout/section.rb', line 146

def users_select(placeholder:, action_id:, initial: nil, emoji: nil)
  element = Element::UsersSelect.new(
    placeholder: placeholder,
    action_id: action_id,
    emoji: emoji,
    initial: initial
  )

  yield(element) if block_given?

  accessorise(element)
end