mirror of
https://github.com/ratatui/ratatui.git
synced 2025-09-27 13:01:13 +00:00
6dcd53bc6b
This commit introduces new methods for the `Rect` struct that simplify
the process of splitting a `Rect` into sub-rects according to a given
`Layout`. By putting these methods on the `Rect` struct, we make it a
bit more natural that a layout is applied to the `Rect` itself, rather
than passing a `Rect` to the `Layout` struct to be split.
Adds:
- `Rect::layout` and `Rect::try_layout` methods that allow splitting a
`Rect` into an array of sub-rects according to a given `Layout`.
- `Rect::layout_vec` method that returns a `Vec` of sub-rects.
- `Layout::try_areas` method that returns an array of sub-rects, with
compile-time checks for the number of constraints. This is added
mainly for consistency with the new `Rect` methods.
```rust
use ratatui_core::layout::{Layout, Constraint, Rect};
let area = Rect::new(0, 0, 10, 10);
let layout = Layout::vertical([Constraint::Fill(1); 2]);
// Rect::layout() infers the number of constraints at compile time:
let [top, main] = area.layout(&layout);
// Rect::try_layout() and Layout::try_areas() do the same, but return a
// Result:
let [top, main] = area.try_layout(&layout)?;
let [top, main] = layout.try_areas(area)?;
// Rect::layout_vec() returns a Vec of sub-rects:
let areas_vec = area.layout_vec(&layout);
// you can also explicitly specify the number of constraints:
let areas = area.layout::<2>(&layout);
let areas = area.try_layout::<2>(&layout)?;
let areas = layout.try_areas::<2>(area)?;
```
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 layout = Layout::vertical([Constraint::Length(1), Constraint::Fill(1)]);
|
|
let [top, bottom] = frame.area().layout(&layout);
|
|
|
|
frame.render_widget("Powered by", top);
|
|
frame.render_widget(RatatuiLogo::new(size), bottom);
|
|
}
|