Struct ResizableGridWidget 

pub struct ResizableGridWidget { /* private fields */ }

A widget that wraps ResizableGrid 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.

See the module-level docs for a minimal resizable split example.

Example

use ratatui_toolkit::primitives::resizable_grid::{ResizableGridWidget, ResizableGrid};

let layout = ResizableGrid::new(0);
let state = ResizableGridWidgetState::default();

let widget = ResizableGridWidget::new(layout)
    .with_divider_width(1)
    .with_hit_threshold(2);

Implementations

impl ResizableGridWidget

pub fn new(layout: ResizableGrid) -> ResizableGridWidget

Available on crate feature resizable-grid only.

Create a new ResizableGridWidget owning the given ResizableGrid.

pub fn with_state(self, state: ResizableGridWidgetState) -> ResizableGridWidget

Available on crate feature resizable-grid only.

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

pub fn state(&self) -> ResizableGridWidgetState

Available on crate feature resizable-grid only.

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

pub fn optimal_poll_duration(&self) -> Duration

Available on crate feature resizable-grid only.

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) -> &ResizableGrid

Available on crate feature resizable-grid only.

Get a reference to the underlying layout.

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

Available on crate feature resizable-grid only.

Get a mutable reference to the underlying layout.

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

Available on crate feature resizable-grid only.

Set the width of divider lines.

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

Available on crate feature resizable-grid only.

Set the hit detection threshold for dividers.

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

Available on crate feature resizable-grid only.

Set the style for hovered dividers.

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

Available on crate feature resizable-grid only.

Set the style for dragging dividers.

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

Available on crate feature resizable-grid only.

Set the style for normal dividers.

pub fn with_block(self, block: Block<'static>) -> ResizableGridWidget

Available on crate feature resizable-grid only.

Set the block to render around the widget.

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

Available on crate feature resizable-grid only.

Enable or disable pane borders.

pub fn is_hovering(&self) -> bool

Available on crate feature resizable-grid only.

Check if currently hovering over any divider.

pub fn is_dragging(&self) -> bool

Available on crate feature resizable-grid only.

Check if currently dragging any divider.

pub fn needs_fast_refresh(&self) -> bool

Available on crate feature resizable-grid only.

Check if the widget needs fast refresh (during drag operations).

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

Available on crate feature resizable-grid only.

Get the currently hovered divider index, if any.

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

Available on crate feature resizable-grid only.

Get the currently dragging divider index, if any.

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

Available on crate feature resizable-grid only.

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>

Available on crate feature resizable-grid only.

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 Clone for ResizableGridWidget

fn clone(&self) -> ResizableGridWidget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResizableGridWidget

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

Formats the value using the given formatter.

impl Widget for ResizableGridWidget

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.