Struct Model 

pub struct Model {
    pub show_all: bool,
    pub short_separator: String,
    pub full_separator: String,
    pub ellipsis: String,
    pub styles: Styles,
    /* private fields */
}

Model contains the state of the help view.

Fields

show_all: bool

if true, render the “full” help menu

short_separator: String

The separator used in the short help.

full_separator: String

The separator used in the full help.

ellipsis: String

The symbol we use in the short help when help items have been truncated due to width. Periods of ellipsis by default.

styles: Styles

The styles used by the help view.

Implementations

impl Model

pub fn update(&mut self, _msg: &dyn Msg) -> Cmd

Update helps satisfy the Bubble Tea Model interface. It’s a no-op.

pub fn view(&self, k: &dyn KeyMap) -> String

View renders the help view’s current state.

pub fn set_width(&mut self, w: usize)

SetWidth sets the maximum width for the help view.

pub fn width(&self) -> usize

Width returns the maximum width for the help view.

pub fn short_help_view(&self, bindings: &[Binding]) -> String

ShortHelpView renders a single line help view from a slice of keybindings. If the line is longer than the maximum width it will be gracefully truncated, showing only as many help items as possible.

pub fn full_help_view(&self, groups: &[Vec<Binding>]) -> String

FullHelpView renders help columns from a slice of key binding slices. Each top level slice entry renders into a column.

Trait Implementations

impl Clone for Model

fn clone(&self) -> Model

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Model

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.