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

use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};
use rich_rs::Console;
use textual::event::{MouseDownEvent, MouseUpEvent};
use textual::prelude::*;
use textual::render::FrameBuffer;

#[test]
fn checkbox_toggles_from_keyboard_and_emits_message() {
    let console = Console::new();
    let mut options = console.options().clone();
    options.size = (16, 1);
    options.max_width = 16;
    options.max_height = 1;

    let mut checkbox = Checkbox::new("remember me");
    checkbox.set_focus(true);

    let key =
        KeyEventData::from_crossterm(KeyEvent::new(KeyCode::Char(' '), KeyModifiers::empty()));
    let mut ctx = EventCtx::default();
    checkbox.on_event(&Event::Key(key), &mut ctx);
    assert!(ctx.handled());
    assert!(checkbox.checked());

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

#[test]
fn checkbox_click_activates_only_on_mouse_up_over_target() {
    let mut checkbox = Checkbox::new("remember me");
    let id = NodeId::default();
    checkbox.set_focus(true);
    checkbox.set_hovered(true);

    let mut ctx = EventCtx::default();
    checkbox.on_event(
        &Event::MouseDown(MouseDownEvent {
            target: id,
            screen_x: 0,
            screen_y: 0,
            x: 0,
            y: 0,
        }),
        &mut ctx,
    );
    assert!(ctx.handled());
    assert!(!checkbox.checked());

    let mut ctx = EventCtx::default();
    checkbox.on_event(
        &Event::MouseUp(MouseUpEvent {
            target: Some(id),
            screen_x: 0,
            screen_y: 0,
            x: 0,
            y: 0,
        }),
        &mut ctx,
    );
    assert!(ctx.handled());
    assert!(checkbox.checked());
}

#[test]
fn checkbox_disabled_ignores_input() {
    let mut checkbox = Checkbox::new("remember me").disabled(true);
    checkbox.set_focus(true);
    let key = KeyEventData::from_crossterm(KeyEvent::new(KeyCode::Char(' '), KeyModifiers::NONE));
    let mut ctx = EventCtx::default();
    checkbox.on_event(&Event::Key(key), &mut ctx);
    assert!(!checkbox.checked());
    assert!(!ctx.handled());
}