Struct Model

pub struct Model {
    pub show_all: bool,
    pub width: usize,
    pub short_separator: String,
    pub full_separator: String,
    pub ellipsis: String,
    pub styles: Styles,
}

The help model that manages help view state and rendering.

This is the main component for displaying help information in terminal applications. It can show either a compact single-line view or an expanded multi-column view based on the show_all toggle.

Examples

Basic usage:

use bubbletea_widgets::help::{Model, KeyMap};
use bubbletea_widgets::key;

// Create a new help model
let help = Model::new().with_width(80);

// Implement KeyMap for your application
struct AppKeyMap;
impl KeyMap for AppKeyMap {
    fn short_help(&self) -> Vec<&key::Binding> {
        vec![] // Your key bindings
    }
    fn full_help(&self) -> Vec<Vec<&key::Binding>> {
        vec![vec![]] // Your grouped key bindings
    }
}

let keymap = AppKeyMap;
let help_text = help.view(&keymap);

Fields

show_all: bool

Toggles between short (single-line) and full (multi-column) help view. When false, shows compact help; when true, shows detailed help.

width: usize

The maximum width of the help view in characters. When set to 0, no width limit is enforced.

short_separator: String

The separator string used between items in the short help view. Default is “ • “ (bullet with spaces).

full_separator: String

The separator string used between columns in the full help view. Default is “ “ (four spaces).

ellipsis: String

The character displayed when help content is truncated due to width constraints. Default is “…” (horizontal ellipsis).

styles: Styles

The styling configuration for all visual elements of the help view.

Implementations

impl Model

pub fn new() -> Self

Creates a new help model with default settings.

This is equivalent to calling Model::default() but provides a more conventional constructor-style API.

Examples

use bubbletea_widgets::help::Model;

let help = Model::new();

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

Sets the maximum width of the help view.

When a width is set, the help view will truncate content that exceeds this limit, showing an ellipsis to indicate truncation.

Arguments

• width - Maximum width in characters. Use 0 for no limit.

Examples

use bubbletea_widgets::help::Model;

let help = Model::new().with_width(80);
assert_eq!(help.width, 80);

pub fn view<K: KeyMap>(&self, keymap: &K) -> String

Renders the help view based on the current model state.

This is the main rendering function that switches between short and full help views based on the show_all flag.

Arguments

• keymap - An object implementing the KeyMap trait that provides the key bindings to display.

Returns

A formatted string ready for display in the terminal.

Examples

use bubbletea_widgets::help::{Model, KeyMap};
use bubbletea_widgets::key;

struct MyKeyMap;
impl KeyMap for MyKeyMap {
    fn short_help(&self) -> Vec<&key::Binding> { vec![] }
    fn full_help(&self) -> Vec<Vec<&key::Binding>> { vec![] }
}

let help = Model::new();
let keymap = MyKeyMap;
let rendered = help.view(&keymap);

pub fn short_help_view(&self, bindings: Vec<&Binding>) -> String

Renders a compact single-line help view.

This view displays key bindings in a horizontal layout, separated by the configured separator. If the content exceeds the specified width, it will be truncated with an ellipsis.

Arguments

• bindings - A vector of key bindings to display.

Returns

A single-line string containing the formatted help text.

Examples

use bubbletea_widgets::help::Model;
use bubbletea_widgets::key;

let help = Model::new();
let bindings = vec![]; // Your key bindings
let short_help = help.short_help_view(bindings);

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

Renders a detailed multi-column help view.

This view organizes key bindings into columns, with each group of bindings forming a separate column. Keys and descriptions are aligned vertically within each column.

Arguments

• groups - A vector of key binding groups, where each group becomes a column in the output.

Returns

A multi-line string containing the formatted help text with proper column alignment.

Examples

use bubbletea_widgets::help::Model;
use bubbletea_widgets::key;

let help = Model::new();
let groups = vec![vec![]]; // Your grouped key bindings
let full_help = help.full_help_view(groups);

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.

impl Default for Model

fn default() -> Self

Creates a new help model with sensible defaults.

Default configuration:

• show_all: false (shows short help)
• width: 0 (no width limit)
• short_separator: “ • “
• full_separator: “ “ (4 spaces)
• ellipsis: “…”
• styles: Default styles

Examples

use bubbletea_widgets::help::Model;

let help = Model::default();
assert_eq!(help.show_all, false);
assert_eq!(help.width, 0);