Components

Breadcrumbs: renders a non-interactive path trail of segments with separators and truncation

PerformanceOverlay component

FPSCounter component

Tag: a short inline label with a colored border and no background fill

A raw Canvas widget providing a HTML5-like 2D drawing context for custom rendering

OrderedList: renders a numbered list with optional nesting

DiffView: a scrollable unified diff viewer with +/- line coloring

Highlight component

BigText: renders text as large 5×3 ASCII art banner characters

Digits: renders a numeric string as large 3-row ASCII art

ChatMessage: displays a single chat message with a colored role badge and word-wrapped content text

Pty: Terminal Multiplexer widget

UnorderedList - renders a bulleted list with optional nested children

DirectoryTree component

Text: renders a string of text with word-wrapping, alignment, and scrolling

Markdown: renders a subset of Markdown syntax in the terminal

Accordion: a group of collapsible sections

JSONView: a syntax-colored, collapsible JSON viewer

Convert any JSON-compatible value to a TreeNode, optionally prefixed by `key` (the property name or array index in the parent container)

Rule: a horizontal or vertical divider line with an optional centered title

LogView: scrollable, highlighted log output

slide navigator with indicator dots and keyboard controls

Stopwatch: counts up from zero, displaying elapsed time

ShortcutBar: a horizontal footer bar that displays quick key bindings

Avatar: a widget that displays user initials with a generated color

Decorative QR-style pattern generator

QRCode component

Badge: a short inline label with a colored background

Tooltip: displays contextual help text

Code component

ToolCall: displays an AI tool invocation with status indicator, tool name, arguments, and optional result

ToolApproval: extends ToolCall with an approval prompt row

ProgressCircle component

Clock component

Gradient: text rendered with a smooth color gradient

Collapsible: a toggleable section with title and body

Kbd: an inline label representing a keyboard input

Timer: counts down from a duration to zero

ThinkingBlock component

StreamingText: renders text that "streams in" token by token with a blinking cursor

Watermark - fills its area with faint repeating text

Reveals static text character by character

Timeline: renders a vertical list of timeline items

NotificationBadge - a small count label rendered at a corner position

Tree: a collapsible tree widget for displaying hierarchical data

ChatThread component

Stepper: renders a sequence of steps with status indicators

Marquee component

Whether to append the URL visually when terminal capabilities lack unicode/OSC 8 support

Placeholder - a labeled stand-in box for prototyping terminal layouts

Show begin/end arrow symbols

Alert: full-width status message box with a colored border and an icon prefix

Banner: full-width alert with title and body text

BarColumn component

TextColumn component

TimeColumn component

SpeedColumn component

PercentageColumn component

StatusMessage: a single-line status indicator

Spinner: animated loading indicator

Built-in spinner frame sets

Callout component

Dot color

Progress component

TaskList: a vertical list of tasks with status indicators

ProgressBar: horizontal progress indicator

MultiProgress: stacks multiple labeled progress bars in a vertical list

Skeleton component

EmptyState component

ContextMenu: a floating menu widget positioned at absolute coordinates

CommandPalette: a fuzzy-search overlay widget

Checkbox: a toggleable boolean input with a label

Knob component

Button: a pressable button with a label and visual variants

PinInput component

Slider component

TextInput: a single-line text input field with optional command auto-completion support

List: a scrollable, selectable list of items

VirtualList: a scroll-virtualized list widget

RangeInput component

Compute visible range for fixed-height items

Compute visible range for variable-height items

Panel: a labeled container widget

DraggableWidget component

DroppableWidget component

── Drag State Manager ──

Stack: a widget that layers children on top of each other

ScrollView: a height-bounded scrollable container

Columns: splits available width evenly across child widgets

Card: a bordered container with an optional title in the top border

contain = fit inside, cover = fill

Dock component

Center: centers a single child widget horizontally and/or vertically

Divider: a horizontal or vertical separator line with optional label

SplitPane: two-pane resizable layout widget

Fill component

Vertical gap between items

ScrollAcceleration component

Grid: a true CSS-Grid-like layout container

GridItem: a child container that can define grid column/row spans or starts

BulletChart: a metric display with target marker and qualitative range bands

Character shown for non-printable bytes in ASCII column

TreeTable: combines Tree expand/collapse with Table columns

Table: renders tabular data with columns, headers, and optional zebra-striping

Axis names, one per spoke

BrailleCanvas component

Definition: term + definition pairs, stacked vertically

Callback fired when the filter changes

Hook that creates a fresh ListState

Stat component

Color for text labels

Calendar component

Sparkline: a compact inline chart showing a data trend

CandlestickChart: renders OHLC candle data as a terminal chart

LineChart: ASCII/Unicode line plot for a series of numbers

AreaChart component

Hook that creates a fresh TableState

StackedBarChart component

Histogram component

Meter: a self-contained metric display with label, bar, and value with low/optimum/high thresholds

PieChart component

GanttChart component

StatusIndicator: simple up/down indicator with label

Point marker

KeyValue: aligned key: value pairs

Gauge: a self-contained metric display with label, bar, and value

HeatMap: 2D matrix displayed with character-density shading

Sidebar: a vertical list of navigation items with optional badges

Show percentage label at right

useCounter component

useModal: typed modal manager with queueing and cleanup

useViewMeta component

useTerminalSize component

Types that produce an audible bell

Fire feedback for a given interaction type

map UI events to terminal audio cues (bell)

useFocusWithin: check if focus is within a list of IDs

useToggle component

Accumulates printable character keypresses to navigate lists by typing

useKeyboardNavigation: arrow-key list navigation with wrap/clamp support

useSubprocess component

useFocus: consume focus state for a focusable element

useThrottle: throttle a changing value

useTimeout: run a callback once after a delay

useBoolean component

useBell - A React-like hook for triggering the terminal bell

useList component

Detect the running package manager from environment variables

Return command helpers for the given package manager

Hook: returns commands for the detected package manager (stable across renders)

useStopwatch: tracks elapsed time with start, pause, and reset controls

useMap component

useDebounce: debounce a changing value

useFocusManager: manages focus state for a subtree

useCountdown: counts down from a start value with start, pause, and reset controls

useElementSize: track the size of a widget element

useClipboard: interact with the system clipboard

useFocusTrap: cycle Tab / Shift+Tab focus through a fixed list of IDs

useSet component

sortable item list

validateInput component

full-screen application layout

RadioGroup: renders a vertical list of mutually exclusive options

WelcomeScreen component

Highlight color for the selected suggestion

TokenUsage component

The specific terminal coordinates (row/col) to anchor this popover to

single-item dropdown selector

simple page navigator

PasswordInput component

show a single active child widget

overlay dialog with backdrop

QuizPrompt component

Enable screen reader announcements (default: true)

── NotificationStore (singleton) ──────────────────────────────────────────

NotificationCenter component

Global singleton accessor

── useNotifications JSX hook ───────────────────────────────────────────────

NumberInput component

SetupFlow component

calendar date selector widget

TagInput component

expandable tree with single or multi selection

named page container with optional overlay behavior

compound input container with validation

Menu: a vertical list of interactive items supporting keyboard navigation, shortcuts, and disabled states

SearchInput component

TimePicker component

Wizard component

dual-list shuttle selector widget

parse template placeholders and manage prompt values

yes/no prompt overlay

Switch component

NonInteractiveError component

Imperative prompts for CLI scripts: no widget stack required

EditablePrompt component

Draggable component

Droppable component

FormContext component

FormBuilder component

useForm component

single-selection segmented control

FilePicker: an interactive file browser widget

screen-reader-friendly linear prompt rendering

checkbox-style multi-item selector

searchable dropdown selector with filtering

ThemeSwitcher component

Common domains to suggest after '@'

Disclosure component

ButtonGroup component

Color for the text

Max messages kept in the visible log

CheckboxGroup component

Listbar component

Rating: renders a row of star glyphs for a 1-to-N rating

calendar date range selector widget

flexible empty space

BasicAuthPrompt component

SurveyPrompt component

MultilineTextInput component

tabbed container with keyboard switching

PathInput: filesystem path input with Tab-completion

ColorPicker component

Drawer: a side panel that slides in from any edge

TextArea - a multi-line text input field

Breadcrumb component

text input with inline filtered dropdown

horizontal menu bar with dropdown menus

A group of bindings belonging to the same category

ScalePrompt component