Skip to content
ztui
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting Started
Introduction
Why ztui
Installation
Quick Start
Guides
Architecture
Layout
Styling
Theming
Focus, keys & hotkeys
Animation & graphics
Forms & validation
React binding
Testing
Extending ztui
Debugging & AI agents
Widgets
Gallery
Controls
Button
Button Group
Input
Checkbox
Switch
Select
Slider
Radio Group
Toggle Button
Data
Table
Tree
List View
Gallery View
Selection List
Description List
Sparkline
Chart
Diff
Rich Log
Terminal View
DevTools
Text & input
Markdown
Rich Text
Text Area
Chat Input
Form
Question / Answer
Feedback
Banner
Gauge
Status
Waiting & Progress
Layout
Collapsible
Tabs
Split View
Overlays
Workbench
Media
Image
HeroIcon
File Icon
Agent Kit
Agent (full example)
Conversation
Chat Bubble
Model Picker
Tool Calls
Approval Prompt
Reasoning & Streaming
Task List & Tree
Usage Meter
Chips & Pills
@huyz0/ztui
Classes
App
BannerWidget
BunDriver
CheckboxWidget
CollapsibleWidget
ColorTween
DescriptionListWidget
DiffWidget
DOMNode
Driver
FieldErrorWidget
FieldValidation
FileIconWidget
FormWidget
GaugeWidget
HotkeyRegistry
IconRegistry
IconWidget
ImageWidget
JSONUIWidget
ListViewWidget
MockDriver
Offset
OverlayRootWidget
ProgressBarWidget
RadioGroupWidget
Region
RichLogWidget
RichTextEngine
RichTextWidget
Screen
ScreenBuffer
Segment
SelectionListWidget
SelectWidget
Size
SliderWidget
Spacing
SparklineWidget
SpinnerWidget
StatusBadgeWidget
StatusDotWidget
StatusListWidget
Style
SvgImageWidget
SwitchWidget
TabContainerWidget
TableCellWidget
TableWidget
TerminalViewWidget
TextAreaWidget
ThemeManager
ToastManager
ToggleButtonWidget
TracebackWidget
TreeWidget
Tween
ValidationSummaryWidget
WaitingGridWidget
WaitingPanelWidget
WebDriver
Widget
Interfaces
AttachOptions
BlendBase
BreatheSpec
CanvasCell
CanvasMetrics
CanvasRenderOptions
Cell
CellMetrics
Clipboard
DescriptionItem
GaugeThreshold
GraphicMetadata
Hotkey
HotkeyGroup
HotkeyOptions
IconDefinition
KeyEvent
ListItem
MouseEvent
RadioOption
ResolvedIcon
RowGroup
ScreenLayer
SelectOption
SortState
Span
StatusListWidgetItem
StyleProps
TableColumn
TableTextStyle
TerminalCapabilities
Theme
Toast
ToastOptions
TreeNode
TweenOptions
ValidatableField
ValidationResult
WidgetStyles
Type Aliases
BannerGlyphSet
BannerVariant
CollapsibleGlyphSet
DiffView
Easing
EasingFn
FormMessageMode
GlyphSet
GroupedRow
LogLevel
OverlayPlacement
PointerShape
RGB
SelectionGlyphSet
Severity
SortDirection
SpinnerWidgetMode
StatusStateValue
ToastLevel
UnderlineStyle
ValidateTrigger
Validator
WaitingGridVariant
WaitingGridWidgetCells
WaitingPanelVariant
Variables
ATTENTION_BREATH
BUNDLED_FONT_FAMILY
colorMode
EASINGS
FOCUS_BREATH
hotkeys
HTML_CELL_HEIGHT
HTML_FONT_FAMILY
HTML_FONT_SIZE
HTML_LINE_HEIGHT
HTML_PADDING
iconRegistry
logger
motion
POINTER_SHAPES
toast
Functions
adjustLightness
attachFieldValidation
attachToDOM
breatheColor
breatheIntensity
createWidgetByTagName
custom
deriveTheme
email
eventToKey
formatKeyLabel
interpolate
isPointerShape
isPriorityKey
isValidatableField
loadSetiIcons
loadSetiTheme
matchesFilter
maxLength
measureCell
measureCellFromBlock
minLength
normalizeKey
normalizeResult
oneOf
pattern
range
registerElement
registerHeroIcon
registerSetiIcon
renderBufferToCanvas
renderBufferToHTML
renderBufferToText
requestAnimationTick
required
resolveEasing
resolveFileIcon
resolveHeroIcon
runValidators
Scrollable
serializeForCanvas
startInspector
statusGlyph
translateKeyboardEvent
translateMouseEvent
@huyz0/ztui/react
Interfaces
ApprovalAction
ApprovalCall
ApprovalPromptProps
AreaChartProps
Attachment
AttentionProps
BannerProps
BarChartItem
BarChartProps
ButtonGroupProps
ButtonProps
ChatBubbleProps
ChatHint
ChatHintMarkupOptions
ChatInputProps
CheckboxProps
ChipProps
ChipToken
CollapsibleProps
Command
CompactProgressBarProps
Completion
ComponentProps
ContextMenuProps
ConversationProps
DescriptionItem
DescriptionListProps
DevToolsFrame
DevToolsProps
DevToolsRegion
DialogProps
DiffProps
DividerProps
EmailInputProps
FieldErrorProps
FileChipProps
FileIconProps
FormProps
GalleryItemContext
GalleryViewProps
GaugeProps
GaugeThreshold
HeroIconProps
HotkeyPaletteProps
IconProps
ImageProps
InputProps
JSONUIProps
LabelProps
LinePlotProps
ListViewProps
MarkdownProps
MenuItem
MermaidProps
MessageAccent
ModelEntry
ModelPickerIcons
ModelPickerProps
PanelProps
PasswordInputProps
PieChartProps
PieSlice
PillProps
PopoverProps
ProgressBarProps
QAOption
QAResult
QuestionAnswerProps
RadioGroupProps
ReasoningProps
RegionState
RichLogProps
ScatterPlotProps
ScatterPoint
SelectionListProps
SelectProps
SerializedBranch
SerializedLeaf
SliderProps
SparklineProps
SpinnerProps
SplitBranch
SplitLeaf
SplitterProps
SplitViewProps
StatusBadgeProps
StatusDotProps
StatusListItem
StatusListProps
StickyPanelProps
StreamingTextProps
SvgImageProps
SwitchProps
SyntaxProps
TabContainerProps
TableProps
TaskNode
TaskTreeProps
TerminalViewProps
TextAreaProps
ThemePaletteProps
ToastHostProps
TodoItem
TodoListProps
ToggleButtonProps
TokenUsage
ToolCallProps
ToolRenderContext
ToolRenderer
ToolRenderProps
TooltipProps
TracebackProps
TranscriptProps
TreeProps
Trigger
UsageMeterProps
UseWorkerResult
ValidationSummaryProps
WaitingGridProps
WaitingPanelProps
WorkbenchLayout
WorkbenchPanel
WorkbenchProps
WorkerState
Type Aliases
AccentSide
AccentWeight
AnimationOptions
ApprovalTone
BannerGlyphSet
BannerVariant
ChipSerializer
ChipVariant
GlyphSet
HeroIconVariant
MessageRole
ModelLocation
OverlayPlacement
QAMode
SerializedSplitNode
SpinnerMode
SplitDirection
SplitNode
StatusState
ToastGlyphSet
ToastPosition
TodoStatus
ToolCallStatus
TriggerResult
WaitingGridCells
WaitingGridVariant
WaitingPanelVariant
WorkbenchAnchor
WorkerStatus
WorkerTask
Variables
AreaChart
Banner
BarChart
bashToolRenderer
Box
Button
ChatInput
Checkbox
DEFAULT_APPROVAL_ACTIONS
DEFAULT_ROLE_ACCENTS
DEFAULT_ROLE_BACKGROUNDS
DEFAULT_TOGGLE_KEYS
DEFAULT_TOOL_RENDERERS
DescriptionList
diffToolRenderer
Dock
FieldError
Footer
Form
Gauge
Grid
HBox
Header
Icon
Image
Input
JSONUI
Label
LinePlot
Markdown
Mermaid
PieChart
RadioGroup
RichText
ScatterPlot
ScrollableBox
Select
Slider
Sparkline
Spinner
StatusBadge
StatusDot
StatusList
SvgImage
Switch
Syntax
TabContainer
TerminalView
TextArea
textToolRenderer
ToggleButton
Traceback
ValidationSummary
VBox
View
WaitingGrid
WaitingPanel
writeToolRenderer
Functions
accentStyle
ApprovalPrompt
Attention
ButtonGroup
ChatBubble
Chip
closeLeaf
Collapsible
CompactProgressBar
ContextMenu
Conversation
countLeaves
DevTools
DevToolsHighlight
Dialog
Diff
Divider
EmailInput
FileChip
FileIcon
formatChatHints
GalleryView
HeroIcon
hostComponent
HotkeyPalette
hydrateSplit
ListView
ModelPicker
Panel
PasswordInput
Pill
Popover
presetBox
ProgressBar
QuestionAnswer
Reasoning
render
resolveAccent
RichLog
SelectionList
serializeSplit
splitLeaf
Splitter
SplitView
StickyPanel
StreamingText
Table
TaskTree
ThemePalette
ToastHost
TodoList
ToolCall
ToolRender
Tooltip
Transcript
Tree
UsageMeter
useAnimatedColor
useAnimatedValue
useContextMenu
useHotkey
useToast
useTooltip
useWorker
Workbench
GitHub
Select theme
Dark
Light
Auto
logger
const
logger
:
Logger
Defined in:
src/utils/logger.ts:203
Process-wide logger singleton.