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))?;
```
59 lines
2.0 KiB
Rust
59 lines
2.0 KiB
Rust
//! # [Ratatui] `RatatuiLogo` 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 std::env::args;
|
|
|
|
use color_eyre::Result;
|
|
use crossterm::event;
|
|
use ratatui::layout::{Constraint, Layout};
|
|
use ratatui::widgets::{RatatuiLogo, RatatuiLogoSize};
|
|
use ratatui::{DefaultTerminal, Frame, TerminalOptions, Viewport};
|
|
|
|
fn main() -> Result<()> {
|
|
color_eyre::install()?;
|
|
let terminal = ratatui::init_with_options(TerminalOptions {
|
|
viewport: Viewport::Inline(3),
|
|
});
|
|
let size = match args().nth(1).as_deref() {
|
|
Some("small") => RatatuiLogoSize::Small,
|
|
Some("tiny") => RatatuiLogoSize::Tiny,
|
|
_ => RatatuiLogoSize::default(),
|
|
};
|
|
let result = run(terminal, size);
|
|
ratatui::restore();
|
|
println!();
|
|
result
|
|
}
|
|
|
|
/// Run the application.
|
|
fn run(mut terminal: DefaultTerminal, size: RatatuiLogoSize) -> Result<()> {
|
|
loop {
|
|
terminal.draw(|frame| render(frame, size))?;
|
|
if event::read()?.is_key_press() {
|
|
break Ok(());
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Render the UI with a logo.
|
|
fn render(frame: &mut Frame, size: RatatuiLogoSize) {
|
|
let [top, bottom] =
|
|
Layout::vertical([Constraint::Length(1), Constraint::Fill(1)]).areas(frame.area());
|
|
|
|
frame.render_widget("Powered by", top);
|
|
frame.render_widget(RatatuiLogo::new(size), bottom);
|
|
}
|