mirror of
https://github.com/ratatui/ratatui.git
synced 2025-09-27 04:50:46 +00:00
2739391950
I was swayed by the arguments about this made by the compiler team In <https://github.com/rust-lang/compiler-team/issues/750> and decided to look at how this organization affects ratatui. I found this reduces the number of lines across the codebase by about 350 and makes the imports more readable and definitely more greppable as you usually only have to read a single line. I've found in the past that maintaining imports regularly leads to merge conflicts which have to be resolved by hand and this change should reduce the likelihood of that happening. Main change is in rustfmt.toml, and the rest is just the result of running `cargo xtask format`. While implementing this, cargo machete brings up that the various backend crates are unused by the example crates. The re-export of each backend crate under ratatui is to make it possible for libs that rely on a specific version of ratatui to use the same version of the backend crate. Apps in general should use the backend crate directly rather than through ratatui as this is less confusing. - Removes all usages of `ratatui::{crossterm, termion, termwiz}`` in the examples. - Adds the backend crate to the dependencies of the examples that use the backend crate directly.
101 lines
3.4 KiB
Rust
101 lines
3.4 KiB
Rust
//! # [Ratatui] `Paragraph` 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::{self, Event};
|
|
use ratatui::layout::{Alignment, Constraint, Layout, Rect};
|
|
use ratatui::style::{Color, Stylize};
|
|
use ratatui::text::{Line, Masked, Span};
|
|
use ratatui::widgets::{Paragraph, Wrap};
|
|
use ratatui::{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 text.
|
|
fn draw(frame: &mut Frame) {
|
|
let vertical = Layout::vertical([Constraint::Length(1), Constraint::Fill(1)]).spacing(1);
|
|
let horizontal = Layout::horizontal([Constraint::Percentage(50); 2]).spacing(1);
|
|
let [top, main] = vertical.areas(frame.area());
|
|
let [first, second] = horizontal.areas(main);
|
|
|
|
let title = Line::from_iter([
|
|
Span::from("Paragraph Widget").bold(),
|
|
Span::from(" (Press 'q' to quit)"),
|
|
]);
|
|
frame.render_widget(title.centered(), top);
|
|
|
|
render_centered_paragraph(frame, first);
|
|
render_wrapped_paragraph(frame, second);
|
|
}
|
|
|
|
/// Render a paragraph with centered text.
|
|
pub fn render_centered_paragraph(frame: &mut Frame, area: Rect) {
|
|
let text = "Centered text\nwith multiple lines.\nCheck out the recipe!";
|
|
let paragraph = Paragraph::new(text)
|
|
.style(Color::White)
|
|
.alignment(Alignment::Center);
|
|
|
|
frame.render_widget(paragraph, area);
|
|
}
|
|
|
|
/// Render a long paragraph that wraps text.
|
|
pub fn render_wrapped_paragraph(frame: &mut Frame, area: Rect) {
|
|
let paragraph = Paragraph::new(create_lines(area))
|
|
.style(Color::White)
|
|
.scroll((0, 0))
|
|
.wrap(Wrap { trim: true });
|
|
|
|
frame.render_widget(paragraph, area);
|
|
}
|
|
|
|
/// Returns the lines for the paragraph.
|
|
fn create_lines(area: Rect) -> Vec<Line<'static>> {
|
|
let short_line = "Slice, layer, and bake the vegetables. ";
|
|
let long_line = short_line.repeat((area.width as usize) / short_line.len() + 2);
|
|
vec![
|
|
"Recipe: Ratatouille".into(),
|
|
"Ingredients:".bold().into(),
|
|
Line::from_iter([
|
|
"Bell Peppers".into(),
|
|
", Eggplant".italic(),
|
|
", Tomatoes".bold(),
|
|
", Onion".into(),
|
|
]),
|
|
Line::from_iter([
|
|
"Secret Ingredient: ".underlined(),
|
|
Span::styled(Masked::new("herbs de Provence", '*'), Color::Red),
|
|
]),
|
|
"Instructions:".bold().yellow().into(),
|
|
long_line.green().italic().into(),
|
|
]
|
|
}
|