Struct MasterLayoutKeyBindings 

pub struct MasterLayoutKeyBindings {
    pub quit: Vec<(KeyCode, KeyModifiers)>,
    pub clear_selection: (KeyCode, KeyModifiers),
    pub deselect_pane: (KeyCode, KeyModifiers),
    pub switch_tabs: Vec<(KeyCode, KeyModifiers)>,
    pub navigate_left: (KeyCode, KeyModifiers),
    pub navigate_right: (KeyCode, KeyModifiers),
    pub navigate_up: (KeyCode, KeyModifiers),
    pub navigate_down: (KeyCode, KeyModifiers),
    pub focus_pane: (KeyCode, KeyModifiers),
    pub exit_focus_mode: (KeyCode, KeyModifiers),
    pub copy_selection: (KeyCode, KeyModifiers),
}

Available on crate feature master-layout only.

Configurable key bindings for MasterLayout

This struct allows customization of all keyboard shortcuts used by MasterLayout. Each field represents a specific action and contains a tuple of (KeyCode, KeyModifiers).

Example

use ratatui_toolkit::master_layout::MasterLayoutKeyBindings;
use crossterm::event::{KeyCode, KeyModifiers};

let mut bindings = MasterLayoutKeyBindings::default();
// Change quit key from 'q' to 'x'
bindings.quit = vec![(KeyCode::Char('x'), KeyModifiers::empty())];

Fields

quit: Vec<(KeyCode, KeyModifiers)>

Keys to quit the application (default: q, Q)

clear_selection: (KeyCode, KeyModifiers)

Key to clear selection in Layout Mode (default: Esc)

deselect_pane: (KeyCode, KeyModifiers)

Key to deselect pane in Layout Mode (default: Ctrl+A)

switch_tabs: Vec<(KeyCode, KeyModifiers)>

Keys to switch tabs (default: 1-9)

navigate_left: (KeyCode, KeyModifiers)

Key to navigate left (default: h)

navigate_right: (KeyCode, KeyModifiers)

Key to navigate right (default: l)

navigate_up: (KeyCode, KeyModifiers)

Key to navigate up (default: k)

navigate_down: (KeyCode, KeyModifiers)

Key to navigate down (default: j)

focus_pane: (KeyCode, KeyModifiers)

Key to focus the selected pane (default: Enter)

exit_focus_mode: (KeyCode, KeyModifiers)

Key to exit focus mode (default: Ctrl+A)

copy_selection: (KeyCode, KeyModifiers)

Key to copy selection (default: Ctrl+Shift+C)

Implementations

impl MasterLayoutKeyBindings

pub fn get_tab_switch_index(&self, key: &KeyEvent) -> Option<usize>

Check if the given key event matches any tab switch key and return the tab index (0-based)

impl MasterLayoutKeyBindings

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

Check if the given key event matches the clear selection key

impl MasterLayoutKeyBindings

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

Check if the given key event matches the copy selection key

impl MasterLayoutKeyBindings

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

Check if the given key event matches the deselect pane key

impl MasterLayoutKeyBindings

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

Check if the given key event matches the exit focus mode key

impl MasterLayoutKeyBindings

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

Check if the given key event matches the focus pane key

impl MasterLayoutKeyBindings

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

Check if the given key event matches the navigate down key

impl MasterLayoutKeyBindings

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

Check if the given key event matches the navigate left key

impl MasterLayoutKeyBindings

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

Check if the given key event matches the navigate right key

impl MasterLayoutKeyBindings

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

Check if the given key event matches the navigate up key

impl MasterLayoutKeyBindings

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

Check if the given key event matches any of the quit keys

Trait Implementations

impl Clone for MasterLayoutKeyBindings

fn clone(&self) -> MasterLayoutKeyBindings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MasterLayoutKeyBindings

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

Formats the value using the given formatter.

impl Default for MasterLayoutKeyBindings

fn default() -> Self

Returns the “default value” for a type.