Struct NavigationHelper 

pub struct NavigationHelper<'a> { /* private fields */ }

Helper for widgets to check navigation keys against configured bindings.

Pass this to widgets so they can respect configured key bindings instead of hardcoding key codes.

Example

fn handle_key(&mut self, key: KeyEvent, ctx: &WidgetKeyContext) -> WidgetKeyResult {
    if ctx.nav.is_move_up(&key) {
        self.select_previous();
        WidgetKeyResult::Handled
    } else if ctx.nav.is_move_down(&key) {
        self.select_next();
        WidgetKeyResult::Handled
    } else if ctx.nav.is_select(&key) {
        // Handle selection
    } else if ctx.nav.is_cancel(&key) {
        // Handle cancel
    } else {
        WidgetKeyResult::NotHandled
    }
}

Implementations

impl<'a> NavigationHelper<'a>

pub fn new(bindings: &'a KeyBindings) -> Self

Create a new navigation helper from key bindings.

pub fn is_move_up(&self, key: &KeyEvent) -> bool

Check if the key matches the move up binding.

pub fn is_move_down(&self, key: &KeyEvent) -> bool

Check if the key matches the move down binding.

pub fn is_move_left(&self, key: &KeyEvent) -> bool

Check if the key matches the move left binding.

pub fn is_move_right(&self, key: &KeyEvent) -> bool

Check if the key matches the move right binding.

pub fn is_select(&self, key: &KeyEvent) -> bool

Check if the key matches the select binding (Enter, Space).

pub fn is_cancel(&self, key: &KeyEvent) -> bool

Check if the key matches the cancel binding (Esc).

pub fn is_submit(&self, key: &KeyEvent) -> bool

Check if the key matches the submit binding (Enter).