spruce/table

Bordered, ANSI-aware data table rendering.

Types

Align

Horizontal alignment for a table column.

pub type Align {
  Left
  Center
  Right
}

Constructors

```
Left
```
```
Center
```
```
Right
```

RowContext

</>

Identifies the row kind passed to a style_fn.

pub type RowContext {
  Header
  Body(index: Int)
}

Constructors

```
Header
```
The header row.
```
Body(index: Int)
```
A zero-based body row.

Table

opaque </>

A table of string cells with an optional header row. Build one with new and the configuration functions in this module, then render it with render.

pub opaque type Table

Values

border

</>

pub fn border(table: Table, border: border.Border) -> Table

Set the table border style.

Junctions are exact for Normal, Rounded, Thick, and Double. Other border styles approximate junctions from their edge characters.

column_alignments

</>

pub fn column_alignments(
  table: Table,
  alignments: List(Align),
) -> Table

Set horizontal alignment by column.

Columns without a corresponding alignment are left-aligned.

column_widths

</>

pub fn column_widths(table: Table, widths: List(Int)) -> Table

Constrain columns to maximum visual widths.

Widths less than one are ignored. Columns without a corresponding configured width use their natural content width.

headers

</>

pub fn headers(table: Table, headers: List(String)) -> Table

Set the optional header row.

new

</>

pub fn new() -> Table

Create an empty table.

render

</>

pub fn render(context: spruce.Spruce, table: Table) -> String

Render a table as a bordered grid.

row_separators

</>

pub fn row_separators(table: Table, enabled: Bool) -> Table

Toggle separator lines between body rows.

rows

</>

pub fn rows(table: Table, rows: List(List(String))) -> Table

Set the body rows. Short rows are padded with empty cells at render time.

style_fn

</>

pub fn style_fn(
  table: Table,
  style_fn: fn(RowContext, Int) -> style.Style,
) -> Table

Set a per-cell style function.

The RowContext argument is Header for header cells and Body(index) for zero-based body row cells.

width

</>

pub fn width(table: Table, width: Int) -> Table

Constrain the overall table to a maximum visual width.

The available width after visible borders and cell padding is distributed evenly across columns. Cells that exceed their column width are wrapped with spruce/align.wrap.