Struct Help 

pub struct Help { /* private fields */ }

Help widget that renders keybinding entries.

In HelpMode::Short mode, entries are shown inline separated by a bullet character, truncated with an ellipsis if they exceed the available width.

In HelpMode::Full mode, entries are rendered in a vertical list with keys and descriptions in aligned columns.

Implementations

impl Help

pub fn new() -> Self

Create a new help widget with no entries.

pub fn entry(self, key: impl Into<String>, desc: impl Into<String>) -> Self

Add an entry to the help widget.

pub fn with_entry(self, entry: HelpEntry) -> Self

Add a pre-built entry.

pub fn with_entries(self, entries: Vec<HelpEntry>) -> Self

Set all entries at once.

pub fn with_mode(self, mode: HelpMode) -> Self

Set the display mode.

pub fn with_separator(self, sep: impl Into<String>) -> Self

Set the separator used between entries in short mode.

pub fn with_ellipsis(self, ellipsis: impl Into<String>) -> Self

Set the ellipsis string.

pub fn with_key_style(self, style: Style) -> Self

Set the style for key text.

pub fn with_desc_style(self, style: Style) -> Self

Set the style for description text.

pub fn with_separator_style(self, style: Style) -> Self

Set the style for separators and ellipsis.

pub fn entries(&self) -> &[HelpEntry]

Get the entries.

pub fn mode(&self) -> HelpMode

Get the current mode.

pub fn toggle_mode(&mut self)

Toggle between short and full mode.

pub fn push_entry(&mut self, entry: HelpEntry)

Add an entry mutably.

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 StatefulWidget for Help

type State = HelpRenderState

The state type associated with this widget.

fn render(&self, area: Rect, frame: &mut Frame<'_>, state: &mut HelpRenderState)

Render the widget into the frame, potentially modifying state.

impl Widget for Help

fn render(&self, area: Rect, frame: &mut Frame<'_>)

Render the widget into the frame at the given area.

fn is_essential(&self) -> bool

Whether this widget is essential and should always render.