mirror of
https://github.com/ratatui/ratatui.git
synced 2025-09-27 13:01:13 +00:00
7ad9c29eac
With this PR any symbol (`&str`) can be used to render `filled` and `unfilled` parts of `LineGauge` now. Before that change, only [`symbols::line::Set`](https://docs.rs/ratatui/latest/ratatui/symbols/line/struct.Set.html) was accepted. Note: New methods are introduced to define those symbols: `filled_symbol` and `unfilled_symbol`. The method [`line_set`](https://docs.rs/ratatui/latest/ratatui/widgets/struct.LineGauge.html#method.line_set) is still there, but marked as `deprecated`. 
87 lines
2.7 KiB
Rust
87 lines
2.7 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 ratatui::{
|
|
crossterm::event::{self, Event},
|
|
layout::{Constraint, Layout, Rect},
|
|
style::{Modifier, Style, Stylize},
|
|
symbols,
|
|
text::{Line, Span},
|
|
widgets::{Gauge, LineGauge},
|
|
DefaultTerminal, Frame,
|
|
};
|
|
|
|
fn main() -> Result<()> {
|
|
color_eyre::install()?;
|
|
let terminal = ratatui::init();
|
|
let result = run(terminal);
|
|
ratatui::restore();
|
|
result
|
|
}
|
|
|
|
/// Run the application.
|
|
fn run(mut terminal: DefaultTerminal) -> Result<()> {
|
|
loop {
|
|
terminal.draw(draw)?;
|
|
if matches!(event::read()?, Event::Key(_)) {
|
|
break Ok(());
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Draw the UI with various progress bars.
|
|
fn draw(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);
|
|
}
|