Skip to main content

Module help

Module help 

Source
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.
HelpCacheStats
Cache hit/miss statistics for HelpRenderState.
HelpEntry
A single keybinding entry in the help view.
HelpRenderState
Cached render state for Help, enabling incremental layout reuse and dirty-rect updates for keybinding hint panels.
KeybindingHints
A keybinding hints widget with category grouping and context-aware filtering.

Enums§

HelpCategory
Category for organizing help entries into logical groups.
HelpMode
Display mode for the help widget.
KeyFormat
Format for displaying key labels in hints.