Expand description
Help widget for displaying keybinding lists.
Renders a styled list of key/description pairs for showing available keyboard shortcuts in a TUI application.
§Example
use ftui_widgets::help::{Help, HelpEntry};
let help = Help::new()
.entry("q", "quit")
.entry("^s", "save")
.entry("?", "toggle help");
assert_eq!(help.entries().len(), 3);Structs§
- Help
- Help widget that renders keybinding entries.
- Help
Cache Stats - Cache hit/miss statistics for
HelpRenderState. - Help
Entry - A single keybinding entry in the help view.
- Help
Render State - Cached render state for
Help, enabling incremental layout reuse and dirty-rect updates for keybinding hint panels. - Keybinding
Hints - A keybinding hints widget with category grouping and context-aware filtering.
Enums§
- Help
Category - Category for organizing help entries into logical groups.
- Help
Mode - Display mode for the help widget.
- KeyFormat
- Format for displaying key labels in hints.