Slackblocks.RichText.List (slackblocks v2.8.0)

View Source

A bulleted or numbered list inside rich text.

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

Fields

  • style — Sets whether the list is bulleted or numbered. Required.
  • elements — Adds list items, one rich text section per item. Required.
  • indent — Sets the list's indentation level. Optional; nil omits the field.
  • offset — Sets the number of items to skip when numbering an ordered list. Optional; nil omits the field.
  • border — Sets the width of the left border, in pixels. 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.RichText.List{
  border: integer() | nil,
  elements: [Slackblocks.RichText.Section.t()],
  indent: integer() | nil,
  offset: integer() | nil,
  style: Slackblocks.Types.rich_text_list_style()
}

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.