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)?;
```
95 lines
3.3 KiB
Rust
95 lines
3.3 KiB
Rust
//! # [Ratatui] `List` 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 crossterm::event::{self, KeyCode};
|
|
use ratatui::Frame;
|
|
use ratatui::layout::{Constraint, Layout, Rect};
|
|
use ratatui::style::{Color, Modifier, Style, Stylize};
|
|
use ratatui::text::{Line, Span};
|
|
use ratatui::widgets::{List, ListDirection, ListState};
|
|
|
|
fn main() -> color_eyre::Result<()> {
|
|
color_eyre::install()?;
|
|
|
|
let mut list_state = ListState::default().with_selected(Some(0));
|
|
ratatui::run(|terminal| {
|
|
loop {
|
|
terminal.draw(|frame| render(frame, &mut list_state))?;
|
|
if let Some(key) = event::read()?.as_key_press_event() {
|
|
match key.code {
|
|
KeyCode::Char('j') | KeyCode::Down => list_state.select_next(),
|
|
KeyCode::Char('k') | KeyCode::Up => list_state.select_previous(),
|
|
KeyCode::Char('q') | KeyCode::Esc => break Ok(()),
|
|
_ => {}
|
|
}
|
|
}
|
|
}
|
|
})
|
|
}
|
|
|
|
/// Render the UI with various lists.
|
|
fn render(frame: &mut Frame, list_state: &mut ListState) {
|
|
let constraints = [
|
|
Constraint::Length(1),
|
|
Constraint::Fill(1),
|
|
Constraint::Fill(1),
|
|
];
|
|
let layout = Layout::vertical(constraints).spacing(1);
|
|
let [top, first, second] = frame.area().layout(&layout);
|
|
|
|
let title = Line::from_iter([
|
|
Span::from("List Widget").bold(),
|
|
Span::from(" (Press 'q' to quit and arrow keys to navigate)"),
|
|
]);
|
|
frame.render_widget(title.centered(), top);
|
|
|
|
render_list(frame, first, list_state);
|
|
render_bottom_list(frame, second);
|
|
}
|
|
|
|
/// Render a list.
|
|
pub fn render_list(frame: &mut Frame, area: Rect, list_state: &mut ListState) {
|
|
let items = ["Item 1", "Item 2", "Item 3", "Item 4"];
|
|
let list = List::new(items)
|
|
.style(Color::White)
|
|
.highlight_style(Modifier::REVERSED)
|
|
.highlight_symbol("> ");
|
|
|
|
frame.render_stateful_widget(list, area, list_state);
|
|
}
|
|
|
|
/// Render a bottom-to-top list.
|
|
pub fn render_bottom_list(frame: &mut Frame, area: Rect) {
|
|
let items = [
|
|
"[Remy]: I'm building one now.\nIt even supports multiline text!",
|
|
"[Gusteau]: With enough passion, yes.",
|
|
"[Remy]: But can anyone build a TUI in Rust?",
|
|
"[Gusteau]: Anyone can cook!",
|
|
];
|
|
let list = List::new(items)
|
|
.style(Color::White)
|
|
.highlight_style(Style::new().yellow().italic())
|
|
.highlight_symbol("> ".red())
|
|
.scroll_padding(1)
|
|
.direction(ListDirection::BottomToTop)
|
|
.repeat_highlight_symbol(true);
|
|
|
|
let mut state = ListState::default();
|
|
state.select_first();
|
|
|
|
frame.render_stateful_widget(list, area, &mut state);
|
|
}
|