mirror of
https://github.com/ratatui/ratatui.git
synced 2025-09-27 13:01:13 +00:00
7bc78bca1b
This introduces a new `ratatui::run()` method which runs a closure with
a terminal initialized with reasonable defaults for most applications.
This calls `ratatui::init()` before running the closure and
`ratatui::restore()` after the closure completes, and returns the result
of the closure.
A minimal hello world example using the new `ratatui::run()` method:
```rust
fn main() -> Result<(), Box<dyn std::error::Error>> {
ratatui::run(|terminal| {
loop {
terminal.draw(|frame| frame.render_widget("Hello World!", frame.area()))?;
if crossterm::event::read()?.is_key_press() {
break Ok(());
}
}
})
}
```
Of course, this also works both with apps that use free methods and
structs:
```rust
fn run(terminal: &mut DefaultTerminal) -> Result<(), AppError> { ... }
ratatui::run(run)?;
```
```rust
struct App { ... }
impl App {
fn new() -> Self { ... }
fn run(mut self, terminal: &mut DefaultTerminal) -> Result<(), AppError> { ... }
}
ratatui::run(|terminal| App::new().run(terminal))?;
```
85 lines
2.5 KiB
Rust
85 lines
2.5 KiB
Rust
//! # [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 vertical = Layout::vertical([Constraint::Length(1), Constraint::Fill(1)]).spacing(1);
|
|
let [top, main] = vertical.areas(frame.area());
|
|
|
|
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 a chart going upward.
|
|
pub fn render_chart(frame: &mut Frame, area: Rect) {
|
|
let dataset = Dataset::default()
|
|
.name("Stonks")
|
|
.marker(Marker::Braille)
|
|
.graph_type(GraphType::Line)
|
|
.style(Color::Blue)
|
|
.data(&[
|
|
(0.0, 1.0),
|
|
(1.0, 3.0),
|
|
(2.0, 0.5),
|
|
(3.0, 2.0),
|
|
(4.0, 0.8),
|
|
(5.0, 4.0),
|
|
(6.0, 1.0),
|
|
(7.0, 6.0),
|
|
(8.0, 3.0),
|
|
(10.0, 10.0),
|
|
]);
|
|
|
|
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, 10.0])
|
|
.labels(["0", "5", "10"]);
|
|
|
|
let chart = Chart::new(vec![dataset]).x_axis(x_axis).y_axis(y_axis);
|
|
frame.render_widget(chart, area);
|
|
}
|