API Reference

Exhaustive reference for all exported types, functions, and constants in the tui and tui/widget packages.

Core

  • Component — Application interface and lifecycle
  • Buffer — 2D cell grid and rendering
  • Style & Color — Visual attributes and color spaces
  • Layout — Constraint-based area splitting
  • Events — Keyboard, mouse, resize, and custom messages

KGP Integration

  • Image — Image transmission, placement, and management
  • Animation — Frame building, playback, and composition

Widgets

Component

Component is the core interface for TUI applications. Interface go Copy type Component interface { Init() Cmd Update(msg …

Buffer

Buffer is a 2D grid of cells representing terminal content. The framework creates buffers automatically; components …

Style & Color

Color Color represents a terminal color. The zero value is “no color” (terminal default). Constructors …

Layout

The layout system splits rectangular areas according to constraints. Functions VSplit go Copy func VSplit(area Rect, …

Events

All events implement the Msg interface. The framework sends them to your Update method. Keyboard go Copy type KeyMsg …

Image

Complete KGP image integration. All functions return escape sequence strings ready to flush to the terminal. …

Animation

KGP animation support for building, transmitting, and controlling animated images. Animation Builder go Copy anim := …

Widgets

All widgets are in the tui/widget package. Interactive widgets follow the pattern: go Copy widget, cmd = …