table

Documentation

Overview

Package table renders aligned, borderless tables for CLI output.

It wraps charmbracelet/lipgloss/table with sensible defaults: no borders, automatic terminal width detection, ANSI-aware column sizing, and cell normalization (tabs/newlines → spaces).

Index

• func CellMaxWidth() int
• func CellWidth(value string) int
• func ColumnPaddingWidth() int
• func Format(headers []string, rows [][]string) string
• func OverrideViewportWidth(fn func() int) func()
• func TruncateCell(value string) string
• func TruncateCellToWidth(value string, max int) string
• func ViewportWidth() int
• type Builder
  • func NewBuilder(headers []string, capacity int) *Builder
  • func (b *Builder) AddRow(row []string)
  • func (b *Builder) String() string

Functions

func CellMaxWidth

func CellMaxWidth() int

CellMaxWidth reports the default maximum width for table cells.

func CellWidth

func CellWidth(value string) int

CellWidth reports the display width of a table cell.

func ColumnPaddingWidth

func ColumnPaddingWidth() int

ColumnPaddingWidth reports the padding between columns.

func Format

func Format(headers []string, rows [][]string) string

Format renders headers and rows as an aligned table.

func OverrideViewportWidth

func OverrideViewportWidth(fn func() int) func()

OverrideViewportWidth replaces the viewport width provider.

func TruncateCell

func TruncateCell(value string) string

TruncateCell limits cell width while preserving visible characters.

func TruncateCellToWidth

func TruncateCellToWidth(value string, max int) string

TruncateCellToWidth limits cell width while preserving visible characters.

func ViewportWidth

func ViewportWidth() int

ViewportWidth reports the configured viewport width.

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

Builder collects rows and renders a formatted table.

func NewBuilder

func NewBuilder(headers []string, capacity int) *Builder

NewBuilder returns a builder with preallocated rows.

func (*Builder) AddRow

func (b *Builder) AddRow(row []string)

AddRow appends a row to the table.

func (*Builder) String

func (b *Builder) String() string

String renders the table output.