Struct HelpDialog 

pub struct HelpDialog {
    pub rows: Vec<HelpRow>,
    /* private fields */
}

Fields

rows: Vec<HelpRow>

Implementations

impl HelpDialog

pub fn new(key_bindings: &KeyBindings, tree: &LeaderNode) -> Self

pub fn cheatsheet(settings: &AppSettings) -> Self

The full leader-tree cheatsheet (leader ?): every sequence in the tree as gateway keys → description, grouped per top-level group, followed by the flat Tier-0 bindings. Built from the same leader_tree() the engine and the which-key overlay walk — one source, three surfaces.

pub fn query_syntax() -> Self

Reference card for the search query language (F1 over the Find drawer view). Operators, modifiers, and a few worked examples — mirrors the canonical table in docs/.../search.md, condensed to the keys|label shape the help widget already renders. The full prose guide lives on the docs site, not here.

pub fn handle_mouse(&mut self, m: &MouseEvent, tx: &AppTx) -> EventState

The wheel scrolls, [Esc] Close and a press outside the popup close it. Modal: every mouse event is consumed.

pub fn handle_key(&mut self, key: KeyEvent, tx: &AppTx) -> EventState

Key handler — mirrors the handle_key pattern used by all other dialog types.

Trait Implementations

impl Component for HelpDialog

fn handle_input(&mut self, event: &InputEvent, tx: &AppTx) -> EventState

Handle an event. Send AppEvents through tx for app-level effects. Returns whether this component consumed the event.

fn render( &mut self, f: &mut Frame<'_>, rect: Rect, theme: &Theme, _focused: bool, )

fn hint_shortcuts(&self) -> Vec<(String, String)>

Context-sensitive shortcut hints shown in the hints bar when this component is focused. Each entry is (key_display, label).