Struct ResizableGrid 

pub struct ResizableGrid {
    pub root_index: usize,
    pub nodes: Vec<LayoutNode>,
    pub next_pane_id: u32,
    pub hovered_split: Option<usize>,
    pub dragging_split: Option<usize>,
    pub hit_threshold: u16,
}

A grid-based layout for arranging multiple resizable panes.

Grid layouts support hierarchical splits in both horizontal and vertical directions, enabling complex multi-pane arrangements.

Example

use ratatui_toolkit::primitives::resizable_grid::ResizableGrid;

let mut grid = ResizableGrid::new(0);

Fields

root_index: usize

nodes: Vec<LayoutNode>

next_pane_id: u32

hovered_split: Option<usize>

dragging_split: Option<usize>

hit_threshold: u16

Implementations

impl ResizableGrid

pub fn new(pane_id: u32) -> ResizableGrid

Available on crate feature resizable-grid only.

Creates a new grid with a single pane as the root.

Arguments

• pane_id: Identifier for the initial pane.

Returns

A new ResizableGrid containing the provided pane ID.

Errors

• None.

Panics

• Does not panic.

Safety

• No safety requirements.

Performance

• O(1).

Example

use ratatui_toolkit::primitives::resizable_grid::ResizableGrid;

let grid = ResizableGrid::new(0);

pub fn from_pane(pane_id: u32) -> ResizableGrid

Available on crate feature resizable-grid only.

Creates a new grid from a single pane.

This is equivalent to Self::new() but provides a more semantic name when constructing a grid that will be populated with panes.

Arguments

• pane_id: Identifier for the initial pane.

Returns

A new ResizableGrid containing the provided pane ID.

Errors

• None.

Panics

• Does not panic.

Safety

• No safety requirements.

Performance

• O(1).

Example

use ratatui_toolkit::primitives::resizable_grid::ResizableGrid;

let grid = ResizableGrid::from_pane(0);

impl ResizableGrid

pub fn layout_panes(&self, area: Rect) -> Vec<PaneLayout>

Available on crate feature resizable-grid only.

Calculates pane rectangles for the current split tree.

Arguments

• area: The available rectangle to divide among panes.

Returns

A vector of PaneLayout values for each leaf pane.

Errors

• None.

Panics

• Does not panic.

Safety

• No safety requirements.

Performance

• O(n) where n is the number of nodes.

Example

use ratatui::layout::Rect;
use ratatui_toolkit::primitives::resizable_grid::ResizableGrid;

let grid = ResizableGrid::new(0);
let panes = grid.layout_panes(Rect::new(0, 0, 120, 40));

pub fn layout_dividers(&self, area: Rect) -> Vec<SplitDividerLayout>

Available on crate feature resizable-grid only.

Calculates divider metadata for the current split tree.

Arguments

• area: The available rectangle to divide among panes.

Returns

A vector of SplitDividerLayout values for each split node.

Errors

• None.

Panics

• Does not panic.

Safety

• No safety requirements.

Performance

• O(n) where n is the number of split nodes.

Example

use ratatui::layout::Rect;
use ratatui_toolkit::primitives::resizable_grid::ResizableGrid;

let grid = ResizableGrid::new(0);
let dividers = grid.layout_dividers(Rect::new(0, 0, 120, 40));

pub fn calculate_split_area(&self, area: Rect, split_percent: u16) -> SplitAreas

Available on crate feature resizable-grid only.

Calculates simple two-pane split areas for basic layouts.

This is a convenience method for common two-pane layouts that calculates left and right (or top and bottom) pane rectangles based on a split percentage.

Arguments

• area: The total area to split.
• split_percent: The percentage for the left/top pane (0-100).

Returns

A SplitAreas struct containing the left/top and right/bottom pane rectangles.

Example

use ratatui::layout::Rect;
use ratatui_toolkit::primitives::resizable_grid::ResizableGrid;

let grid = ResizableGrid::new(0);
let area = Rect::new(0, 0, 100, 50);
let split_areas = grid.calculate_split_area(area, 40);

pub fn get_panes(&self, area: Rect) -> Vec<PaneInfo>

Available on crate feature resizable-grid only.

Returns pane information for all leaf panes in the grid.

This is a convenience method that extracts pane information suitable for use by widgets and rendering code.

Arguments

• area: The available rectangle to divide among panes.

Returns

A vector of PaneInfo for each pane in the layout.

Example

use ratatui::layout::Rect;
use ratatui_toolkit::primitives::resizable_grid::ResizableGrid;

let grid = ResizableGrid::new(0);
let area = Rect::new(0, 0, 100, 50);
let panes = grid.get_panes(area);
for pane in panes {
    println!("Pane {}: {:?}", pane.id, pane.area);
}

impl ResizableGrid

pub fn split_pane_horizontally(&mut self, pane_id: u32) -> Option<u32>

Available on crate feature resizable-grid only.

pub fn split_pane_vertically(&mut self, pane_id: u32) -> Option<u32>

Available on crate feature resizable-grid only.

pub fn resize_split(&mut self, split_index: usize, percent: u16) -> bool

Available on crate feature resizable-grid only.

pub fn resize_divider(&mut self, pane_id: u32, percent: u16) -> bool

Available on crate feature resizable-grid only.

pub fn move_pane(&mut self, pane_id: u32, target_pane_id: u32) -> bool

Available on crate feature resizable-grid only.

pub fn remove_pane(&mut self, pane_id: u32) -> bool

Available on crate feature resizable-grid only.

pub fn get_split_ratio(&self, split_index: usize) -> Option<u16>

Available on crate feature resizable-grid only.

pub fn split_percent(&self) -> u16

Available on crate feature resizable-grid only.

pub fn min_percent(&self) -> u16

Available on crate feature resizable-grid only.

pub fn max_percent(&self) -> u16

Available on crate feature resizable-grid only.

pub fn set_split_percent(&mut self, percent: u16)

Available on crate feature resizable-grid only.

pub fn is_hovering(&self) -> bool

Available on crate feature resizable-grid only.

pub fn is_dragging(&self) -> bool

Available on crate feature resizable-grid only.

pub fn start_drag(&mut self)

Available on crate feature resizable-grid only.

pub fn stop_drag(&mut self)

Available on crate feature resizable-grid only.

pub fn update_divider_position(&mut self, _area: Rect)

Available on crate feature resizable-grid only.

pub fn is_on_divider( &self, mouse_column: u16, mouse_row: u16, area: Rect, ) -> bool

Available on crate feature resizable-grid only.

pub fn find_divider_at( &self, column: u16, row: u16, area: Rect, ) -> Option<usize>

Available on crate feature resizable-grid only.

pub fn update_from_mouse( &mut self, mouse_column: u16, mouse_row: u16, area: Rect, )

Available on crate feature resizable-grid only.

Trait Implementations

impl Clone for ResizableGrid

fn clone(&self) -> ResizableGrid

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResizableGrid

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.