📚 TUI Framework

@sullux/tui Documentation

Welcome to the official documentation for @sullux/tui, a declarative, component-driven User Interface framework designed specifically for terminal environments.

Overview

@sullux/tui cleanly separates markup structure and layout styling (expressed in logic-free YAML) from runtime behavior and event dispatching (expressed in pure, functional JavaScript).

  • Introduction — The layout challenge and the declarative solution.
  • Quick Start — Installation and building your first TUI application.
  • Developer Guide — In-depth guide to components, engines, focus, keyboard routing, and type normalizers.
  • Built-In Control Reference — Full API reference for built-in controls (layout, canvas, scroll, stack, wrap, text, rich, border, image).
  • Examples — Real-world UI patterns and custom component examples.
  • License — License terms (MIT).