Skip to main content
TermRock
GitHub
ComponentsNavigation

Component · Navigation

Keyboard Help

Contextual generated keyboard help from live keymaps, zones, overlays, and semantic actions — footer or searchable modal, never stale hardcoded shortcuts.

Kind
widget
Input
interactive
Canvas
120×40

Live preview

Loading terminal preview.

Static terminal poster. Choose Run live to start the Rust demo.

Ghosttykeyboard-help/footer
Loading terminal poster…
○ loading posterNo input — rendered state only
Keyboard Help · exact mounted Rust story
01 · Purpose
What it is for
Contextual generated keyboard help from live keymaps, zones, overlays, and semantic actions — footer or searchable modal, never stale hardcoded shortcuts.
Best fit: Navigation · navigation · widget
02 · Behavior
What the mounted story proves
  1. 01
    KeyboardHelp
    Representative 120×40 terminal state.
  2. 02
    Passive paint
    No keyboard or pointer action is claimed by this representative story.
  3. 03
    Evidence stays explicit
    5 covered · 8 partial · 4 missing axes.
03 · Implement
Install, then start from exact code
Install
cargo add termrock --git https://github.com/tailrocks/termrock.git --rev 5283c2acf9154d0cfcd37b1ffe821c00faf90ea2
Add TermRock once. Keep domain effects in the host application.
Minimal implementation
Exact Rust setup used by keyboard-help/footer.
Open to load code.
04 · Adapt
Variants and composition
Variants
Use the preview Variant menu when alternate registered stories exist. Each selection mounts a fresh configuration.
Composition
Navigation · navigation · widget
05 · Reference
API, tokens, accessibility
API
KeyboardHelpOpen source ↗
Tokens
DesignSystemInspect exact story code for roles and capability projection.
Accessibility
Input contract mountedNo input claim in the representative story.
Contract
Evidence in progress5/23 axes covered
06 · Go deeper
Advanced guidance
Ownership boundary
TermRock owns reusable terminal rendering and interaction state. The host owns domain data, policy, persistence, authorization, and side effects.
Evidence status
5 covered, 8 partial, and 4 missing contract axes. Missing evidence is not a behavior claim.
Jump Overlay
Letter-badge jump navigation over registered rectangles.
List
Composable collection view: leading/primary/secondary/status/badge/actions/shortcut; group headers; CollectionState+SelectionModel+typeahead; single/multi/range; search; density; virtual window; ScrollArea sync.