mirror of
https://github.com/ratatui/ratatui.git
synced 2025-09-28 13:31:14 +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))?;
```
77 lines
2.6 KiB
Rust
77 lines
2.6 KiB
Rust
//! # [Ratatui] `Block` 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::{Style, Stylize};
|
|
use ratatui::text::{Line, Span};
|
|
use ratatui::widgets::{Block, BorderType};
|
|
|
|
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 blocks.
|
|
fn render(frame: &mut Frame) {
|
|
let vertical = Layout::vertical([Constraint::Length(1), Constraint::Fill(1)]).spacing(1);
|
|
let horizontal = Layout::horizontal([Constraint::Percentage(33); 3]).spacing(1);
|
|
let [top, main] = vertical.areas(frame.area());
|
|
let [left, middle, right] = horizontal.areas(main);
|
|
|
|
let title = Line::from_iter([
|
|
Span::from("Block Widget").bold(),
|
|
Span::from(" (Press 'q' to quit)"),
|
|
]);
|
|
frame.render_widget(title.centered(), top);
|
|
|
|
render_bordered_block(frame, left);
|
|
render_styled_block(frame, middle);
|
|
render_custom_bordered_block(frame, right);
|
|
}
|
|
|
|
/// Render a block with borders.
|
|
pub fn render_bordered_block(frame: &mut Frame, area: Rect) {
|
|
let block = Block::bordered().title("Bordered block");
|
|
frame.render_widget(block, area);
|
|
}
|
|
|
|
/// Render a styled block.
|
|
pub fn render_styled_block(frame: &mut Frame, area: Rect) {
|
|
let block = Block::bordered()
|
|
.style(Style::new().blue().on_black().bold().italic())
|
|
.title("Styled block");
|
|
frame.render_widget(block, area);
|
|
}
|
|
|
|
/// Render a block with custom borders.
|
|
pub fn render_custom_bordered_block(frame: &mut Frame, area: Rect) {
|
|
let block = Block::bordered()
|
|
.border_type(BorderType::Rounded)
|
|
.border_style(Style::new().red())
|
|
.title("Custom borders");
|
|
frame.render_widget(block, area);
|
|
}
|