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))?;
```
78 lines
2.5 KiB
Rust
78 lines
2.5 KiB
Rust
//! # [Ratatui] `Gauge` 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::layout::{Constraint, Layout, Rect};
|
|
use ratatui::style::{Modifier, Style, Stylize};
|
|
use ratatui::text::{Line, Span};
|
|
use ratatui::widgets::{Gauge, LineGauge};
|
|
use ratatui::{Frame, symbols};
|
|
|
|
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 various progress bars.
|
|
fn render(frame: &mut Frame) {
|
|
let vertical = Layout::vertical([
|
|
Constraint::Length(1),
|
|
Constraint::Max(2),
|
|
Constraint::Fill(1),
|
|
])
|
|
.spacing(1);
|
|
let [top, first, second] = vertical.areas(frame.area());
|
|
|
|
let title = Line::from_iter([
|
|
Span::from("Gauge Widget").bold(),
|
|
Span::from(" (Press 'q' to quit)"),
|
|
]);
|
|
frame.render_widget(title.centered(), top);
|
|
|
|
render_gauge(frame, first);
|
|
render_line_gauge(frame, second);
|
|
}
|
|
|
|
/// Render a gauge with a custom style.
|
|
pub fn render_gauge(frame: &mut Frame, area: Rect) {
|
|
let gauge = Gauge::default()
|
|
.style(Modifier::BOLD)
|
|
.gauge_style(Style::new().blue().on_black())
|
|
.label("Year Progress")
|
|
.percent(80);
|
|
frame.render_widget(gauge, area);
|
|
}
|
|
|
|
/// Render a line gauge (compact progress bar).
|
|
pub fn render_line_gauge(frame: &mut Frame, area: Rect) {
|
|
let line_gauge = LineGauge::default()
|
|
.filled_style(Style::new().white().on_red().bold())
|
|
.unfilled_style(Style::new().gray().on_black())
|
|
.label("❤️ HP")
|
|
.ratio(0.42)
|
|
.filled_symbol(symbols::line::THICK_HORIZONTAL)
|
|
.unfilled_symbol(symbols::line::THICK_HORIZONTAL);
|
|
frame.render_widget(line_gauge, area);
|
|
}
|