Struct SplitPanelState 

pub struct SplitPanelState { /* private fields */ }

State for a SplitPanel component.

Manages the split ratio, orientation, and which pane has focus. The parent is responsible for rendering content into each pane.

Implementations

impl SplitPanelState

pub fn new(orientation: SplitOrientation) -> Self

Creates a new split panel with the given orientation and a 50/50 split.

Example

use envision::component::{SplitPanelState, SplitOrientation};

let state = SplitPanelState::new(SplitOrientation::Horizontal);
assert_eq!(state.ratio(), 0.5);
assert_eq!(state.orientation(), &SplitOrientation::Horizontal);

pub fn with_ratio(self, ratio: f32) -> Self

Sets the split ratio (builder pattern).

The ratio is clamped to [min_ratio, max_ratio].

Example

use envision::component::{SplitPanelState, SplitOrientation};

let state = SplitPanelState::new(SplitOrientation::Vertical).with_ratio(0.3);
assert!((state.ratio() - 0.3).abs() < f32::EPSILON);

pub fn orientation(&self) -> &SplitOrientation

Returns the current orientation.

Example

use envision::component::{SplitPanelState, SplitOrientation};

let state = SplitPanelState::new(SplitOrientation::Horizontal);
assert_eq!(state.orientation(), &SplitOrientation::Horizontal);

pub fn set_orientation(&mut self, orientation: SplitOrientation)

Sets the orientation.

Example

use envision::component::{SplitPanelState, SplitOrientation};

let mut state = SplitPanelState::new(SplitOrientation::Vertical);
state.set_orientation(SplitOrientation::Horizontal);
assert_eq!(state.orientation(), &SplitOrientation::Horizontal);

pub fn ratio(&self) -> f32

Returns the current split ratio.

0.5 means equal split. Values closer to 1.0 give more space to the first pane.

Example

use envision::component::{SplitPanelState, SplitOrientation};

let state = SplitPanelState::new(SplitOrientation::Vertical).with_ratio(0.4);
assert!((state.ratio() - 0.4).abs() < f32::EPSILON);

pub fn set_ratio(&mut self, ratio: f32)

Sets the split ratio, clamped to [min_ratio, max_ratio].

Example

use envision::component::{SplitPanelState, SplitOrientation};

let mut state = SplitPanelState::new(SplitOrientation::Vertical);
state.set_ratio(0.7);
assert!((state.ratio() - 0.7).abs() < f32::EPSILON);

pub fn is_first_pane_focused(&self) -> bool

Returns true if the first pane has focus.

Example

use envision::component::{SplitPanelState, SplitOrientation};

let state = SplitPanelState::new(SplitOrientation::Vertical);
assert!(state.is_first_pane_focused());
assert!(!state.is_second_pane_focused());

pub fn is_second_pane_focused(&self) -> bool

Returns true if the second pane has focus.

Example

use envision::component::{SplitPanelState, SplitPanelMessage, SplitOrientation};

let mut state = SplitPanelState::new(SplitOrientation::Vertical);
state.update(SplitPanelMessage::FocusSecond);
assert!(state.is_second_pane_focused());

pub fn resize_step(&self) -> f32

Returns the resize step size (default 0.1 = 10%).

Example

use envision::component::{SplitPanelState, SplitOrientation};

let state = SplitPanelState::new(SplitOrientation::Vertical).with_resize_step(0.05);
assert!((state.resize_step() - 0.05).abs() < f32::EPSILON);

pub fn with_resize_step(self, step: f32) -> Self

Sets the resize step size.

Example

use envision::component::{SplitPanelState, SplitOrientation};

let state = SplitPanelState::new(SplitOrientation::Vertical)
    .with_resize_step(0.05);
assert!((state.resize_step() - 0.05).abs() < f32::EPSILON);

pub fn with_bounds(self, min: f32, max: f32) -> Self

Sets the minimum and maximum ratio bounds.

Example

use envision::component::{SplitPanelState, SplitOrientation};

let state = SplitPanelState::new(SplitOrientation::Vertical)
    .with_bounds(0.2, 0.8);

pub fn update(&mut self, msg: SplitPanelMessage) -> Option<SplitPanelOutput>

Updates the state with a message, returning any output.

Example

use envision::component::{SplitPanelState, SplitPanelMessage, SplitPanelOutput, SplitOrientation};

let mut state = SplitPanelState::new(SplitOrientation::Vertical);
let output = state.update(SplitPanelMessage::FocusSecond);
assert_eq!(output, Some(SplitPanelOutput::FocusedSecond));

pub fn layout(&self, area: Rect) -> (Rect, Rect)

Computes the layout areas for the two panes.

Returns (first_pane_area, second_pane_area).

Example

use envision::component::{SplitPanelState, SplitOrientation};
use ratatui::prelude::Rect;

let state = SplitPanelState::new(SplitOrientation::Vertical);
let area = Rect::new(0, 0, 80, 24);
let (first, second) = state.layout(area);
assert_eq!(first.width + second.width, 80);

Trait Implementations

impl Clone for SplitPanelState

fn clone(&self) -> SplitPanelState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SplitPanelState

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

Formats the value using the given formatter.

impl Default for SplitPanelState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SplitPanelState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SplitPanelState

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SplitPanelState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.