Skip to content

README.md

Latest commit

 

History

History
53 lines (40 loc) · 2.42 KB

README.md

File metadata and controls

53 lines (40 loc) · 2.42 KB

LeTUI docs

Start here

  1. Read docs/getting-started.md
  2. Run bun run build-ffi
  3. Start with bun run dev, bun run anitrack, examples/snake.ts, or examples/typing-speed.ts
  4. Use docs/components-and-styling.md for current public props
  5. Use docs/state-events-lifecycle.md for signals, focus, input, and cleanup
  6. Use docs/text-layout-overflow-spec.md for multiline text / overflow design
  7. Use docs/releasing.md when cutting a new npm release

Current API shape

  • layout primitives: Box, Row, Column
  • leaf nodes: Text, Input, Button
  • shared style props live in StyleProps: borders, padding, colors, flex, sizing, min/max, margins, alignment, wrapping
  • box-only props live in BoxProps: gap, direction
  • direction supports row, column, rowReverse, columnReverse
  • current docs treat code as source of truth; anything outside exported prop types is not public API

Current runtime shape

  • JS keeps a previous sent-tree snapshot and compares it against the current node tree each frame
  • compatible tree shape => send style deltas and text ops only
  • incompatible tree shape => clear Rust tree state and rebuild it once
  • Rust owns persistent tree state, layout, paint, terminal buffers, and incremental flush
  • debug metrics phases: serialize, textSync, rust, sync, flush

Example map

  • examples/smoke.ts: deterministic PTY smoke target for CI and agents
  • examples/anitrack.ts: interactive torrent-search demo
  • examples/snake.ts: keyboard-driven snake game with stable grid nodes
  • examples/typing-speed.ts: centered Colemak Mod-DH typing tester
  • examples/ai-agent.ts: keyboard-driven split-pane demo
  • examples/visualizer.ts: metrics-friendly animated renderer stress demo

Agent skills

Repo-local agent skills live in .agents/skills/.

  • .agents/skills/letui-api-doc-drift/SKILL.md: docs/API drift workflow for this repo
  • .agents/skills/letui-smoke-runner/SKILL.md: manual and CI-style TUI smoke validation
  • .agents/skills/kitty-tui-control/SKILL.md: kitty tab/window control for interactive terminal testing

Constraints to remember

  • use Bun, not Node, for runtime in this repo
  • colors are numeric hex (0xRRGGBB), not CSS strings
  • Ctrl+Q is always the default quit path
  • keep node identity stable when possible; recreating whole subtrees defeats incremental sync
  • examples and scripts are part of typecheck; if docs drift from code, fix docs/examples first