Trait KeyMap

Source
pub trait KeyMap {
    // Required methods
    fn short_help(&self) -> Vec<&Binding>;
    fn full_help(&self) -> Vec<Vec<&Binding>>;
}
Expand description

A trait that defines the key bindings to be displayed in the help view.

Any model that uses the help component should implement this trait to provide the key bindings that the help view will render.

Required Methods§

Source

fn short_help(&self) -> Vec<&Binding>

Returns a slice of key bindings for the short help view.

Source

fn full_help(&self) -> Vec<Vec<&Binding>>

Returns a nested slice of key bindings for the full help view. Each inner slice represents a column in the help view.

Implementors§

Source§

impl KeyMap for bubbletea_widgets::table::Model

Help system integration for displaying table navigation keys.

This implementation provides the help system with information about the table’s key bindings, enabling automatic generation of help text that documents the available navigation commands.

Source§

impl<I: Item> KeyMap for bubbletea_widgets::list::Model<I>