Struct SplitLayout 

pub struct SplitLayout { /* private fields */ }

A layout tree for arranging multiple resizable panes.

Split layouts start with a single pane and can be subdivided into horizontal or vertical splits. Each split stores a percentage for the first pane, enabling resizing of the divider.

Example

use ratatui_toolkit::primitives::split_layout::SplitLayout;

let mut layout = SplitLayout::new(1);
let _ = layout.split_pane_horizontally(1);

Implementations

impl SplitLayout

pub fn new(pane_id: PaneId) -> Self

Creates a layout with a single pane as the root.

Arguments

• pane_id: Identifier for the initial pane.

Returns

A new SplitLayout containing the provided pane ID.

Errors

• None.

Panics

• Does not panic.

Safety

• No safety requirements.

Performance

• O(1).

Example

use ratatui_toolkit::primitives::split_layout::SplitLayout;

let layout = SplitLayout::new(0);

impl SplitLayout

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

Calculates divider metadata for the current split tree.

impl SplitLayout

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

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::split_layout::SplitLayout;

let layout = SplitLayout::new(0);
let panes = layout.layout_panes(Rect::new(0, 0, 120, 40));

impl SplitLayout

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

Moves a pane by swapping it with another pane.

Arguments

• pane_id: The pane to move.
• target_pane_id: The pane that receives the original pane’s position.

Returns

true when both panes exist and the swap completed.

Errors

• None.

Panics

• Does not panic.

Safety

• No safety requirements.

Performance

• O(n) to locate both panes.

Example

use ratatui_toolkit::primitives::split_layout::SplitLayout;

let mut layout = SplitLayout::new(1);
let pane_id = layout.split_pane_vertically(1).unwrap();
let _ = layout.move_pane(1, pane_id);

impl SplitLayout

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

Removes a pane and collapses its parent split.

Arguments

• pane_id: The pane to remove.

Returns

true when a pane is removed and the split collapses.

Errors

• None.

Panics

• Does not panic.

Safety

• No safety requirements.

Performance

• O(n) to locate the pane.

Example

use ratatui_toolkit::primitives::split_layout::SplitLayout;

let mut layout = SplitLayout::new(0);
let pane_id = layout.split_pane_vertically(0).unwrap();
let _ = layout.remove_pane(pane_id);

impl SplitLayout

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

Resizes the split containing a pane.

Arguments

• pane_id: The pane whose split divider should be resized.
• percent: The percentage to allocate to the pane within its split.

Returns

true when the pane is part of a split and the divider was updated.

Errors

• None.

Panics

• Does not panic.

Safety

• No safety requirements.

Performance

• O(n) to locate the pane.

Example

use ratatui_toolkit::primitives::split_layout::SplitLayout;

let mut layout = SplitLayout::new(0);
let pane_id = layout.split_pane_vertically(0).unwrap();
let _ = layout.resize_divider(pane_id, 30);

impl SplitLayout

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

Resizes a split node by index.

impl SplitLayout

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

Splits a pane into a top and bottom pair.

Arguments

• pane_id: The pane to split.

Returns

The newly created pane ID when the split succeeds, or None when the pane cannot be found.

Errors

• None.

Panics

• Does not panic.

Safety

• No safety requirements.

Performance

• O(n) to locate the pane.

Example

use ratatui_toolkit::primitives::split_layout::SplitLayout;

let mut layout = SplitLayout::new(0);
let _ = layout.split_pane_horizontally(0);

impl SplitLayout

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

Splits a pane into a left and right pair.

Arguments

• pane_id: The pane to split.

Returns

The newly created pane ID when the split succeeds, or None when the pane cannot be found.

Errors

• None.

Panics

• Does not panic.

Safety

• No safety requirements.

Performance

• O(n) to locate the pane.

Example

use ratatui_toolkit::primitives::split_layout::SplitLayout;

let mut layout = SplitLayout::new(0);
let _ = layout.split_pane_vertically(0);

Trait Implementations

impl Clone for SplitLayout

fn clone(&self) -> SplitLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SplitLayout

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

Formats the value using the given formatter.