textual 1.0.0-dev

A reactive TUI framework inspired by the Python Textual library
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

use rich_rs::Console;
use textual::prelude::*;
use textual::render::FrameBuffer;

fn options_for(console: &Console, width: usize, height: usize) -> rich_rs::ConsoleOptions {
    let mut options = console.options().clone();
    options.size = (width, height);
    options.max_width = width;
    options.max_height = height;
    options
}

#[test]
fn key_panel_renders_bindings() {
    let console = Console::new();
    let options = options_for(&console, 32, 4);
    let panel = KeyPanel::new().with_bindings(vec![
        FooterBinding::new("^q", "Quit application"),
        FooterBinding::new("⇥", "Focus next"),
    ]);

    let buf = FrameBuffer::from_renderable(&console, &options, &panel, None);
    let lines = buf.as_plain_lines();
    assert!(lines.iter().any(|line| line.contains("^q")));
    assert!(lines.iter().any(|line| line.contains("Quit application")));
}

#[test]
fn key_panel_scrolls_with_actions() {
    let console = Console::new();
    let options = options_for(&console, 36, 3);
    let mut panel = KeyPanel::new().with_bindings(vec![
        FooterBinding::new("a", "one"),
        FooterBinding::new("b", "two"),
        FooterBinding::new("c", "three"),
        FooterBinding::new("d", "four"),
    ]);

    let before = FrameBuffer::from_renderable(&console, &options, &panel, None);
    let before_lines = before.as_plain_lines();
    assert!(before_lines.iter().all(|line| !line.contains("four")));

    panel.on_event(&Event::Action(Action::ScrollDown), &mut EventCtx::default());
    panel.on_event(&Event::Action(Action::ScrollDown), &mut EventCtx::default());
    panel.on_event(&Event::Action(Action::ScrollDown), &mut EventCtx::default());

    let after = FrameBuffer::from_renderable(&console, &options, &panel, None);
    let after_lines = after.as_plain_lines();
    assert!(after_lines.iter().any(|line| line.contains("four")));
}

#[test]
fn key_panel_updates_on_bindings_changed_event() {
    let console = Console::new();
    let options = options_for(&console, 36, 4);
    let mut panel = KeyPanel::new().with_bindings(vec![FooterBinding::new("a", "alpha")]);

    panel.on_event(
        &Event::BindingsChanged(vec![BindingHint::new("x, y", "Updated action")]),
        &mut EventCtx::default(),
    );

    let buf = FrameBuffer::from_renderable(&console, &options, &panel, None);
    let lines = buf.as_plain_lines();
    assert!(lines.iter().any(|line| line.contains("x y")));
    assert!(lines.iter().any(|line| line.contains("Updated action")));
}

#[test]
fn bindings_table_layout_height_matches_row_count_without_synthetic_header() {
    let table = BindingsTable::new().with_bindings(vec![
        FooterBinding::new("a", "one"),
        FooterBinding::new("b", "two"),
    ]);
    assert_eq!(table.layout_height(), Some(2));
}

#[test]
fn key_panel_does_not_consume_scroll_actions_without_overflow() {
    let mut panel = KeyPanel::new().with_bindings(vec![FooterBinding::new("a", "alpha")]);
    let mut ctx = EventCtx::default();
    panel.on_event(&Event::Action(Action::ScrollDown), &mut ctx);
    assert!(!ctx.handled());
}

#[test]
fn key_panel_supports_scrollbar_drag() {
    let console = Console::new();
    let options = options_for(&console, 32, 6);
    let bindings = (1..=16)
        .map(|index| FooterBinding::new(format!("k{index:02}"), format!("item {index:02}")))
        .collect::<Vec<_>>();
    let mut panel = KeyPanel::new().with_bindings(bindings);

    let before = FrameBuffer::from_renderable(&console, &options, &panel, None);
    let before_lines = before.as_plain_lines();
    assert!(before_lines.iter().all(|line| !line.contains("item 16")));

    let _ = panel.take_composed_children();
    let _ = panel.render(&console, &options);

    let mut ctx = EventCtx::default();
    panel.on_message(
        &MessageEvent {
            sender: NodeId::default(),
            message: Message::ScrollbarScrollTo(ScrollbarScrollTo {
                axis: ScrollbarAxis::Vertical,
                offset: 10.0,
                animate: false,
                scroll_duration: None,
            }),
            control: None,
        },
        &mut ctx,
    );
    assert!(ctx.handled());
    assert!(ctx.repaint_requested());

    let after = FrameBuffer::from_renderable(&console, &options, &panel, None);
    let after_lines = after.as_plain_lines();
    assert!(after_lines.iter().any(|line| line.contains("item 16")));
}