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

use rich_rs::{Segment, Style as RichStyle};
use textual::css::{StyleSheet, default_widget_stylesheet, set_style_context};
use textual::prelude::*;
use textual::runtime::{build_widget_tree_from_root, render_tree_to_frame};

fn help_panel() -> impl Widget {
    let title = Styled::new(
        Label::new("Press some keys!"),
        Style::new().bold(true).underline(true),
    );
    let content = Container::new().with_child(title).with_child(Label::new(
        "To quit the app press Ctrl+Q twice or press the Quit button below.",
    ));
    let boxed = Styled::new(
        content,
        Style::new()
            .line_pad(1)
            .border_top(Color::parse("#7f868d").unwrap())
            .border_right(Color::parse("#7f868d").unwrap())
            .border_bottom(Color::parse("#7f868d").unwrap())
            .border_left(Color::parse("#7f868d").unwrap()),
    );
    Constrained::new(boxed).min_height(4).max_height(4)
}

fn sample_log() -> RichLog {
    let key_style =
        RichStyle::new().with_color(Color::parse("#b73763").unwrap().to_simple_opaque());
    let field_style =
        RichStyle::new().with_color(Color::parse("#f5a623").unwrap().to_simple_opaque());
    let value_style =
        RichStyle::new().with_color(Color::parse("#98d168").unwrap().to_simple_opaque());
    let bool_style = RichStyle::new()
        .with_color(Color::parse("#b73763").unwrap().to_simple_opaque())
        .with_italic(true);

    let mut log = RichLog::new().max_lines(400).scroll_step(2);
    log.write_segments(vec![
        Segment::styled("Key".to_string(), key_style),
        Segment::new("(".to_string()),
        Segment::styled("key".to_string(), field_style),
        Segment::new("=".to_string()),
        Segment::styled("'a'".to_string(), value_style),
        Segment::new(", ".to_string()),
        Segment::styled("character".to_string(), field_style),
        Segment::new("=".to_string()),
        Segment::styled("'a'".to_string(), value_style),
        Segment::new(", ".to_string()),
        Segment::styled("name".to_string(), field_style),
        Segment::new("=".to_string()),
        Segment::styled("'a'".to_string(), value_style),
        Segment::new(", ".to_string()),
        Segment::styled("is_printable".to_string(), field_style),
        Segment::new("=".to_string()),
        Segment::styled("True".to_string(), bool_style),
        Segment::new(")".to_string()),
    ]);
    log.write("AppFocus: true");
    log
}

fn action_bar() -> impl Widget {
    let row = Row::new()
        .with_child(Constrained::new(Button::warning("Clear").flat(true)))
        .with_child(Constrained::new(Button::error("Quit").flat(true)));
    Constrained::new(row).min_height(3).max_height(3)
}

#[test]
fn keys_preview_layout_snapshot() {
    let repo_root = std::path::Path::new(env!("CARGO_MANIFEST_DIR"));
    let css_path = repo_root.join("docs/examples/widgets/examples/keys/keys.tcss");
    let css = std::fs::read_to_string(css_path).expect("read keys.tcss");
    let mut stylesheet = default_widget_stylesheet();
    stylesheet.extend(&StyleSheet::parse(&css));
    let _guard = set_style_context(stylesheet);

    let mut root = preview_root_with_top_bottom(
        Some("Textual Keys"),
        Some(4),
        help_panel(),
        sample_log(),
        Some(3),
        action_bar(),
    );

    let console = rich_rs::Console::new();
    let mut options = console.options().clone();
    options.size = (80, 16);
    options.max_width = 80;
    options.max_height = 16;
    let mut tree = build_widget_tree_from_root(&mut root).expect("tree should build");
    let buffer = render_tree_to_frame(&mut tree, &mut root, &console, 80, 16);
    insta::assert_snapshot!(buffer.debug_dump());
}