Struct TableKeyMap

pub struct TableKeyMap {
    pub row_up: Binding,
    pub row_down: Binding,
    pub page_up: Binding,
    pub page_down: Binding,
    pub half_page_up: Binding,
    pub half_page_down: Binding,
    pub go_to_start: Binding,
    pub go_to_end: Binding,
}

Keyboard binding configuration for table navigation.

This struct defines all the key combinations that control table navigation, including row-by-row movement, page scrolling, and jumping to start/end positions. Each binding can accept multiple key combinations and includes help text for documentation.

Key Binding Types

• Row Navigation: Single row up/down movement
• Page Navigation: Full page up/down scrolling
• Half Page Navigation: Half page up/down scrolling
• Jump Navigation: Instant movement to start/end

Examples

use bubbletea_widgets::table::{TableKeyMap, Model, Column};
use bubbletea_widgets::key;
use crossterm::event::KeyCode;

// Create table with custom key bindings
let mut table = Model::new(vec![Column::new("Data", 20)]);
table.keymap.row_up = key::Binding::new(vec![KeyCode::Char('w')])
    .with_help("w", "move up");
table.keymap.row_down = key::Binding::new(vec![KeyCode::Char('s')])
    .with_help("s", "move down");

Using with help system:

use bubbletea_widgets::table::Model;
use bubbletea_widgets::key::KeyMap as KeyMapTrait;

let table = Model::new(vec![]);
let help_bindings = table.keymap.short_help();
// Returns the most common navigation keys for display

Default Bindings

• Row Up: ↑ (Up Arrow), k (Vim style)
• Row Down: ↓ (Down Arrow), j (Vim style)
• Page Up: PgUp, b (Vim style)
• Page Down: PgDn, f (Vim style)
• Half Page Up: u (Vim style)
• Half Page Down: d (Vim style)
• Go to Start: Home, g (Vim style)
• Go to End: End, G (Vim style)

Fields

row_up: Binding

Key binding for moving selection up one row.

Default: Up arrow key (↑) and k key (Vim-style)

row_down: Binding

Key binding for moving selection down one row.

Default: Down arrow key (↓) and j key (Vim-style)

page_up: Binding

Key binding for moving up one full page of rows.

Default: Page Up key and b key (Vim-style)

page_down: Binding

Key binding for moving down one full page of rows.

Default: Page Down key and f key (Vim-style)

half_page_up: Binding

Key binding for moving up half a page of rows.

Default: u key (Vim-style)

half_page_down: Binding

Key binding for moving down half a page of rows.

Default: d key (Vim-style)

go_to_start: Binding

Key binding for jumping to the first row.

Default: Home key and g key (Vim-style)

go_to_end: Binding

Key binding for jumping to the last row.

Default: End key and G key (Vim-style)

Trait Implementations

impl Clone for TableKeyMap

fn clone(&self) -> TableKeyMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableKeyMap

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

Formats the value using the given formatter.

impl Default for TableKeyMap

fn default() -> Self

Creates default table key bindings with Vim-style navigation.

The default bindings provide both traditional arrow keys and Vim-style letter keys for maximum compatibility and user preference accommodation.

Default Key Mappings

Binding	Keys	Description
row_up	↑, k	Move selection up one row
row_down	↓, j	Move selection down one row
page_up	PgUp, b	Move up one page of rows
page_down	PgDn, f	Move down one page of rows
half_page_up	u	Move up half a page
half_page_down	d	Move down half a page
go_to_start	Home, g	Jump to first row
go_to_end	End, G	Jump to last row

Examples

use bubbletea_widgets::table::TableKeyMap;

// Using default key bindings
let keymap = TableKeyMap::default();

// Check if a binding includes specific help text
assert_eq!(keymap.row_up.help().key, "↑/k");
assert_eq!(keymap.row_up.help().desc, "up");

Design Philosophy

• Vim Compatibility: Letter keys follow Vim navigation patterns
• Arrow Key Support: Traditional navigation for all users
• Page Navigation: Efficient movement through large datasets
• Jump Commands: Quick access to start/end positions

impl KeyMap for TableKeyMap

fn short_help(&self) -> Vec<&Binding>

Returns a slice of bindings to be displayed in the short version of help.

fn full_help(&self) -> Vec<Vec<&Binding>>

Returns an extended group of help items, grouped by columns.