ratatui_toolkit/primitives/split_layout/pane_layout/mod.rs
1//! Pane layout output for `SplitLayout`.
2//!
3//! Contains the pane identifier and its calculated rectangle.
4
5pub mod constructors;
6pub mod methods;
7
8use ratatui::layout::Rect;
9
10use crate::primitives::split_layout::PaneId;
11
12/// A computed rectangle for a pane.
13///
14/// Combines a pane identifier with the rectangle allocated by a split layout.
15///
16/// # Example
17/// ```rust
18/// use ratatui::layout::Rect;
19/// use ratatui_toolkit::primitives::split_layout::SplitLayout;
20///
21/// let layout = SplitLayout::new(1);
22/// let panes = layout.layout_panes(Rect::new(0, 0, 10, 5));
23/// let _ = panes[0].pane_id();
24/// ```
25#[derive(Debug, Clone, Copy, PartialEq, Eq)]
26pub struct PaneLayout {
27 pane_id: PaneId,
28 area: Rect,
29}