Help
A keybinding reference panel built from a KeyMap. Renders a compact single-line summary or a full multi-column view, so users can always see what keys do what.
Install the package
Every component ships in the single dart_tui package.
$dart pub add dart_tui
final keyMap = KeyMap([
KeyBinding(['↑', 'k'], 'move up'),
KeyBinding(['↓', 'j'], 'move down'),
KeyBinding(['enter'], 'select'),
KeyBinding(['q'], 'quit'),
]);
final help = HelpModel.fromKeyMap(keyMap);HelpModel
| Property | Type | Description |
|---|---|---|
| entries | List<HelpEntry> | Key/description pairs. Build from a KeyMap with HelpModel.fromKeyMap. |
| title | String | Panel title. Defaults to 'Help'. |
| showBorder | bool | Draw a border around the panel. |