Struct KeybindingHints 

pub struct KeybindingHints { /* private fields */ }

A keybinding hints widget with category grouping and context-aware filtering.

Supports two entry scopes:

• Global: shortcuts always visible regardless of context.
• Contextual: shortcuts shown only when show_context is enabled (typically when a particular widget has focus).

In HelpMode::Full mode with categories enabled, entries are grouped under category headers. In HelpMode::Short mode, entries are rendered inline.

Example

use ftui_widgets::help::{KeybindingHints, HelpCategory, KeyFormat};

let hints = KeybindingHints::new()
    .with_key_format(KeyFormat::Bracketed)
    .global_entry("q", "quit")
    .global_entry_categorized("Tab", "next", HelpCategory::Navigation)
    .contextual_entry_categorized("^s", "save", HelpCategory::File);

assert_eq!(hints.global_entries().len(), 2);
assert_eq!(hints.contextual_entries().len(), 1);

Implementations

impl KeybindingHints

pub fn new() -> Self

Create a new hints widget with no entries.

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

Add a global entry (always visible).

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

Add a global entry with a specific category.

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

Add a contextual entry (shown when context is active).

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

Add a contextual entry with a specific category.

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

Add a pre-built global entry.

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

Add a pre-built contextual entry.

pub fn with_key_format(self, format: KeyFormat) -> Self

Set the key display format.

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

Set the display mode.

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

Set whether contextual entries are shown.

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

Set whether category headers are shown in full mode.

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.

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

Set the style for category headers.

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

Set the separator string for short mode.

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

Get the global entries.

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

Get the contextual entries.

pub fn mode(&self) -> HelpMode

Get the current mode.

pub fn key_format(&self) -> KeyFormat

Get the key format.

pub fn toggle_mode(&mut self)

Toggle between short and full mode.

pub fn set_show_context(&mut self, show: bool)

Set whether contextual entries are shown (mutable).

pub fn visible_entries(&self) -> Vec<HelpEntry>

Collect visible entries, applying scope filter and key formatting.

Trait Implementations

impl Clone for KeybindingHints

fn clone(&self) -> KeybindingHints

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeybindingHints

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

Formats the value using the given formatter.

impl Default for KeybindingHints

fn default() -> Self

Returns the “default value” for a type.

impl Widget for KeybindingHints

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.