The Segmented Control component for Retool Apps

A segmented button to select an option from a list.

Version: Cloud and 3.185 Edge

Refer to the selection input guide for more information on using this component.

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.

deprecatedLabels

A list of labels (deprecated).

Type	array
Array values	string
Mutability	Read-only

---

disabled

Whether input, interaction, selection, or triggering is disabled.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Disabled Method setDisabled()
Default	false

Examples

true

---

disabledByIndex

A list of values for each item, by index, that reflect whether they are disabled.

Type	array
Array values	boolean
Mutability	Read-only
Default	[]

Examples

[true, false, true]

---

iconByIndex

A list of icons for each item, by index.

Type	array
Array values	string
Mutability	Read-only
Default	[]

Examples

["/icon:bold/shopping-gift", "/icon:bold/interface-user-single", "/icon:bold/interface-align-layers-1"]

---

iconPositionByIndex

A list of icon positions for each item, by index, relative to labels.

Type	array
Array values	string
Mutability	Read-only
Allowed Values	Value Description left Left. right Right.

---

id

The unique identifier (name).

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

Examples

query1

button1

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

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

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

labelPosition

The position of the label relative to the input field or value.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label > Position
Allowed Values	Value UI Option Description top Top Above the input field or value. left Left Left of the input field or value.
Default	left

Examples

top

---

labels

A list of labels for each item. Falls back to the corresponding value if no label is provided.

Type	array
Array values	string
Mutability	Read-only
Default	[]

Examples

["Label 1", "Label 2", "Label 3"]

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

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

Examples

4px 8px

---

paddingType

The padding to use.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description default The default padding x-setting. dense A denser x-setting that reduces padding between elements.

---

required

Whether a value is required to be selected.

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

Examples

true

---

selectedIndex

The selected values, by index.

Type	number
Format	Integer
Mutability	Read-only
Default	[]

Examples

["Value 1", "Value 2"]

---

selectedItem

The selected item.

Type	string | number | boolean | object | array
Format	Custom data
Mutability	Read-only
Default	null

Examples

{"id": "1", "name": "Item 1"}

---

selectedLabel

The label of the selected value, by index.

Type	string
Format	string
Mutability	Read-only
Default	null

Examples

Value 1

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance > style

---

tooltipText

The tooltip text to display next to the label on hover.

Type	string
Format	Markdown
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Helper text
Default	null

Examples

Submit

---

value

The current value.

Type	string | number | boolean | object | array
Mutability	Read-only

---

values

A list of possible values.

Type	array
Mutability	Read-only

---

Methods

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

segmentedControl.clearValue()

Clear the current values.

Definition

segmentedControl.clearValue()

Examples

Clear the current value of segmentedControl.

segmentedControl.clearValue();

---

segmentedControl.focus()

Set focus on the input field.

Definition

segmentedControl.focus()

Examples

Set focus on segmentedControl.

segmentedControl.focus();

---

segmentedControl.resetValue()

Reset the current value to the default value.

Definition

segmentedControl.resetValue()

Examples

Reset the current value of segmentedControl.

segmentedControl.resetValue();

---

segmentedControl.setDisabled()

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

Definition

segmentedControl.setDisabled(disabled)

Parameters

disabled

Whether input, interaction, selection, or triggering is disabled.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Disable segmentedControl.

segmentedControl.setDisabled(true);

Enable segmentedControl.

segmentedControl.setDisabled(false);

---

segmentedControl.setHidden()

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

Definition

segmentedControl.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide segmentedControl.

segmentedControl.setHidden(true);

Unhide segmentedControl.

segmentedControl.setHidden(false);

---

segmentedControl.setValue()

Set the current value.

Definition

segmentedControl.setValue(value)

Parameters

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of segmentedControl to userValue.

segmentedControl.setValue(userValue);

---

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

Event	Description
Change	The value is changed.