Trait WidgetKeyHelp 

pub trait WidgetKeyHelp {
    // Required method
    fn key_help(&self) -> &'static [(&'static str, &'static str)];
}

Opt-in trait for users to publish a widget’s keymap to the framework so Context::keymap_help_overlay can list it on ? press (issue #236).

Scope

SLT does not implement this on built-in widgets — it is a user-facing extension point. Built-in widgets register their bindings directly inside their impl Context::* methods. To publish the keymap of your own custom widget, implement this trait, then call Context::publish_keymap in your render method:

ctx.publish_keymap("my_widget", MyState::key_help(&state));

In other words, this trait is the same shape as std::fmt::Display: zero blanket / built-in impls; you opt in by implementing it on your own type. If you prefer a free-function call, [Context::publish_keymap] takes the same (name, &'static [...]) signature without the trait.

Format

The returned slice must be 'static — hardcode a const array per widget so the registration is allocation-free. Each tuple is (key_combo, description) using the same display style as Binding::display (e.g. "↑/k", "Ctrl+S", "PgDn").

Example

use slt::keymap::WidgetKeyHelp;

struct Counter;

impl WidgetKeyHelp for Counter {
    fn key_help(&self) -> &'static [(&'static str, &'static str)] {
        const HELP: &[(&str, &str)] = &[
            ("↑/k", "increment"),
            ("↓/j", "decrement"),
            ("r", "reset"),
        ];
        HELP
    }
}

let counter = Counter;
assert_eq!(counter.key_help().len(), 3);

Required Methods

fn key_help(&self) -> &'static [(&'static str, &'static str)]

Return the keyboard shortcuts for this widget.

Format: (key_combo, description).

Implementors