React Splitter API
Splitter is a UI component that allows you to divide a page or section into multiple adjustable panes.
Props
| Name | Description |
|---|---|
| allowKeyboardNavigation |
Specifies whether to allow the Splitter to take focus and allow keyboard navigation. |
| dataSource |
Binds the UI component to data. |
| disabled |
Specifies whether the UI component responds to user interaction. |
| elementAttr |
Specifies the global attributes to be attached to the UI component's container element. |
| height |
Specifies the UI component's height. |
| hoverStateEnabled |
Specifies whether the UI component changes its state when a user pauses on it. |
| itemComponent |
An alias for the itemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information. |
| itemRender |
An alias for the itemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information. |
| items |
An array of items (panes) displayed by the UI component. |
| itemTemplate |
Specifies a custom template for items. |
| onContentReady |
A function that is executed when the UI component is rendered and each time the component is repainted. |
| onDisposing |
A function that is executed before the UI component is disposed of. |
| onInitialized |
A function used to save the UI component instance. |
| onItemClick |
A function that is executed when an item (pane) is clicked or tapped. |
| onItemCollapsed |
A function that is executed after an item (pane) is collapsed. |
| onItemContextMenu |
A function that is executed when an item (pane) is right-clicked or pressed. |
| onItemExpanded |
A function that is executed after an item (pane) is expanded. |
| onItemRendered |
A function that is executed after an item (pane) is rendered. |
| onOptionChanged |
A function that is executed after a UI component property is changed. |
| onResize |
A function that is executed each time an item (pane) is resized by one pixel. |
| onResizeEnd |
A function that is called when resizing ends. |
| onResizeStart |
A function that is called when resizing starts. |
| orientation |
Specifies item orientation (layout). |
| rtlEnabled |
Switches the UI component to a right-to-left representation. |
| separatorSize |
Specifies the size of a separator bar in pixels. |
| visible |
Specifies whether the UI component is visible. |
| width |
Specifies the UI component's width. |
See Also
Methods
| Name | Description |
|---|---|
| beginUpdate() |
Postpones rendering that can negatively affect performance until the endUpdate() method is called. |
| defaultOptions(rule) |
Specifies the device-dependent default configuration properties for this component. |
| dispose() |
Disposes of all the resources allocated to the Splitter instance. |
| element() |
Gets the root UI component element. |
| endUpdate() |
Refreshes the UI component after a call of the beginUpdate() method. |
| getDataSource() |
Gets the DataSource instance. |
| getInstance(element) |
Gets the instance of a UI component found using its DOM node. |
| instance() |
Gets the UI component's instance. Use it to access other methods of the UI component. |
| off(eventName) |
Detaches all event handlers from a single event. |
| off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) |
Subscribes to an event. |
| on(events) |
Subscribes to events. |
| option() |
Gets all UI component properties. |
| option(optionName) |
Gets the value of a single property. |
| option(optionName, optionValue) |
Updates the value of a single property. |
| option(options) |
Updates the values of several properties. |
| registerKeyHandler(key, handler) |
Registers a handler to be executed when a user presses a specific key. |
| repaint() |
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically. |
| resetOption(optionName) |
Resets a property to its default value. |
Events
| Name | Description |
|---|---|
| contentReady |
Raised when the UI component is rendered and each time the component is repainted. |
| disposing |
Raised before the UI component is disposed of. |
| initialized |
Raised only once, after the UI component is initialized. |
| itemClick |
Raised when a collection item is clicked or tapped. |
| itemCollapsed |
Raised after an item (pane) is collapsed. |
| itemContextMenu |
Raised when a collection item is right-clicked or pressed. |
| itemExpanded |
Raised after an item (pane) is expanded. |
| itemRendered |
Raised after a collection item is rendered. |
| optionChanged |
Raised after a UI component property is changed. |
| resize |
Raised each time an item (pane) is resized by one pixel. |
| resizeEnd |
Raised when resizing ends. |
| resizeStart |
Raised when resizing starts. |
Types
| Name | Description |
|---|---|
| ContentReadyEvent |
The type of the contentReady event handler's argument. |
| DisposingEvent |
The type of the disposing event handler's argument. |
| InitializedEvent |
The type of the initialized event handler's argument. |
| ItemClickEvent |
The type of the itemClick event handler's argument. |
| ItemCollapsedEvent |
The type of the itemCollapsed event handler's argument. |
| ItemContextMenuEvent |
The type of the itemContextMenu event handler's argument. |
| ItemExpandedEvent |
The type of the itemExpanded event handler's argument. |
| ItemRenderedEvent |
The type of the itemRendered event handler's argument. |
| OptionChangedEvent |
The type of the optionChanged event handler's argument. |
| ResizeEndEvent |
The type of the resizeEnd event handler's argument. |
| ResizeEvent |
The type of the resize event handler's argument. |
| ResizeStartEvent |
The type of the resizeStart event handler's argument. |
If you have technical questions, please create a support ticket in the DevExpress Support Center.