jackin'
Behind jackin' — InternalsTUI DesignTUI Lookbook

TUI Lookbook

Rendered previews for shared jackin-tui components

The TUI lookbook is the contributor-facing catalog for shared jackin-tui components. Each preview is generated by the tui-lookbook binary in crates/jackin-tui-lookbook/src/main.rs from the component stories in crates/jackin-tui-lookbook/src/stories.rs using Ratatui's TestBackend, then committed under docs/public/tui-lookbook/. Generated previews render on a black terminal background so the docs match the normal terminal experience instead of a browser default page colour.

Open the same stories in a real terminal:

cargo run -p jackin-tui-lookbook -- --terminal

Regenerate the previews after changing a shared component:

cargo run -p jackin-tui-lookbook -- docs/public/tui-lookbook

Verify the committed previews without rewriting them:

cargo run -p jackin-tui-lookbook -- --check docs/public/tui-lookbook

Stories

Coverage rule

Every new shared jackin-tui component must ship with both lookbook surfaces: a docs preview page backed by generated SVG, and a terminal story visible through tui-lookbook --terminal. A component without both previews is not catalogued.

On this page