React Split Pane screenshot

React Split Pane

Author Avatar Theme by Tomkp
Updated: 9 May 2023
3268 Stars

React split-pane component

Overview:

React Split Pane is a versatile React component that allows for nested or split panes, vertically or horizontally. It provides the ability to resize panes by dragging, set limits on pane sizes, customize resizing increments, and define callbacks for drag events. Additionally, inline styles can be applied to various components within the Split Pane.

Features:

  • Nested or Split Panes: Allows for panes to be nested or split vertically/horizontally.
  • Resizable Panes: Enables users to change the size of panes by dragging a draggable surface.
  • Limiting Pane Sizes: Provides options to set maximum and minimum sizes for panes.
  • Customizable Resizing Increments: Users can set a step prop to allow resizing in fixed increments.
  • Callbacks for Drag Events: Offers callbacks for when a drag starts, ends, and during a drag event.
  • Inline Styles: Allows for passing inline styles to components like the main container, panes, and resizer bar.
  • Persisting Positions: Supports the onChange function prop for persisting splitter choices through a refresh of the application.

Installation:

To install React Split Pane, use npm:

npm install react-split-pane

Summary:

React Split Pane is a powerful React component that simplifies the creation of resizable and customizable split panes within a web application. With features like resizable panes, limits on pane sizes, customizable resizing increments, callbacks for drag events, inline styles, and the ability to persist positions, React Split Pane offers a comprehensive solution for managing split views efficiently.