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

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

fn key(code: KeyCode, modifiers: KeyModifiers) -> Event {
    Event::Key(KeyEventData::from_crossterm(KeyEvent::new(code, modifiers)))
}

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

    let mut input = Input::new().with_placeholder("name");
    input.set_focus(true);

    let key =
        KeyEventData::from_crossterm(KeyEvent::new(KeyCode::Char('a'), KeyModifiers::empty()));
    input.on_event(&Event::Key(key), &mut EventCtx::default());

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

#[test]
fn input_shift_selection_then_backspace_deletes_selected_text() {
    let mut input = Input::new();
    input.set_focus(true);
    input.set_text("hello world");

    input.on_event(
        &key(KeyCode::End, KeyModifiers::NONE),
        &mut EventCtx::default(),
    );
    input.on_event(
        &key(KeyCode::Left, KeyModifiers::SHIFT),
        &mut EventCtx::default(),
    );
    input.on_event(
        &key(KeyCode::Backspace, KeyModifiers::NONE),
        &mut EventCtx::default(),
    );

    assert_eq!(input.text(), "hello worl");
}

#[test]
fn input_ctrl_backspace_deletes_previous_word() {
    let mut input = Input::new();
    input.set_focus(true);
    input.set_text("alpha beta");
    input.on_event(
        &key(KeyCode::End, KeyModifiers::NONE),
        &mut EventCtx::default(),
    );
    input.on_event(
        &key(KeyCode::Backspace, KeyModifiers::CONTROL),
        &mut EventCtx::default(),
    );

    assert_eq!(input.text(), "alpha ");
}

#[test]
fn input_super_left_and_alt_backspace_shortcuts_work() {
    let mut input = Input::new();
    input.set_focus(true);
    input.set_text("alpha beta");
    input.on_event(
        &key(KeyCode::End, KeyModifiers::NONE),
        &mut EventCtx::default(),
    );
    input.on_event(
        &key(KeyCode::Left, KeyModifiers::SUPER),
        &mut EventCtx::default(),
    );
    input.on_event(
        &key(KeyCode::Char('Z'), KeyModifiers::NONE),
        &mut EventCtx::default(),
    );
    assert_eq!(input.text(), "Zalpha beta");

    input.set_text("alpha beta");
    input.on_event(
        &key(KeyCode::End, KeyModifiers::NONE),
        &mut EventCtx::default(),
    );
    input.on_event(
        &key(KeyCode::Backspace, KeyModifiers::ALT),
        &mut EventCtx::default(),
    );
    assert_eq!(input.text(), "alpha ");
}