The Split Pane frame

A container that divides the viewport into two resizable panes.

Version: Self-hosted 3.114 Stable

The Split Pane frame is a container that appears next to the Main frame. Only one instance of Split Pane can be used.

Demo

Properties

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

enableFullBleed

Whether to expand the contents to fill available space.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Expand contents to fit
Default	false

Examples

true

---

footerPadding

The amount of padding used within the footer.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Footer > Padding
Allowed Values	Value UI Option Description 8px 12px Normal 8px top and bottom, 12px left and right. 0 None No padding.
Default	8px 12px

Examples

"8px 12px"

---

headerPadding

The amount of padding used within the header.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Header > Padding
Allowed Values	Value UI Option Description 8px 12px Normal 8px top and bottom, 12px left and right. 0 None No padding.
Default	8px 12px

Examples

"8px 12px"

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Hidden Method setHidden()
Default	false

Examples

true

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	splitPane1

Examples

query1

button1

---

loading

Whether to display a loading indicator.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Loading
Default	false

Examples

true

---

padding

The amount of padding to render inside.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Spacing > Padding
Allowed Values	Value Description 4px 8px Normal padding. 0 No padding.
Default	4px 8px

Examples

4px 8px

---

position

The position on the canvas.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description left Left. right Right.

---

showBorder

Whether to show a border.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Show border
Default	false

Examples

true

---

showFooter

Whether to show the footer area.

Type	boolean
Mutability	Control Usage Retool UI Inspector Method setShowFooter()

---

showFooterBorder

Whether to show a border above the footer.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Footer > Appearance > Show separator

Examples

true

---

showHeader

Whether to show the header area.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Header > Appearance > Show header Method setShowHeader()
Default	false

Examples

true

---

showHeaderBorder

Whether to show a border under the header.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Header > Appearance > Show separator
Default	true

Examples

true

---

width

The width.

Type	number
Format	Integer
Mutability	Control Usage Retool UI Inspector

Examples

1280

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

splitPane.hide()

Hide the component.

Definition

splitPane.hide()

Examples

Hide splitPane.

splitPane.hide();

---

splitPane.scrollIntoView()

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition

splitPane.scrollIntoView(options)

Parameters

options Required

object

The scroll options.

Object Properties

behavior Required

string

The scroll behavior.

Supported Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

block Required

string

The scroll position relative to the component.

Supported Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

Examples

Scroll the minimum amount to immediately bring splitPane into view.

splitPane.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

splitPane.setHidden()

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition

splitPane.setHidden(hidden)

Parameters

hidden

boolean

Whether this object is hidden from view.

Examples

Hide splitPane.

splitPane.setHidden(true);

Unhide splitPane.

splitPane.setHidden(false);

---

splitPane.show()

Show the component.

Definition

splitPane.show()

Examples

Show splitPane.

splitPane.show();

---

splitPane.toggleHidden()

Toggle the hidden value between true and false.

Definition

splitPane.toggleHidden()

Examples

Toggle the hidden value of splitPane.

splitPane.toggleHidden();

---