TableRex.Renderer behaviour (table_rex v3.1.1) View Source

An Elixir behaviour that defines the API Renderers should conform to, allowing for display output in a variety of formats.

Link to this section Summary

Types

render_return()

Return value of the render function.

Callbacks

default_options()

Returns a Map of the options and their default values required by the renderer.

render(table, opts)

Renders a passed %TableRex.Table{} struct into a string.

Link to this section Types

render_return()

Specs

render_return() :: {:ok, String.t()} | {:error, String.t()}

Return value of the render function.

Link to this section Callbacks

default_options()

Specs

default_options() :: map()

Returns a Map of the options and their default values required by the renderer.

render(table, opts)

Specs

render(
  table :: %TableRex.Table{
    columns: term(),
    default_column: term(),
    header_row: term(),
    rows: term(),
    title: term()
  },
  opts :: list()
) :: render_return()

Renders a passed %TableRex.Table{} struct into a string.