API Reference ExRatatui v#0.8.2

Copy Markdown View Source

Modules

Elixir bindings for the Rust ratatui terminal UI library.

A behaviour for building supervised TUI applications.

Commands represent one-shot side effects scheduled by an ExRatatui.App.

Distribution-attach transport for ExRatatui.App.

Supervisor for distribution-attach sessions on the app node.

Terminal event structs.

A keyboard event.

A mouse event.

A terminal resize event.

Focus management for multi-panel apps.

Terminal frame information passed to render/2 callbacks.

Layout system for splitting areas into sub-regions.

A rectangular area on the terminal screen.

Runtime inspection and trace controls for supervised ExRatatui applications.

OTP :ssh_server_channel implementation that serves an ExRatatui.App over a single SSH channel.

GenServer that owns an OTP :ssh.daemon/2 listening for TUI clients.

A per-connection terminal session backed by an in-memory writer.

Style configuration for widgets.

Subscriptions represent ongoing or delayed self-messages owned by an app.

Telemetry integration for ExRatatui.

Rich-text value composed of one or more ExRatatui.Text.Lines.

A single line of text composed of one or more ExRatatui.Text.Spans.

A single styled run of text — the smallest rich-text primitive.

Shared protocol between the internal Server runtime and the modules that carry input/output bytes for a running ExRatatui.App.

Helpers for transports that carry raw terminal bytes to and from a remote ExRatatui.Session.

Protocol for user-defined widgets that compose ExRatatui primitives.

A vertical or horizontal bar chart widget.

A labelled cluster of ExRatatui.Widgets.Bar rendered together inside a ExRatatui.Widgets.BarChart.

A container widget that provides borders and a title around other widgets.

A monthly calendar widget that displays days in a 7-column grid.

A 2D drawing surface for plotting shapes in arbitrary coordinate space.

A text annotation to print on a ExRatatui.Widgets.Canvas.

A world map shape to paint on a ExRatatui.Widgets.Canvas.

A collection of single-point markers to paint on a ExRatatui.Widgets.Canvas.

An XY plotting widget for line, scatter, and bar visualizations.

A checkbox widget for toggling boolean values.

A widget that resets all cells in its area to empty (space) characters.

A progress bar widget.

A thin horizontal progress bar widget.

A selectable list widget.

A markdown rendering widget with syntax highlighting for code blocks.

A text display widget with optional wrapping, alignment, and scrolling.

A centered modal overlay widget.

A scrollbar widget for indicating scroll position in content.

Slash command parsing and autocomplete popup rendering.

A slash command definition with name, description, and optional aliases.

A compact inline chart for a single data series.

A table widget with headers, rows, and optional selection.

A tab bar widget for switching between views.

A single-line text input widget with cursor and viewport management.

A multiline text editor widget with undo/redo, cursor movement, and selection.

A loading spinner widget that animates through symbol sets.

A vertical list of heterogeneous widgets with optional selection and scrolling.