docs/api-index

TerminalTable API documentation

TerminalTable is a pure-Nim library for responsive, styled, and live terminal tables. Most applications only need the terminal_table façade; the focused modules are available when a smaller import surface is preferable.

• Main `terminal_table` façade
• Search all exported symbols
• Package README
• Examples

Install

nimble install terminal_style
nimble install terminal_table

Quick start

import terminal_table

var table = initTable(["Name", "Role", "Status"])
table.addRow("Alice", "Administrator", green("online"))
table.addRow("Bob", "Developer", yellow("away"))
table.theme = roundedTheme

echo table.render(maxWidth = 60)

Core modules

• `tables` — table, row, column, and cell models.
• `builders` — incremental runtime table construction.
• `layouts` — panels, horizontal and vertical spans, and layout helpers.
• `themes` — built-in and custom border themes.
• `renderers` — responsive string rendering.
• `selectors` — row, column, cell, segment, and predicate selection.
• `modifiers` — selection-based styling and layout changes.
• `transformations` — transpose, rotate, compose, merge, and extract operations.
• `live_tables` — resize-safe dashboards and rolling live tables.

Data adapters

• `typed_data` — compile-time object conversion.
• `csv_adapter` — CSV parsing and table construction.
• `json_adapter` — JSON parsing and table construction.

Generate locally

nimble docs
python3 -m http.server 8000 --directory htmldocs

Then open http://localhost:8000. Serving the files over HTTP allows the generated documentation search to load its index.