mirror of
https://github.com/ratatui-org/ratatui
synced 2024-09-20 06:31:59 +00:00
ed51c4b342
These are simple opinionated methods for creating a terminal that is
useful to use in most apps. The new init method creates a crossterm
backend writing to stdout, enables raw mode, enters the alternate
screen, and sets a panic handler that restores the terminal on panic.
A minimal hello world now looks a bit like:
```rust
use ratatui::{
crossterm::event::{self, Event},
text::Text,
Frame,
};
fn main() {
let mut terminal = ratatui::init();
loop {
terminal
.draw(|frame: &mut Frame| frame.render_widget(Text::raw("Hello World!"), frame.area()))
.expect("Failed to draw");
if matches!(event::read().expect("failed to read event"), Event::Key(_)) {
break;
}
}
ratatui::restore();
}
```
A type alias `DefaultTerminal` is added to represent this terminal
type and to simplify any cases where applications need to pass this
terminal around. It is equivalent to:
`Terminal<CrosstermBackend<Stdout>>`
We also added `ratatui::try_init()` and `try_restore()`, for situations
where you might want to handle initialization errors yourself instead
of letting the panic handler fire and cleanup. Simple Apps should
prefer the `init` and `restore` functions over these functions.
Corresponding functions to allow passing a `TerminalOptions` with
a `Viewport` (e.g. inline, fixed) are also available
(`init_with_options`,
and `try_init_with_options`).
The existing code to create a backend and terminal will remain and
is not deprecated by this approach. This just provides a simple one
line initialization using the common options.
---------
Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
69 lines
2 KiB
Rust
69 lines
2 KiB
Rust
//! # [Ratatui] Logo example
|
|
//!
|
|
//! The latest version of this example is available in the [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
|
|
//! [examples]: https://github.com/ratatui/ratatui/blob/main/examples
|
|
//! [examples readme]: https://github.com/ratatui/ratatui/blob/main/examples/README.md
|
|
|
|
use std::{
|
|
io::{self},
|
|
thread::sleep,
|
|
time::Duration,
|
|
};
|
|
|
|
use indoc::indoc;
|
|
use itertools::izip;
|
|
use ratatui::{widgets::Paragraph, TerminalOptions, Viewport};
|
|
|
|
/// A fun example of using half block characters to draw a logo
|
|
#[allow(clippy::many_single_char_names)]
|
|
fn logo() -> String {
|
|
let r = indoc! {"
|
|
▄▄▄
|
|
█▄▄▀
|
|
█ █
|
|
"};
|
|
let a = indoc! {"
|
|
▄▄
|
|
█▄▄█
|
|
█ █
|
|
"};
|
|
let t = indoc! {"
|
|
▄▄▄
|
|
█
|
|
█
|
|
"};
|
|
let u = indoc! {"
|
|
▄ ▄
|
|
█ █
|
|
▀▄▄▀
|
|
"};
|
|
let i = indoc! {"
|
|
▄
|
|
█
|
|
█
|
|
"};
|
|
izip!(r.lines(), a.lines(), t.lines(), u.lines(), i.lines())
|
|
.map(|(r, a, t, u, i)| format!("{r:5}{a:5}{t:4}{a:5}{t:4}{u:5}{i:5}"))
|
|
.collect::<Vec<_>>()
|
|
.join("\n")
|
|
}
|
|
|
|
fn main() -> io::Result<()> {
|
|
let mut terminal = ratatui::init_with_options(TerminalOptions {
|
|
viewport: Viewport::Inline(3),
|
|
});
|
|
terminal.draw(|frame| frame.render_widget(Paragraph::new(logo()), frame.area()))?;
|
|
sleep(Duration::from_secs(5));
|
|
ratatui::restore();
|
|
println!();
|
|
Ok(())
|
|
}
|