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

use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};
use rich_rs::Console;
use textual::event::MouseDownEvent;
use textual::message::MessageEvent;
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 welcome_renders_title_and_close_button() {
    let console = Console::new();
    let options = options_for(&console, 72, 12);
    let mut welcome = Welcome::new();
    welcome.on_layout(72, 12);

    let buf = FrameBuffer::from_renderable(&console, &options, &welcome, None);
    let lines = buf.as_plain_lines();

    assert!(lines.iter().any(|line| line.contains("Welcome!")));
    assert!(lines.iter().any(|line| line.contains("OK")));
}

#[test]
fn welcome_re_emits_button_press_from_widget_sender() {
    let mut welcome = Welcome::new();
    welcome.on_layout(48, 10);

    let mut ctx = EventCtx::default();
    welcome.on_message(
        &MessageEvent {
            sender: welcome.close_button_id(),
            message: Message::ButtonPressed(ButtonPressed {
                description: "Button(classes='button', variant='success')".to_string(),
                button_id: None,
            }),
            control: None,
        },
        &mut ctx,
    );
    assert!(ctx.handled());
}

#[test]
fn welcome_key_press_is_forwarded_to_close_button() {
    let mut welcome = Welcome::new();
    welcome.set_focus(true);
    welcome.on_layout(48, 10);

    let enter = KeyEventData::from_crossterm(KeyEvent::new(KeyCode::Enter, KeyModifiers::NONE));
    let mut ctx = EventCtx::default();
    welcome.on_event(&Event::Key(enter), &mut ctx);

    assert!(ctx.handled());
}

#[test]
fn welcome_resize_updates_close_row_hit_testing() {
    let mut welcome = Welcome::new();
    welcome.on_layout(32, 6);
    welcome.on_resize(32, 2);

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

    assert!(ctx.handled());
}

#[test]
fn welcome_single_row_layout_routes_mouse_to_close_button() {
    let mut welcome = Welcome::new();
    welcome.on_layout(32, 1);

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

    assert!(ctx.handled());
}

#[test]
fn welcome_clears_hover_state_on_unmount() {
    let mut welcome = Welcome::new();
    welcome.on_layout(32, 6);
    welcome.set_hovered(true);
    assert!(welcome.is_hovered());

    welcome.on_unmount();
    assert!(!welcome.is_hovered());
}

#[test]
fn welcome_unmount_resets_focus_and_hover_lifecycle_state() {
    let mut welcome = Welcome::new();
    welcome.on_layout(32, 6);
    welcome.set_focus(true);
    welcome.set_hovered(true);

    welcome.on_unmount();

    assert!(!welcome.has_focus());
    assert!(!welcome.is_hovered());
}