API Reference

Everything you need to build terminal UIs with Silvery.

Components

Layout

Component	Description
Box	Flexbox container — the building block for all layouts
Text	Styled text with colors, bold, italic, underline, links
Newline	Line break between text elements
Spacer	Flexible space that fills available room
Static	Renders content once, outside the rerender cycle

Interactive

Component	Description
SelectList	Keyboard-navigable list with j/k, search, disabled items
TextInput	Single-line input with full readline shortcuts
TextArea	Multi-line text editor with selection and scrolling
ListView	Virtualized list for large datasets (replaces VirtualList)
Tabs	Tab container with h/l keyboard navigation
CommandPalette	Fuzzy-search command launcher (Ctrl+P / ⌘K style)

Display

Component	Description
Table	Data table with columns, alignment, and borders
Spinner	Animated loading indicator (dots, line, arc, bounce)
ProgressBar	Determinate and indeterminate progress display

Deprecated

Component	Replacement
VirtualList	Use ListView instead

Functions

Function	Description
render	Render a React element to the terminal

Hooks

Hook	Description
useBoxRectDangerously	Read the current Box's committed rect (border-box minus padding/border)
useScrollRect	Scroll-adjusted rect — pre-sticky clamping
useScreenRect	Actual paint position on the terminal screen
useResponsiveBoxProps	Declarative responsive <Box> prop spread (canonical primitive)
useResponsiveValue	Pick any value (string, enum, callback) by viewport breakpoint
useHotkey	Bind commands to semantic key names
useHotkeyMap	Register several semantic command bindings
useTextInput	Receive typed and pasted text for custom editors
useInput	Low-level Ink-compatible keyboard input
useRawKeyEvent	Observe release, modifier-only, and protocol-level key events
useApp	Access the app instance (exit, rerender)
useStdout	Access stdout for raw writes
Focus Hooks	Focus management (useFocusable, useFocusScope)

Term sub-owners

Typed facets of the Term abstraction — one owner per class of shared-global I/O state. See the I/O umbrella guide for the architecture.

Owner	Description
term.input	Single stdin mediator — ordinary and bounded transaction probes plus typed input subscribers
term.output	stdout / stderr / console.* sink during alt-screen rendering
term.modes	Raw mode, alt screen, bracketed paste, Kitty keyboard, mouse, focus
term.size	Reactive cols/rows with 16 ms resize coalescing (alien-signals)
term.console	console.* capture + replay, complementary to term.output's sink

Quick Import

All exports come from one package:

import {
  Box,
  Text,
  SelectList,
  TextInput,
  TextArea,
  ListView,
  Tabs,
  Table,
  Spinner,
  ProgressBar,
  render,
  useBoxRectDangerously,
  useHotkey,
  useHotkeyMap,
  useTextInput,
  useInput,
  useRawKeyEvent,
  useApp,
} from "silvery"