Slackblocks.Blocks.Section (slackblocks v2.8.0)

View Source

Text, a grid of fields, or both, with an optional accessory element.

Slack reference: https://docs.slack.dev/reference/block-kit/blocks/section-block

Fields

  • text — Sets the main text of the section. Optional; nil omits the field.
  • fields — Adds section fields, shown in a two-column grid, in display order. Optional; nil omits the field.
  • accessory — Sets the element displayed beside the section text. Optional; nil omits the field.
  • block_id — Sets a unique identifier for this block. Slack returns it in interaction payloads, so use a stable value when you need to find the block again. Optional; nil omits the field.

Summary

Types

t()

Functions

change(value, options)

Atomically replaces supplied fields; omitted fields retain their values.

change!(value, options)

Replaces fields or raises Slackblocks.ValidationError.

new(options)

Constructs and validates a value. Text conveniences apply to keyword input.

new!(options)

Constructs a value or raises Slackblocks.ValidationError.

Types

t()

@type t() :: %Slackblocks.Blocks.Section{
  accessory: Slackblocks.Types.element() | nil,
  block_id: binary() | nil,
  fields: [Slackblocks.Types.text()] | nil,
  text: Slackblocks.Types.text() | nil
}

Functions

change(value, options)

@spec change(
  t(),
  keyword()
) :: {:ok, t()} | {:error, Slackblocks.ValidationError.t()}

Atomically replaces supplied fields; omitted fields retain their values.

change!(value, options)

@spec change!(
  t(),
  keyword()
) :: t()

Replaces fields or raises Slackblocks.ValidationError.

new(options)

@spec new(keyword()) :: {:ok, t()} | {:error, Slackblocks.ValidationError.t()}

Constructs and validates a value. Text conveniences apply to keyword input.

new!(options)

@spec new!(keyword()) :: t()

Constructs a value or raises Slackblocks.ValidationError.