Struct PaginatorKeyMap 

pub struct PaginatorKeyMap {
    pub prev_page: Binding,
    pub next_page: Binding,
}

Key bindings for different actions within the paginator.

This structure defines the key bindings that control pagination navigation. It implements the KeyMap trait to provide help information for the paginator component.

Examples

use bubbletea_widgets::paginator::PaginatorKeyMap;
use bubbletea_widgets::key;

let keymap = PaginatorKeyMap::default();

// Create custom key bindings
let custom_keymap = PaginatorKeyMap {
    prev_page: key::new_binding(vec![
        key::with_keys_str(&["a", "left"]),
        key::with_help("a/←", "previous page"),
    ]),
    next_page: key::new_binding(vec![
        key::with_keys_str(&["d", "right"]),
        key::with_help("d/→", "next page"),
    ]),
};

Fields

prev_page: Binding

Key binding for navigating to the previous page. Default keys: PageUp, Left Arrow, ‘h’

next_page: Binding

Key binding for navigating to the next page. Default keys: PageDown, Right Arrow, ‘l’

Trait Implementations

impl Clone for PaginatorKeyMap

fn clone(&self) -> PaginatorKeyMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaginatorKeyMap

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

Formats the value using the given formatter.

impl Default for PaginatorKeyMap

fn default() -> Self

Creates default key bindings for paginator navigation.

The default key bindings are:

• Previous page: PageUp, Left Arrow, ‘h’
• Next page: PageDown, Right Arrow, ‘l’

These bindings are commonly used in terminal applications and provide both arrow key navigation and vim-style ‘h’/‘l’ keys.

Examples

use bubbletea_widgets::paginator::PaginatorKeyMap;
use bubbletea_widgets::key::KeyMap;

let keymap = PaginatorKeyMap::default();
let help = keymap.short_help();
assert_eq!(help.len(), 2); // prev and next bindings

impl KeyMap for PaginatorKeyMap

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

Returns key bindings for the short help view.

This provides the essential pagination key bindings that will be displayed in compact help views.

Returns

A vector containing references to the previous page and next page bindings.

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

Returns key bindings for the full help view.

This organizes all pagination key bindings into columns for display in expanded help views. Since pagination only has two keys, they’re grouped together in a single column.

Returns

A vector of vectors, where each inner vector represents a column of related key bindings.