ratatui-widgets 0.3.1

A collection of Ratatui widgets for building terminal user interfaces using Ratatui.
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

//! # [Ratatui] `Chart` example
//!
//! The latest version of this example is available in the [widget examples] folder in the
//! repository.
//!
//! Please note that the examples are designed to be run against the `main` branch of the Github
//! repository. This means that you may not be able to compile with the latest release version on
//! crates.io, or the one that you have installed locally.
//!
//! See the [examples readme] for more information on finding examples that match the version of the
//! library you are using.
//!
//! [Ratatui]: https://github.com/ratatui/ratatui
//! [widget examples]: https://github.com/ratatui/ratatui/blob/main/ratatui-widgets/examples
//! [examples readme]: https://github.com/ratatui/ratatui/blob/main/examples/README.md

use color_eyre::Result;
use crossterm::event;
use ratatui::Frame;
use ratatui::layout::{Constraint, Layout, Rect};
use ratatui::style::{Color, Stylize};
use ratatui::symbols::Marker;
use ratatui::text::{Line, Span};
use ratatui::widgets::{Axis, Chart, Dataset, GraphType};

fn main() -> Result<()> {
    color_eyre::install()?;
    ratatui::run(|terminal| {
        loop {
            terminal.draw(render)?;
            if event::read()?.is_key_press() {
                break Ok(());
            }
        }
    })
}

/// Render the UI with a chart.
fn render(frame: &mut Frame) {
    let layout = Layout::vertical([Constraint::Length(1), Constraint::Fill(1)]).spacing(1);
    let [top, main] = frame.area().layout(&layout);

    let title = Line::from_iter([
        Span::from("Chart Widget").bold(),
        Span::from(" (Press 'q' to quit)"),
    ]);
    frame.render_widget(title.centered(), top);

    render_chart(frame, main);
}

/// Render 2 charts. 1st chart goes upward, 2nd chart goes downward and has filled area underneath.
pub fn render_chart(frame: &mut Frame, area: Rect) {
    let dataset_upward = Dataset::default()
        .name("Stonks")
        .marker(Marker::Braille)
        .graph_type(GraphType::Line)
        .style(Color::Blue)
        .data(&[
            (0.0, 10.0),
            (1.0, 14.0),
            (2.0, 12.0),
            (3.0, 15.0),
            (4.0, 12.5),
            (5.0, 16.0),
            (6.0, 13.0),
            (7.0, 18.0),
            (8.0, 17.0),
            (9.0, 19.0),
            (10.0, 20.0),
        ]);

    let dataset_downward = Dataset::default()
        .name("Not stonks")
        .marker(Marker::Braille)
        .graph_type(GraphType::Area)
        .fill_to_y(0.0)
        .style(Color::Red)
        .data(&[
            (0.0, 10.0),
            (1.0, 8.0),
            (2.0, 8.5),
            (3.0, 6.0),
            (4.0, 7.0),
            (5.0, 5.0),
            (6.0, 5.5),
            (7.0, 4.0),
            (8.0, 3.5),
            (9.0, 1.5),
            (10.0, 2.5),
        ]);

    let x_axis = Axis::default()
        .title("Hustle".blue())
        .bounds([0.0, 10.0])
        .labels(["0%", "50%", "100%"]);

    let y_axis = Axis::default()
        .title("Profit".blue())
        .bounds([0.0, 20.0])
        .labels(["0", "10", "20"]);

    let chart = Chart::new(vec![dataset_downward, dataset_upward])
        .x_axis(x_axis)
        .y_axis(y_axis);
    frame.render_widget(chart, area);
}