examples/

Command agentshell is a template for an agent CLI.

Command asyncload demonstrates the async-Cmd-resolves-into-a-Msg pattern: a tui.Cmd is just a func() tui.Msg, and Program.dispatch (see program.go) runs each Cmd on its own goroutine and feeds whatever Msg it returns back into the event loop.

Command avatar is a gallery for the avatar package: a wall of names, each drawn as its avatar, at a size you can change.

Command buildlog demonstrates tui.Println (see cmds.go): a Cmd that commits text permanently to the terminal's real scrollback, above the live-updating region, rather than being part of an ordinary View() repaint.

Command canvas is a custom widget that draws straight into the cell grid through DrawCells: a colour gradient with a moving marker.

Command chat is a manual showcase of the InkUI-parity widgets added after the original dashboard/form/list examples: Gauge, CodeBlock, DiffView, markdown.Render, streamtext (Typewriter), TokenCounter and layout.Column and layout.Row.

Command cursorfield shows a text input whose cursor is the terminal's real cursor: the model implements tui.CursorPlacer by forwarding textinput.Model.CursorCell, so an IME or a screen magnifier can follow the field.

Command faces is a gallery for the faces package.

Command focus is the canonical, minimal reference for coordinating Focus()/Blur() across mixed widget types in this repo.

Command inlinebuild is an inline-mode (no alternate screen) build log.

Command inlinechat is an inline-mode (no alternate screen) chat prompt.

Command inlinespinners is an inline-mode (no alternate screen) list of tasks: finished tasks show a check, the running one a spinner, the rest wait.

Command inlinetall is an inline-mode (no alternate screen) transcript that grows past the terminal height.

Command login is a credential sign-in screen built on package form, with a live design-system panel beside it for trying every theming control the library has.

Command loginflow is the canonical reference for a login-shaped screen composed entirely from the existing widget catalog — widgets.BigText for the title, widgets.Banner for an announcement, and picker.Model configured as a numbered-select account menu.

Command mixedscreen composes a string child and a cell child into one screen with DrawChild and DrawView.

Command probe shows what your terminal supports, using the library's opt-in capability options: colour depth (with NO_COLOR, COLORTERM and TERM honoured), focus in/out reporting, and OSC 11 background detection.

Command procstream demonstrates streaming a child process's stdout into a scrolling widget (logview.Model) line by line, as it arrives, rather than buffering the whole thing and rendering it once the process exits.

Command router is the canonical reference for switching between independent top-level screens in this repo, the way examples/focus is the canonical reference for Focus/Blur coordination.

Command setupflow follows the same composition-only shape as examples/welcomescreen and examples/loginflow: widgets.BigText for the title, widgets.Alert for a status message, and picker.Model as a numbered-select menu of setup steps.

Command signup is a small account form built on package form: text, secret, select and checkbox fields with validation, Tab and Shift+Tab to move between them, the arrow keys and Space to change a choice, Enter to submit (Esc quits).

Command splashscreen follows the same composition-only shape as examples/welcomescreen and examples/loginflow: widgets.BigText for the logo and widgets.Header for a tagline, dismissed by any keypress.

Command table is a dedicated, standalone example for datatable.Model's interactive row selection: Up/Down move the cursor and Enter confirms the row under it via SelectedMsg.

Command welcomescreen is the canonical reference for a static informational splash composed entirely from the existing widget catalog — widgets.Panel, widgets.BigText, widgets.Header and widgets.KeyValue side by side in a layout.Row.