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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

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

#[test]
fn list_view_renders_selection() {
    let console = Console::new();
    let mut options = console.options().clone();
    options.size = (12, 3);
    options.max_width = 12;
    options.max_height = 3;

    let mut list = ListView::new(vec![
        "one".to_string(),
        "two".to_string(),
        "three".to_string(),
    ]);
    list.set_focus(true);
    list.set_selected(1);

    let buf = FrameBuffer::from_renderable(&console, &options, &list, None);
    insta::assert_snapshot!(buf.debug_dump());
}

#[test]
fn list_view_mouse_click_selects_row() {
    let mut list = ListView::new(vec![
        "one".to_string(),
        "two".to_string(),
        "three".to_string(),
        "four".to_string(),
    ]);
    list.on_layout(20, 3);
    let id = NodeId::default();
    let mut ctx = EventCtx::default();
    list.on_event(
        &Event::MouseDown(MouseDownEvent {
            target: id,
            screen_x: 0,
            screen_y: 1,
            x: 0,
            y: 1,
        }),
        &mut ctx,
    );
    assert!(ctx.handled());
    assert_eq!(list.selected(), 1);
}

#[test]
fn list_view_scroll_actions_keep_selection_visible() {
    let mut list = ListView::new((0..20).map(|idx| format!("item-{idx}")).collect());
    list.set_focus(true);
    list.on_layout(20, 4);
    let mut ctx = EventCtx::default();
    for _ in 0..7 {
        list.on_event(&Event::Action(Action::ScrollDown), &mut ctx);
    }
    assert_eq!(list.selected(), 7);

    let console = Console::new();
    let mut options = console.options().clone();
    options.size = (16, 4);
    options.max_width = 16;
    options.max_height = 4;
    let buf = FrameBuffer::from_renderable(&console, &options, &list, None);
    let lines = buf.as_plain_lines();
    assert!(lines.iter().any(|line| line.contains("item-7")));
}

#[test]
fn list_view_mouse_scroll_clamps_to_bounds() {
    let mut list = ListView::new((0..10).map(|idx| format!("item-{idx}")).collect());
    list.on_layout(20, 3);

    let mut ctx = EventCtx::default();
    list.on_mouse_scroll(0, 100, &mut ctx);
    assert!(ctx.handled());
    assert_eq!(list.offset(), 7);

    let mut ctx = EventCtx::default();
    list.on_mouse_scroll(0, -100, &mut ctx);
    assert!(ctx.handled());
    assert_eq!(list.offset(), 0);
}

#[test]
fn list_view_navigation_skips_disabled_items() {
    let mut list = ListView::new(vec![
        "one".to_string(),
        "two".to_string(),
        "three".to_string(),
    ]);
    list.set_item_disabled(1, true);
    list.set_focus(true);
    list.on_layout(20, 3);

    let mut ctx = EventCtx::default();
    list.on_event(&Event::Action(Action::ScrollDown), &mut ctx);
    assert_eq!(list.selected(), 2);
}

#[test]
fn list_view_mouse_click_ignores_disabled_items() {
    let mut list = ListView::new(vec![
        "one".to_string(),
        "two".to_string(),
        "three".to_string(),
    ]);
    list.set_item_disabled(1, true);
    list.on_layout(20, 3);

    let id = NodeId::default();
    let mut ctx = EventCtx::default();
    list.on_event(
        &Event::MouseDown(MouseDownEvent {
            target: id,
            screen_x: 0,
            screen_y: 1,
            x: 0,
            y: 1,
        }),
        &mut ctx,
    );

    assert!(!ctx.handled());
    assert_eq!(list.selected(), 0);
}

#[test]
fn list_view_all_disabled_rows_do_not_render_highlight_marker() {
    let console = Console::new();
    let mut options = console.options().clone();
    options.size = (12, 3);
    options.max_width = 12;
    options.max_height = 3;

    let mut list = ListView::new(vec![
        "one".to_string(),
        "two".to_string(),
        "three".to_string(),
    ]);
    list.set_item_disabled(0, true);
    list.set_item_disabled(1, true);
    list.set_item_disabled(2, true);

    let buf = FrameBuffer::from_renderable(&console, &options, &list, None);
    for line in buf.as_plain_lines() {
        assert!(!line.contains("›"));
    }
}