Skip to main content

Split Pane

Rocket 2.0

The Split Pane component is a container with two areas and a divider the user can drag to resize them, such as a list beside a detail view. Drop other components into either area.

Properties​

Property
Description
Expected Value
DirectionSide by side places the two areas left and right; Stacked places them top and bottom.Side by side, Stacked. Default: Side by side
First pane (%)Size of the first area as a percent of the whole. It updates as the user drags the divider.Number. Default: 40
Minimum pane (%)Smallest size, as a percent, either area can be dragged down to. Capped at 45.Number. Default: 15

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On resizeTriggers when the user finishes moving the divider, by dragging it or with the keyboard.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set splitMoves the divider so the first area takes the given percent, kept within Minimum pane (%).components.splitpane1.setSplit("")
Set visibilityShows the component when true, hides it when false.components.splitpane1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.splitpane1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.splitpane1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
directionSide by side places the two areas left and right; Stacked places them top and bottom.{{components.splitpane1.direction}}
splitSize of the first area as a percent of the whole. It updates as the user drags the divider.{{components.splitpane1.split}}
minPaneSmallest size, as a percent, either area can be dragged down to. Capped at 45.{{components.splitpane1.minPane}}
isVisibleWhether the component is visible.{{components.splitpane1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.splitpane1.isLoading}}
isDisabledWhether the component is disabled.{{components.splitpane1.isDisabled}}

Styles​

Style
Default
DividerTheme: Default border
Divider width6
BackgroundTheme: Surface 1
Border radius—
Padding12
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.