Slackblocks.Elements.PlainTextInput (slackblocks v2.8.0)

View Source

A single-line or multi-line free-text input.

Slack reference: https://docs.slack.dev/reference/block-kit/block-elements/plain-text-input-element

Fields

  • action_id — Sets the identifier Slack returns in interaction payloads when a user acts on this element. It must be unique among the elements of its block. Optional; nil omits the field.
  • initial_value — Sets the value present when the input loads. Optional; nil omits the field.
  • multiline — Sets whether the input is a multi-line text area. Optional; nil omits the field.
  • min_length — Sets the minimum number of characters the user must enter. Optional; nil omits the field.
  • max_length — Sets the maximum number of characters the user can enter. Optional; nil omits the field.
  • dispatch_action_config — Sets which user interactions send a block_actions payload. Optional; nil omits the field.
  • focus_on_load — Sets whether the element receives focus when the view opens. Only one element per view may do so. Optional; nil omits the field.
  • placeholder — Sets the placeholder text shown before a value is chosen. 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.Elements.PlainTextInput{
  action_id: binary() | nil,
  dispatch_action_config:
    Slackblocks.Objects.DispatchActionConfiguration.t() | nil,
  focus_on_load: boolean() | nil,
  initial_value: binary() | nil,
  max_length: integer() | nil,
  min_length: integer() | nil,
  multiline: boolean() | nil,
  placeholder: Slackblocks.Objects.PlainText.t() | 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.