Skip to main content
TermRock
GitHub
ComponentsInputs

Component · Inputs

Keybinding Recorder

A settings control that captures and validates keybindings with escape law, conflicts, reserved chords, and protocol limits.

Kind
widget
Input
interactive
Canvas
120×40

Live preview

Loading terminal preview.

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

Ghosttykeybinding-recorder/idle
Loading terminal poster…
○ loading posterNo input — rendered state only
Keybinding Recorder · exact mounted Rust story
01 · Purpose
What it is for
A settings control that captures and validates keybindings with escape law, conflicts, reserved chords, and protocol limits.
Best fit: Inputs · input · widget
02 · Behavior
What the mounted story proves
  1. 01
    KeybindingRecorder
    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
    2 covered · 8 partial · 5 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 keybinding-recorder/idle.
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
Inputs · input · widget
05 · Reference
API, tokens, accessibility
API
KeybindingRecorderOpen source ↗
Tokens
DesignSystemInspect exact story code for roles and capability projection.
Accessibility
Input contract mountedNo input claim in the representative story.
Contract
Evidence in progress2/23 axes covered
06 · Go deeper
Advanced guidance
Authored implementation guidance
Purpose. Settings control for one action’s binding. Capture chords/sequences,
show normalized glyphs (format_chord), surface conflicts/reserved/protocol
limits, commit into a [Keymap].


Escape law


Esc always cancels recording. No mode traps the user. Idle Esc → blur.


KeyboardHelp


KeyboardHelp is a separate discovery surface. Build rows with
binding_from_recorder(&state, action, Visibility::Shown) or read the
updated Keymap via hint_spans / ShortcutHint.


Protocol limits


Neutral KeyCode has no F-keys/media keys (Unknown). Shift on chars is
folded into the character. Enhanced protocols must map into KeyEvent →
KeyChord before capture. PTY path: capture_bytes / raw_bytes_to_chord.


Reserved defaults


Ctrl+C/Z/S/Q/\ — terminal hazards. Extend with host policy.
Ownership boundary
TermRock owns reusable terminal rendering and interaction state. The host owns domain data, policy, persistence, authorization, and side effects.
Evidence status
2 covered, 8 partial, and 5 missing contract axes. Missing evidence is not a behavior claim.
Input Otp
InputOtp is the exact public paint owner for input terminal UI.
Model Selector
ModelSelector is the exact public paint owner for input terminal UI.