Slackblocks.Blocks.DataTable (slackblocks v2.8.0)

View Source

A sortable, paginated table of raw text, numbers, and rich text.

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

Fields

  • rows — Adds complete table rows in display order. Every row must have the same number of cells. Required.
  • caption — Sets the caption that describes the table's contents. Required.
  • page_size — Sets how many rows Slack shows per page. Default: 5. Optional; nil omits the field.
  • row_header_column_index — Sets the zero-based index of the column whose cells act as row headers. Default: 0. 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.DataTable{
  block_id: binary() | nil,
  caption: binary(),
  page_size: integer() | nil,
  row_header_column_index: integer() | nil,
  rows: [[Slackblocks.Types.data_table_cell()]]
}

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.