ratatui-core 0.1.0

Core types and traits for the Ratatui Terminal UI library. Widget libraries should use this crate. Applications should use the main Ratatui crate.
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

//! Integration tests for Rect operations visualized with buffers.

use ratatui_core::buffer::Buffer;
use ratatui_core::layout::{Margin, Offset, Rect};
use ratatui_core::widgets::Widget;

/// A minimal widget that fills its entire area with the given symbol.
struct Filled<'a> {
    symbol: &'a str,
}

impl Widget for Filled<'_> {
    fn render(self, area: Rect, buf: &mut Buffer) {
        for y in area.top()..area.bottom() {
            for x in area.left()..area.right() {
                if let Some(cell) = buf.cell_mut((x, y)) {
                    cell.set_symbol(self.symbol);
                }
            }
        }
    }
}

#[test]
fn inner() {
    let base = Rect::new(2, 2, 10, 6);
    let inner = base.inner(Margin::new(2, 1));

    let mut buf = Buffer::empty(Rect::new(0, 0, 15, 10));
    Filled { symbol: "█" }.render(base, &mut buf);
    Filled { symbol: "░" }.render(inner, &mut buf);

    let expected = Buffer::with_lines([
        "               ",
        "               ",
        "  ██████████   ",
        "  ██░░░░░░██   ",
        "  ██░░░░░░██   ",
        "  ██░░░░░░██   ",
        "  ██░░░░░░██   ",
        "  ██████████   ",
        "               ",
        "               ",
    ]);
    assert_eq!(buf, expected);
}

#[test]
fn outer() {
    let base = Rect::new(4, 3, 6, 4);
    let outer = base.outer(Margin::new(2, 1));

    let mut buf = Buffer::empty(Rect::new(0, 0, 15, 10));
    Filled { symbol: "░" }.render(outer, &mut buf);
    Filled { symbol: "█" }.render(base, &mut buf);

    let expected = Buffer::with_lines([
        "               ",
        "               ",
        "  ░░░░░░░░░░   ",
        "  ░░██████░░   ",
        "  ░░██████░░   ",
        "  ░░██████░░   ",
        "  ░░██████░░   ",
        "  ░░░░░░░░░░   ",
        "               ",
        "               ",
    ]);
    assert_eq!(buf, expected);
}

#[test]
fn offset() {
    let base = Rect::new(2, 2, 5, 3);
    let moved = base + Offset::new(4, 2);

    let mut buf = Buffer::empty(Rect::new(0, 0, 15, 10));
    Filled { symbol: "░" }.render(base, &mut buf);
    Filled { symbol: "█" }.render(moved, &mut buf);

    let expected = Buffer::with_lines([
        "               ",
        "               ",
        "  ░░░░░        ",
        "  ░░░░░        ",
        "  ░░░░█████    ",
        "      █████    ",
        "      █████    ",
        "               ",
        "               ",
        "               ",
    ]);
    assert_eq!(buf, expected);
}

#[test]
fn intersection() {
    let a = Rect::new(2, 2, 6, 4);
    let b = Rect::new(5, 3, 6, 4);
    let inter = a.intersection(b);

    let mut buf = Buffer::empty(Rect::new(0, 0, 15, 10));
    Filled { symbol: "░" }.render(a, &mut buf);
    Filled { symbol: "▒" }.render(b, &mut buf);
    Filled { symbol: "█" }.render(inter, &mut buf);

    let expected = Buffer::with_lines([
        "               ",
        "               ",
        "  ░░░░░░       ",
        "  ░░░███▒▒▒    ",
        "  ░░░███▒▒▒    ",
        "  ░░░███▒▒▒    ",
        "     ▒▒▒▒▒▒    ",
        "               ",
        "               ",
        "               ",
    ]);
    assert_eq!(buf, expected);
}

#[test]
fn clamp() {
    let area = Rect::new(2, 2, 10, 6);
    let rect = Rect::new(8, 5, 8, 4);
    let clamped = rect.clamp(area);

    let mut buf = Buffer::empty(Rect::new(0, 0, 20, 12));
    Filled { symbol: "█" }.render(area, &mut buf);
    Filled { symbol: "▒" }.render(rect, &mut buf);
    Filled { symbol: "░" }.render(clamped, &mut buf);

    let expected = Buffer::with_lines([
        "                    ",
        "                    ",
        "  ██████████        ",
        "  ██████████        ",
        "  ██░░░░░░░░        ",
        "  ██░░░░░░░░▒▒▒▒    ",
        "  ██░░░░░░░░▒▒▒▒    ",
        "  ██░░░░░░░░▒▒▒▒    ",
        "        ▒▒▒▒▒▒▒▒    ",
        "                    ",
        "                    ",
        "                    ",
    ]);
    assert_eq!(buf, expected);
}