Struct Help 

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

Help view model.

Fields

width: usize

Maximum width for the help view.

show_all: bool

Whether to show full help (vs short help).

short_separator: String

Separator for short help items.

full_separator: String

Separator for full help columns.

ellipsis: String

Ellipsis shown when help is truncated.

styles: Styles

Styles for rendering.

Implementations

impl Help

pub fn new() -> Self

Creates a new help view with default settings.

pub fn with_bindings(self, bindings: Vec<Binding>) -> Self

Sets the key bindings for standalone Model usage.

pub fn set_bindings(&mut self, bindings: Vec<Binding>)

Sets the key bindings.

pub fn bindings(&self) -> &[Binding]

Returns the stored key bindings.

pub fn width(self, width: usize) -> Self

Sets the width of the help view.

pub fn show_all(self, show: bool) -> Self

Sets whether to show all help items.

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

Renders the help view for a list of bindings.

Displays short help if show_all is false, full help otherwise.

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

Renders short help from a list of bindings.

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

Renders full help from groups of bindings.

Trait Implementations

impl Clone for Help

fn clone(&self) -> Help

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Help

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

Formats the value using the given formatter.

impl Default for Help

fn default() -> Self

Returns the “default value” for a type.

impl Model for Help

Implement the Model trait for standalone bubbletea usage.

fn init(&self) -> Option<Cmd>

Initialize the model and return an optional startup command.

fn update(&mut self, msg: Message) -> Option<Cmd>

Process a message and return a new command.

fn view(&self) -> String

Render the model as a string for display.