Skip to content

Components & Hooks

This is a quick-reference index of all Silvery components and hooks. For detailed usage, see the Components Guide and the individual API pages.

Components

Layout

ComponentDescriptionAPI
BoxFlexbox container with borders, padding, overflowCore
SpacerFlexible space that fills available roomCore
NewlineLine breakCore
SplitPaneControlled resizable two-child layoutUI
SplitViewRecursive binary-tree pane rendererUI

Text & Display

ComponentDescriptionAPI
TextStyled text with color, bold, italic, wrappingCore
StaticNon-updating content (logs, completed items)Core
TransformPer-line string transformationCore
BadgeStyled label/tagUI
DividerHorizontal ruleUI
LinkOSC 8 hyperlinkUI
ImageKitty graphics / Sixel with text fallbackUI

Input

ComponentDescriptionAPI
TextInputSingle-line text input with readline shortcutsUI
TextAreaMulti-line text editor with cursor, selection, undoUI
SelectListSingle-select list with keyboard navigationUI
ToggleBoolean toggleUI
ButtonClickable buttonUI

Data Display

ComponentDescriptionAPI
TableColumn-aligned table with headersUI
VirtualListO(1) scroll for thousands of itemsUI
VirtualViewVirtualized arbitrary contentUI
TreeViewExpandable/collapsible treeUI

Feedback

ComponentDescriptionAPI
SpinnerAnimated spinner (dots, line, arc, bounce)UI
PulseLocal or app-synchronized text pulseUI
ProgressBarDeterminate and indeterminate progressUI
MeterLevel gauge with fitted overlay labelUI
Toast / useToast()Auto-dismiss notificationsUI
SkeletonLoading placeholderUI

Overlays & Navigation

ComponentDescriptionAPI
ModalDialogModal overlay with focus trappingUI
CommandPaletteFuzzy-search command palette (Ctrl+K)UI
PickerDialog / PickerListSelection dialogUI
TooltipContextual tooltip overlayUI
Tabs / TabList / Tab / TabPanelTabbed interfaceUI
BreadcrumbPath breadcrumb with separatorsUI

Layout Wrappers

ComponentDescriptionAPI
ThemeProviderTheme context providerTheme
ErrorBoundaryReact error boundary with resetUI
ConsoleCaptures console.log outputUI
Form / FormFieldForm layout with labels and validationUI

Hooks

Layout & Measurement

HookDescriptionAPI
useBoxRectComponent's content dimensions (synchronous)Core
useScrollRectComponent's screen-space position and dimensionsCore

Input & Interaction

HookDescriptionAPI
useHotkeySemantic command bindingCore
useHotkeyMapMultiple semantic command bindingsCore
useTextInputTyped and pasted text for custom editorsCore
useInputLow-level Ink-compatible keyboard inputCore
useRawKeyEventProtocol-level key observationCore
usePasteBracketed paste handlerCore
useCursorTerminal cursor positioning (IME)Core

Focus

HookDescriptionAPI
useFocusFocus state for a componentCore
useFocusManagerProgrammatic focus controlCore
useFocusWithinWhether any descendant is focusedCore

App Lifecycle

HookDescriptionAPI
useAppApp-level methods (exit, panic)Core
usePanicFatal diagnostics after TUI exitCore
useStdoutstdout stream accessCore

Animation

HookDescriptionAPI
useAnimationFrame-based animation with easingUI
useAnimatedTransitionAnimated value transitionsUI
usePulseLocal or app-synchronized two-phase clockUI
useSynchronizedPhaseApp-scoped shared multi-step phase clockUI

Data & State

HookDescriptionAPI
useScrollbackFreeze completed items into terminal historyCore
useToastToast notification managementUI

See Also