renderer

package
v1.1.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 15, 2026 License: MIT Imports: 12 Imported by: 132

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Blueprint 

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

Blueprint implements a primary table rendering engine with customizable borders and alignments.

func NewBlueprint 

func NewBlueprint(configs ...tw.Rendition) *Blueprint

NewBlueprint creates a new Blueprint instance with optional custom configurations.

func (*Blueprint) Close 

func (f *Blueprint) Close() error

Close performs cleanup (no-op in this implementation).

func (*Blueprint) Config 

func (f *Blueprint) Config() tw.Rendition

Config returns the renderer's current configuration.

func (*Blueprint) Footer 

func (f *Blueprint) Footer(footers [][]string, ctx tw.Formatting)

Footer renders the table footer section with configured formatting.

func (*Blueprint) Header 

func (f *Blueprint) Header(headers [][]string, ctx tw.Formatting)

Header renders the table header section with configured formatting.

func (*Blueprint) Line 

func (f *Blueprint) Line(ctx tw.Formatting)

Line renders a full horizontal row line with junctions and segments.

func (*Blueprint) Logger added in v1.0.1 

func (f *Blueprint) Logger(logger *ll.Logger)

Logger sets the logger for the Blueprint instance.

func (*Blueprint) Rendition added in v1.0.5 

func (f *Blueprint) Rendition(config tw.Rendition)

Rendition updates the Blueprint's configuration.

func (*Blueprint) Row 

func (f *Blueprint) Row(row []string, ctx tw.Formatting)

Row renders a table data row with configured formatting.

func (*Blueprint) Start 

func (f *Blueprint) Start(w io.Writer) error

Start initializes the rendering process (no-op in this implementation).

type Colorized 

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

Colorized renders colored ASCII tables with customizable borders, colors, and alignments.

func NewColorized 

func NewColorized(configs ...ColorizedConfig) *Colorized

NewColorized creates a Colorized renderer with the specified configuration, falling back to defaults if none provided. Only the first config is used if multiple are passed.

func (*Colorized) Close 

func (c *Colorized) Close() error

Close performs cleanup (no-op in this implementation).

func (*Colorized) Config 

func (c *Colorized) Config() tw.Rendition

Config returns the renderer's configuration as a Rendition.

func (*Colorized) Debug 

func (c *Colorized) Debug() []string

Debug returns the accumulated debug trace messages.

func (*Colorized) Footer 

func (c *Colorized) Footer(footers [][]string, ctx tw.Formatting)

Footer renders the table footer with configured colors and formatting.

func (*Colorized) Header 

func (c *Colorized) Header(headers [][]string, ctx tw.Formatting)

Header renders the table header with configured colors and formatting.

func (*Colorized) Line 

func (c *Colorized) Line(ctx tw.Formatting)

Line renders a horizontal row line with colored junctions and segments, skipping zero-width columns.

func (*Colorized) Logger added in v1.0.1 

func (c *Colorized) Logger(logger *ll.Logger)

Logger sets the logger for the Colorized instance.

func (*Colorized) Rendition added in v1.0.5 

func (c *Colorized) Rendition(newRendition tw.Rendition)

Rendition updates the parts of ColorizedConfig that correspond to tw.Rendition by merging the provided newRendition. Color-specific Tints are not modified.

func (*Colorized) Reset 

func (c *Colorized) Reset()

Reset clears the renderer's internal state, including debug traces.

func (*Colorized) Row 

func (c *Colorized) Row(row []string, ctx tw.Formatting)

Row renders a table data row with configured colors and formatting.

func (*Colorized) Start 

func (c *Colorized) Start(w io.Writer) error

Start initializes the rendering process (no-op in this implementation).

type ColorizedConfig 

type ColorizedConfig struct {
	Borders   tw.Border   // Border visibility settings
	Settings  tw.Settings // Rendering behavior settings (e.g., separators, whitespace)
	Header    Tint        // Colors for header cells
	Column    Tint        // Colors for row cells
	Footer    Tint        // Colors for footer cells
	Border    Tint        // Colors for borders and lines
	Separator Tint        // Colors for column separators
	Symbols   tw.Symbols  // Symbols for table drawing (e.g., corners, lines)
}

ColorizedConfig holds configuration for the Colorized table renderer.

type Colors 

type Colors []color.Attribute

Colors is a slice of color attributes for use with fatih/color, such as color.FgWhite or color.Bold.

func BgHex added in v1.1.5 

func BgHex(s string) (Colors, error)

BgHex behaves like Hex but returns background Colors.

func BgRGB added in v1.1.5 

func BgRGB(r, g, b int) Colors

BgRGB returns background Colors for a 24-bit ("true color") value. It behaves like RGB but sets the background rather than the foreground.

func Hex added in v1.1.5 

func Hex(s string) (Colors, error)

Hex parses a hexadecimal color string and returns foreground Colors for the equivalent 24-bit color. Both the shorthand "#RGB" and full "#RRGGBB" forms are accepted, with or without the leading '#'. An error is returned for strings that are not a valid hex color.

func RGB added in v1.1.5 

func RGB(r, g, b int) Colors

RGB returns foreground Colors for a 24-bit ("true color") value. Each of r, g and b is a channel in the range 0-255; values outside that range are clamped.

The result is a plain Colors slice, so it can be used anywhere Colors are accepted and combined with regular attributes via append, for example: 

Tint{FG: append(renderer.RGB(255, 128, 0), color.Bold)}

Terminals that do not support 24-bit color may ignore or approximate the sequence.

type HTML 

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

HTML renders tables in HTML format with customizable classes and content handling.

func NewHTML 

func NewHTML(configs ...HTMLConfig) *HTML

NewHTML initializes an HTML renderer with the given w, debug setting, and optional configuration. It panics if the w is nil and applies defaults for unset config fields. Update: see https://github.com/olekukonko/tablewriter/issues/258

func (*HTML) Close 

func (h *HTML) Close() error

Close ensures all open HTML tags (

, , ) are properly closed.

func (*HTML) Config 

func (h *HTML) Config() tw.Rendition

Config returns a Rendition representation of the current configuration.

func (*HTML) Debug 

func (h *HTML) Debug() []string

Debug returns the accumulated debug trace messages.

func (*HTML) Footer 

func (h *HTML) Footer(footers [][]string, ctx tw.Formatting)

Footer renders the

section with footer rows, supporting horizontal merges.

func (*HTML) Header 

func (h *HTML) Header(headers [][]string, ctx tw.Formatting)

Header renders the

section with header rows, supporting horizontal merges.

func (*HTML) Line 

func (h *HTML) Line(ctx tw.Formatting)

Line is a no-op for HTML rendering, as structural lines are handled by tags.

func (*HTML) Logger added in v1.0.1 

func (h *HTML) Logger(logger *ll.Logger)

func (*HTML) Reset 

func (h *HTML) Reset()

Reset clears the renderer's internal state, including debug traces and merge tracking.

func (*HTML) Row 

func (h *HTML) Row(row []string, ctx tw.Formatting)

Row renders a

element within , supporting horizontal and vertical merges.

func (*HTML) Start 

func (h *HTML) Start(w io.Writer) error

Start begins the HTML table rendering by opening the

tag.

type HTMLConfig 

type HTMLConfig struct {
	EscapeContent  bool   // Whether to escape cell content
	AddLinesTag    bool   // Whether to wrap multiline content in  tags
	TableClass     string // CSS class for
HeaderClass string // CSS class for BodyClass string // CSS class for FooterClass string // CSS class for RowClass string // CSS class for in body HeaderRowClass string // CSS class for in header FooterRowClass string // CSS class for in footer}

HTMLConfig defines settings for the HTML table renderer.

type Junction 

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

Junction handles rendering of table junction points (corners, intersections) with color support.

func NewJunction 

func NewJunction(ctx JunctionContext) *Junction

NewJunction initializes a Junction with the given symbols, context, and tints. If debug is nil, a no-op debug function is used.

func (*Junction) GetSegment 

func (jr *Junction) GetSegment() string

GetSegment determines whether to render a colored horizontal line or an empty space based on merge states.

func (*Junction) RenderJunction 

func (jr *Junction) RenderJunction(leftColIdx, rightColIdx int) string

RenderJunction selects and colors the junction symbol between two adjacent columns based on merge states and table position.

func (*Junction) RenderLeft 

func (jr *Junction) RenderLeft() string

RenderLeft selects and colors the leftmost junction symbol for the current row line based on position and merges.

func (*Junction) RenderRight 

func (jr *Junction) RenderRight(lastColIdx int) string

RenderRight selects and colors the rightmost junction symbol for the row line based on position, merges, and last column index.

type JunctionContext 

type JunctionContext struct {
	Symbols       tw.Symbols
	Ctx           tw.Formatting
	ColIdx        int
	Logger        *ll.Logger
	BorderTint    Tint
	SeparatorTint Tint
}

type Markdown 

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

Markdown renders tables in Markdown format with customizable settings.

func NewMarkdown 

func NewMarkdown(configs ...tw.Rendition) *Markdown

NewMarkdown initializes a Markdown renderer with defaults tailored for Markdown.

func (*Markdown) Close 

func (m *Markdown) Close() error

func (*Markdown) Config 

func (m *Markdown) Config() tw.Rendition

Config returns the renderer's current configuration.

func (*Markdown) Footer 

func (m *Markdown) Footer(footers [][]string, ctx tw.Formatting)

Footer renders the Markdown table footer.

func (*Markdown) Header 

func (m *Markdown) Header(headers [][]string, ctx tw.Formatting)

Header renders the Markdown table header. Separator is deferred until body alignment is known.

func (*Markdown) Line 

func (m *Markdown) Line(ctx tw.Formatting)

func (*Markdown) Logger added in v1.0.1 

func (m *Markdown) Logger(logger *ll.Logger)

func (*Markdown) Rendition added in v1.1.5 

func (m *Markdown) Rendition(config tw.Rendition)

func (*Markdown) Reset 

func (m *Markdown) Reset()

Reset clears the renderer's internal state, including debug traces.

func (*Markdown) Row 

func (m *Markdown) Row(row []string, ctx tw.Formatting)

Row renders a Markdown table data row. First row triggers deferred separator if pending.

func (*Markdown) Start 

func (m *Markdown) Start(w io.Writer) error

type Ocean added in v1.0.1 

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

Ocean is a streaming table renderer that writes ASCII tables.

func NewOcean added in v1.0.1 

func NewOcean(oceanConfig ...OceanConfig) *Ocean

func (*Ocean) Close added in v1.0.1 

func (o *Ocean) Close() error

func (*Ocean) Config added in v1.0.1 

func (o *Ocean) Config() tw.Rendition

func (*Ocean) Footer added in v1.0.1 

func (o *Ocean) Footer(footers [][]string, ctx tw.Formatting)

func (*Ocean) Header added in v1.0.1 

func (o *Ocean) Header(headers [][]string, ctx tw.Formatting)

func (*Ocean) Line added in v1.0.1 

func (o *Ocean) Line(ctx tw.Formatting)

func (*Ocean) Logger added in v1.0.1 

func (o *Ocean) Logger(logger *ll.Logger)

func (*Ocean) Rendition added in v1.0.5 

func (o *Ocean) Rendition(config tw.Rendition)

func (*Ocean) Row added in v1.0.1 

func (o *Ocean) Row(row []string, ctx tw.Formatting)

func (*Ocean) Start added in v1.0.1 

func (o *Ocean) Start(w io.Writer) error

type OceanConfig added in v1.0.1 

type OceanConfig struct{}

OceanConfig defines configuration specific to the Ocean renderer.

type SVG added in v1.0.1 

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

SVG implements tw.Renderer for SVG output. Manages SVG element generation and merge tracking.

func NewSVG added in v1.0.1 

func NewSVG(configs ...SVGConfig) *SVG

NewSVG creates a new SVG renderer with configuration. Parameter configs provides optional SVGConfig; defaults used if empty. Returns a configured SVG instance.

func (*SVG) Close added in v1.0.1 

func (s *SVG) Close() error

Close finalizes SVG rendering and writes output. Parameter w is the output w. Returns an error if writing fails.

func (*SVG) Config added in v1.0.1 

func (s *SVG) Config() tw.Rendition

Config returns the renderer's configuration. No parameters are required. Returns a Rendition with border and debug settings.

func (*SVG) Debug added in v1.0.1 

func (s *SVG) Debug() []string

Debug returns the renderer's debug trace. No parameters are required. Returns a slice of debug messages.

func (*SVG) Footer added in v1.0.1 

func (s *SVG) Footer(footers [][]string, ctx tw.Formatting)

Footer buffers footer lines for SVG rendering. Parameters include w (w), footers (lines), and ctx (formatting). No return value; stores data for later rendering.

func (*SVG) Header added in v1.0.1 

func (s *SVG) Header(headers [][]string, ctx tw.Formatting)

Header buffers header lines for SVG rendering. Parameters include w (w), headers (lines), and ctx (formatting). No return value; stores data for later rendering.

func (*SVG) Line added in v1.0.1 

func (s *SVG) Line(ctx tw.Formatting)

Line handles border rendering (ignored in SVG renderer). Parameters include w (w) and ctx (formatting). No return value; SVG borders are drawn in Close.

func (*SVG) Logger added in v1.0.1 

func (s *SVG) Logger(logger *ll.Logger)

func (*SVG) Reset added in v1.0.1 

func (s *SVG) Reset()

Reset clears the renderer's internal state. No parameters are required. No return value; prepares for new rendering.

func (*SVG) Row added in v1.0.1 

func (s *SVG) Row(rowLine []string, ctx tw.Formatting)

Row buffers a row line for SVG rendering. Parameters include w (w), rowLine (cells), and ctx (formatting). No return value; stores data for later rendering.

func (*SVG) Start added in v1.0.1 

func (s *SVG) Start(w io.Writer) error

Start initializes SVG rendering. Parameter w is the output w. Returns nil; prepares internal state.

type SVGConfig added in v1.0.1 

type SVGConfig struct {
	FontFamily              string  // e.g., "Arial, sans-serif"
	FontSize                float64 // Base font size in SVG units
	LineHeightFactor        float64 // Factor for line height (e.g., 1.2)
	Padding                 float64 // Padding inside cells
	StrokeWidth             float64 // Line width for borders
	StrokeColor             string  // Color for strokes (e.g., "black")
	HeaderBG                string  // Background color for header
	RowBG                   string  // Background color for rows
	RowAltBG                string  // Alternating row background color
	FooterBG                string  // Background color for footer
	HeaderColor             string  // Text color for header
	RowColor                string  // Text color for rows
	FooterColor             string  // Text color for footer
	ApproxCharWidthFactor   float64 // Char width relative to FontSize
	MinColWidth             float64 // Minimum column width
	RenderTWConfigOverrides bool    // Override SVG alignments with tablewriter
	Debug                   bool    // Enable debug logging
	ScaleFactor             float64 // Scaling factor for SVG
}

SVGConfig holds configuration for the SVG renderer. Fields include font, colors, padding, and merge rendering options. Used to customize SVG output appearance and behavior.

type Tint 

type Tint struct {
	FG      Colors // Foreground color attributes
	BG      Colors // Background color attributes
	Columns []Tint // Per-column color settings
}

Tint defines foreground and background color settings for table elements, with optional per-column overrides.

func (Tint) Apply 

func (t Tint) Apply(text string) string

Apply applies the Tint's foreground and background colors to the given text, returning the text unchanged if no colors are set.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.