ratatui-toolkit 0.2.6

DEPRECATED: this crate was renamed to `ratkit`. Please migrate to `ratkit`.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

//! Hotkey footer component
//!
//! A styled hotkey footer bar component (aerospace-tui style)
//! Renders a single line with alternating hotkey/description pairs.

pub mod constructors;
pub mod methods;
pub mod traits;

use ratatui::style::Color;

/// A single hotkey with its description
#[derive(Clone, Debug)]
pub struct HotkeyItem {
    /// The key or key combination (e.g., "j/k", "Enter", "?")
    pub key: String,
    /// The description of what the key does (e.g., "scroll", "navigate", "help")
    pub description: String,
}

#[cfg(feature = "hotkey")]
impl From<crate::services::hotkey::Hotkey> for HotkeyItem {
    fn from(hotkey: crate::services::hotkey::Hotkey) -> Self {
        Self {
            key: hotkey.key,
            description: hotkey.description,
        }
    }
}

/// A styled hotkey footer bar component (aerospace-tui style)
#[derive(Clone, Debug)]
pub struct HotkeyFooter {
    /// List of hotkey items to display
    pub items: Vec<HotkeyItem>,
    /// Color for the hotkeys
    pub key_color: Color,
    /// Color for the descriptions
    pub description_color: Color,
    /// Background color for the footer
    pub background_color: Color,
}

/// Builder pattern for creating hotkey footers
pub struct HotkeyFooterBuilder {
    items: Vec<HotkeyItem>,
}