Jido.Chat.Card (Jido Chat v1.2.0)

Copy Markdown View Source

Canonical cross-platform card model with fallback rendering helpers.

Summary

Types

component()
t()

Functions

actions(items, opts \\ [])

Builds an actions component.

add(card, component)

Adds a component to the end of a card.

area_chart(data, opts \\ [])

Builds an area chart component.

area_chart(categories, series, opts)
bar_chart(data, opts \\ [])

Builds a bar chart component.

bar_chart(categories, series, opts)
button(label, action_id, opts \\ [])

Builds a button component.

chart(type, data, opts \\ [])

Builds a chart component from a chart type and data points.

chart(type, categories, series, opts)

Builds a named-series chart with ordered shared categories.

divider()

Builds a divider component.

dynamic_select(action_id, opts \\ [])

Builds a dynamic select. This is an alias for external_select/2.

external_select(action_id, opts \\ [])

Builds a select whose options load from an external source.

fallback_text(card)

Returns the best text fallback for a card.

field(label, value, opts \\ [])

Builds a field component.

fields(items, opts \\ [])

Builds a grouped fields component.

from_map(map)

Builds a card from serialized map data.

image(url, opts \\ [])

Builds an image component.

line_chart(data, opts \\ [])

Builds a line chart component.

line_chart(categories, series, opts)
link(label, url, opts \\ [])

Builds a text link component.

link_button(label, url, opts \\ [])

Builds a link button component.

link_button(label, url, action_id, opts)

Builds a link button with an explicit action ID and options.

new(card)

Creates a canonical card.

normalize(card)

Normalizes card input.

pie_chart(data, opts \\ [])

Builds a pie chart component.

radio_select(action_id, options, opts \\ [])

Builds a radio select component.

schema()

Returns the schema for cards.

section(attrs)

Builds a section component.

select(action_id, options, opts \\ [])

Builds a select component.

select_option(label, value, opts \\ [])

Builds a select option component.

select_option_group(label, options, opts \\ [])

Builds a select option group.

table(columns, rows, opts \\ [])

Builds a table component.

text(value, opts \\ [])

Builds a text component.

to_adapter_payload(card)

Returns a plain map suitable for adapter-specific rendering.

to_map(card)

Serializes a card into a plain map with a type marker.

to_markdown(card)

Renders the card to canonical Markdown.

Types

component()

@type component() :: Jido.Chat.Card.Component.t()

t()

@type t() :: %Jido.Chat.Card{
  components: [any()],
  id: nil | nil | binary(),
  markdown: nil | nil | any(),
  metadata: map(),
  summary: nil | nil | binary(),
  title: nil | nil | binary()
}

Functions

actions(items, opts \\ [])

@spec actions([component() | map()], keyword() | map()) :: component()

Builds an actions component.

add(card, component)

@spec add(t(), component() | map() | String.t()) :: t()

Adds a component to the end of a card.

area_chart(data, opts \\ [])

@spec area_chart(list(), keyword() | map()) :: component()

Builds an area chart component.

area_chart(categories, series, opts)

@spec area_chart([String.t()], list(), keyword() | map()) :: component()

bar_chart(data, opts \\ [])

@spec bar_chart(list(), keyword() | map()) :: component()

Builds a bar chart component.

bar_chart(categories, series, opts)

@spec bar_chart([String.t()], list(), keyword() | map()) :: component()

button(label, action_id, opts \\ [])

@spec button(String.t(), String.t(), keyword() | map()) :: component()

Builds a button component.

chart(type, data, opts \\ [])

@spec chart(
  :pie | :bar | :area | :line | atom() | String.t(),
  list(),
  keyword() | map()
) :: component()

Builds a chart component from a chart type and data points.

chart(type, categories, series, opts)

@spec chart(atom() | String.t(), [String.t()], list(), keyword() | map()) ::
  component()

Builds a named-series chart with ordered shared categories.

divider()

@spec divider() :: component()

Builds a divider component.

dynamic_select(action_id, opts \\ [])

@spec dynamic_select(String.t(), keyword() | map()) :: component()

Builds a dynamic select. This is an alias for external_select/2.

external_select(action_id, opts \\ [])

@spec external_select(String.t(), keyword() | map()) :: component()

Builds a select whose options load from an external source.

fallback_text(card)

@spec fallback_text(t()) :: String.t()

Returns the best text fallback for a card.

field(label, value, opts \\ [])

@spec field(String.t(), String.t(), keyword() | map()) :: component()

Builds a field component.

fields(items, opts \\ [])

@spec fields([component() | map()], keyword() | map()) :: component()

Builds a grouped fields component.

from_map(map)

@spec from_map(map()) :: t()

Builds a card from serialized map data.

image(url, opts \\ [])

@spec image(String.t(), keyword() | map()) :: component()

Builds an image component.

line_chart(data, opts \\ [])

@spec line_chart(list(), keyword() | map()) :: component()

Builds a line chart component.

line_chart(categories, series, opts)

@spec line_chart([String.t()], list(), keyword() | map()) :: component()

link(label, url, opts \\ [])

@spec link(String.t(), String.t(), keyword() | map()) :: component()

Builds a text link component.

new(card)

@spec new(t() | map()) :: t()

Creates a canonical card.

normalize(card)

@spec normalize(t() | map()) :: t()

Normalizes card input.

pie_chart(data, opts \\ [])

@spec pie_chart(list(), keyword() | map()) :: component()

Builds a pie chart component.

radio_select(action_id, options, opts \\ [])

@spec radio_select(String.t(), [component() | map()], keyword() | map()) ::
  component()

Builds a radio select component.

schema()

Returns the schema for cards.

section(attrs)

@spec section(keyword() | map()) :: component()

Builds a section component.

select(action_id, options, opts \\ [])

@spec select(String.t(), [component() | map()], keyword() | map()) :: component()

Builds a select component.

select_option(label, value, opts \\ [])

@spec select_option(String.t(), String.t(), keyword() | map()) :: component()

Builds a select option component.

select_option_group(label, options, opts \\ [])

@spec select_option_group(String.t(), [component() | map()], keyword() | map()) ::
  component()

Builds a select option group.

table(columns, rows, opts \\ [])

@spec table([String.t()], [[String.t()]], keyword() | map()) :: component()

Builds a table component.

text(value, opts \\ [])

@spec text(String.t(), keyword() | map()) :: component()

Builds a text component.

to_adapter_payload(card)

@spec to_adapter_payload(t()) :: map()

Returns a plain map suitable for adapter-specific rendering.

to_map(card)

@spec to_map(t()) :: map()

Serializes a card into a plain map with a type marker.

to_markdown(card)

@spec to_markdown(t()) :: Jido.Chat.Markdown.t()

Renders the card to canonical Markdown.