ink-cartridgeGuides

Enhances Ink without replacing it — the foundational interaction layer for interaction-dense terminal UIs: screen system, layered keyboard engine, and full mouse integration.

Quick Start

API Reference

Layered Keyboard Engine

A 9-stage pipeline resolves conflicts between modal layers, layers, global keys, and the screen stack. Each screen owns its bindings; the focus system partitions keys within a layer, with vim-style remapping and sequence composition.

Full Mouse Integration

useMouseRegion provides click, hover, and drag. Mouse and keyboard focus work in full coordination — hovering raises the window, and keyboard priority stays exactly aligned with window z-order.

Screen Routing

Any component can be a screen. Register it into a tree and navigate with skip / back / gotoScreen (LCA routing). Ordinary and modal layers support open/close, element application, and z-index management.