rnk 0.19.1

A React-like declarative terminal UI framework for Rust, inspired by Ink and Bubbletea
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

//! Help component demo - Display keyboard shortcuts
//!
//! Run: cargo run --example help_demo

use rnk::components::{
    Help, HelpStyle, KeyBinding, editor_help, navigation_help, vim_navigation_help,
};
use rnk::core::Color;

fn main() {
    println!("=== Help Component Demo ===\n");

    // KeyBinding API
    println!("--- KeyBinding API ---");
    let binding = KeyBinding::new("Ctrl+C", "Copy to clipboard");
    println!(
        "  KeyBinding {{ key: {:?}, description: {:?} }}",
        binding.key, binding.description
    );
    println!();

    // Help component creation
    println!("--- Help Component ---");
    let help = Help::new(vec![
        KeyBinding::new("↑/↓", "Navigate"),
        KeyBinding::new("Enter", "Select"),
        KeyBinding::new("q", "Quit"),
    ]);
    println!("  bindings: {}", help.len());
    println!("  is_empty: {}", help.is_empty());
    println!("  is_visible: {}", help.is_visible());
    println!();

    // From tuples
    println!("--- From Tuples ---");
    let help = Help::from_tuples([("↑/↓", "Navigate"), ("Enter", "Select"), ("Esc", "Cancel")]);
    println!("  Help::from_tuples([...]) -> {} bindings", help.len());
    println!();

    // Builder pattern
    println!("--- Builder Pattern ---");
    let help = Help::new(vec![])
        .binding("j/k", "Navigate")
        .binding("Enter", "Select")
        .binding("q", "Quit")
        .single_line();
    println!("  Help::new(vec![]).binding(...).binding(...).single_line()");
    println!("  bindings: {}", help.len());
    println!();

    // Display modes
    println!("--- Display Modes ---");
    println!("  HelpMode::SingleLine - All bindings on one line");
    println!("  HelpMode::MultiLine  - Each binding on its own line");
    println!("  HelpMode::TwoColumn  - Aligned key-description columns");
    println!();

    // Style configuration
    println!("--- HelpStyle ---");
    let style = HelpStyle::new()
        .key_color(Color::Cyan)
        .description_color(Color::BrightBlack)
        .separator(": ")
        .binding_separator("  |  ")
        .key_bold(true)
        .description_dim(true);
    println!("  key_color: {:?}", style.key_color);
    println!("  description_color: {:?}", style.description_color);
    println!("  separator: {:?}", style.separator);
    println!("  binding_separator: {:?}", style.binding_separator);
    println!("  key_bold: {}", style.key_bold);
    println!("  description_dim: {}", style.description_dim);
    println!();

    // Preset bindings
    println!("--- Preset Bindings ---");
    println!("navigation_help():");
    for b in navigation_help() {
        println!("  {} - {}", b.key, b.description);
    }
    println!();

    println!("vim_navigation_help():");
    for b in vim_navigation_help() {
        println!("  {} - {}", b.key, b.description);
    }
    println!();

    println!("editor_help():");
    for b in editor_help() {
        println!("  {} - {}", b.key, b.description);
    }
    println!();

    // Visual representation
    println!("--- Visual Representation ---");
    println!("  (what it would look like in a TUI app)\n");

    println!("  SingleLine mode:");
    println!(
        "  \x1b[1;36m↑/↓\x1b[0m \x1b[90mNavigate\x1b[0m  •  \x1b[1;36mEnter\x1b[0m \x1b[90mSelect\x1b[0m  •  \x1b[1;36mq\x1b[0m \x1b[90mQuit\x1b[0m"
    );
    println!();

    println!("  MultiLine mode:");
    println!("  \x1b[1;36m↑/↓\x1b[0m   \x1b[90mNavigate\x1b[0m");
    println!("  \x1b[1;36mEnter\x1b[0m \x1b[90mSelect\x1b[0m");
    println!("  \x1b[1;36mq\x1b[0m     \x1b[90mQuit\x1b[0m");
    println!();

    // Usage example
    println!("--- Usage in TUI App ---");
    println!("```rust");
    println!("use rnk::components::{{Help, KeyBinding}};");
    println!();
    println!("fn app() -> Element {{");
    println!("    Help::new(vec![");
    println!("        KeyBinding::new(\"↑/↓\", \"Navigate\"),");
    println!("        KeyBinding::new(\"Enter\", \"Select\"),");
    println!("        KeyBinding::new(\"q\", \"Quit\"),");
    println!("    ])");
    println!("    .single_line()");
    println!("    .into_element()");
    println!("}}");
    println!("```");
}