Struct SplitLayoutWidget 

pub struct SplitLayoutWidget<'a> { /* private fields */ }

A widget that wraps SplitLayout with mouse interaction support.

This widget manages hover state, drag state, and handles mouse events to resize dividers. It also provides styling options for visual feedback during interactions.

Example

use ratatui_toolkit::widgets::split_layout::{SplitLayoutWidget, SplitLayoutWidgetState};
use ratatui_toolkit::primitives::split_layout::SplitLayout;

let mut layout = SplitLayout::new(0);
layout.split_pane_vertically(0);
let mut state = SplitLayoutWidgetState::default();

let widget = SplitLayoutWidget::new(&mut layout)
    .with_divider_width(1)
    .with_hit_threshold(2);

Implementations

impl<'a> SplitLayoutWidget<'a>

pub fn new(layout: &'a mut SplitLayout) -> Self

Create a new SplitLayoutWidget wrapping a SplitLayout.

pub fn with_state(self, state: SplitLayoutWidgetState) -> Self

Set the widget state (for preserving hover/drag across frames).

pub fn state(&self) -> SplitLayoutWidgetState

Get the current widget state (for saving after frame).

pub fn optimal_poll_duration(&self) -> Duration

Get the recommended event poll duration based on interaction state.

Returns 8ms (~120fps) when dragging for smooth resizing, otherwise returns 50ms (normal rate).

Example

let poll_timeout = widget.optimal_poll_duration();
if event::poll(poll_timeout)? { ... }

pub fn layout(&self) -> &SplitLayout

Get a reference to the underlying layout.

pub fn layout_mut(&mut self) -> &mut SplitLayout

Get a mutable reference to the underlying layout.

pub fn with_divider_width(self, width: u16) -> Self

Set the width of divider lines.

pub fn with_hit_threshold(self, threshold: u16) -> Self

Set the hit detection threshold for dividers.

pub fn with_hover_style(self, style: Style) -> Self

Set the style for hovered dividers.

pub fn with_drag_style(self, style: Style) -> Self

Set the style for dragging dividers.

pub fn with_divider_style(self, style: Style) -> Self

Set the style for normal dividers.

pub fn with_block(self, block: Block<'a>) -> Self

Set the block to render around the widget.

pub fn with_pane_borders(self, show: bool) -> Self

Enable or disable pane borders.

pub fn is_hovering(&self) -> bool

Check if currently hovering over any divider.

pub fn is_dragging(&self) -> bool

Check if currently dragging any divider.

pub fn hovered_divider(&self) -> Option<usize>

Get the currently hovered divider index, if any.

pub fn dragging_divider(&self) -> Option<usize>

Get the currently dragging divider index, if any.

pub fn handle_mouse(&mut self, mouse: MouseEvent, area: Rect)

Handle a mouse event.

This method processes mouse events and updates the widget’s state:

• Mouse move: Update hover state
• Mouse down: Start dragging if on a divider
• Mouse drag: Resize the divider
• Mouse up: Stop dragging

Arguments

• mouse - The mouse event to handle
• area - The area the widget is rendered in

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

Get the layout rectangles for all panes.

This allows callers to render pane contents after the widget has drawn borders and overlays.

Trait Implementations

impl<'a> Debug for SplitLayoutWidget<'a>

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

Formats the value using the given formatter.

impl<'a> Widget for SplitLayoutWidget<'a>

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.