View Source Kino.Table behaviour (Kino v0.10.0)

@type column() :: %{
  :key => term(),
  :label => String.t(),
  optional(:type) => String.t(),
  optional(:summary) => %{required(String.t()) => String.t()}
}

info()

@type info() :: %{
  :name => String.t(),
  :features => [:export | :refetch | :pagination | :sorting],
  optional(:export) => %{formats: [String.t()]}
}

rows_spec()

@type rows_spec() :: %{
  offset: non_neg_integer(),
  limit: pos_integer(),
  order: nil | %{direction: :asc | :desc, key: term()}
}

state()

@type state() :: term()

t()

@type t() :: Kino.JS.Live.t()

Link to this section Callbacks

export_data(state, t)

(optional)

@callback export_data(state(), String.t()) ::
  {:ok, %{data: binary(), extension: String.t(), type: String.t()}}

Exports the data for download.

The returned map must contain the binary, the file extension and the mime type.

get_data(rows_spec, state)

@callback get_data(rows_spec(), state()) ::
  {:ok,
   %{
     columns: [column()],
     data: {:columns | :rows, [[String.t()]]},
     total_rows: non_neg_integer() | nil
   }, state()}

Loads data matching the given specification.

init(init_arg)

@callback init(init_arg :: term()) :: {:ok, info(), state()}

Invoked once to initialize server state.

Link to this section Functions

new(module, init_arg)

@spec new(module(), term()) :: t()

Creates a new tabular kino using the given module as data specification.

Settings View Source Kino.Table behaviour (Kino v0.10.0)

Link to this section Summary

Types

Callbacks

Functions

Link to this section Types

column()