The Switch Group component for Retool Apps

A group of switches to toggle boolean values.

Version: Cloud and 3.234 Edge

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.

captionByIndex

A list of captions for each item, by index.

Type	array
Format	Plain Text
Array values	string
Configurability	Read-only
Default	[]

Examples

["Caption 1", "Caption 2"]

---

deprecatedLabels

A list of labels (deprecated).

Type	array
Array values	string
Configurability	Read-only

---

disabled

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

Type	boolean
Format	True/False
Configurability	Inspector > Interaction > Disabled
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
Configurability	Read-only
Default	[]

Examples

[true, false, true]

---

disabledValues

A list of values not available for selection.

Type	array
Array values	boolean
Configurability	Read-only

---

events

A list of configured event handlers that trigger actions or queries.

Type	array
Array values	object
Configurability	Inspector > Interaction > Event handlers

Array Object Properties

event

The event that triggers the action. Refer to the events section for details of available events for this object.

Type	string
Configurability	Inspector > Interaction > Event handlers > Event

---

method

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Run script actions

---

type

The type of action to perform.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values	Value Description datasource Control query. widget Control component. script Run script. state Set variable. localStorage Set localStorage. util Perform utility action (e.g., Open URL or Confetti).

---

---

groupLayout

The layout of grouped items.

Type	string
Configurability	Inspector > Appearance > Group layout
Allowed Values	Value UI Option Description multiColumn Tree Display items in multiple columns based on the number of items and size. singleColumn Single column Always display items in a single column. wrap Wrap Wrap items. auto Auto Automatically display items in multiple columns based on the number of items and size.
Default	auto

---

hiddenByIndex

A list of items, by index, and whether they are hidden.

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

Examples

[true, false, true]

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Configurability	Inspector
Default	switchGroup1

Examples

query1

button1

---

isHiddenOnDesktop

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

Type	boolean
Format	True/False
Configurability	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
Configurability	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
Configurability	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
Configurability	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
Configurability	Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

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

Examples

4px 8px

---

maxCount

The maximum number of items to allow.

Type	number
Configurability	Inspector

---

minColumnWidth

The minimum width of a column when using a multi-column layout.

Type	number
Format	number
Configurability	Inspector > Appearance > Min col width
Default	null

Examples

100

---

minCount

The minimum number of items to allow.

Type	number
Configurability	Inspector

---

required

Whether a value is required to be selected.

Type	boolean
Format	True/False
Configurability	Inspector > Interaction > Validation rules > Required
Default	false

Examples

true

---

selectedIndexes

A list of selected values, by index.

Type	array
Array values	number
Configurability	Read-only

---

selectedItems

A list of selected items.

Type	array
Configurability	Read-only
Default	[]

Examples

[{"id": "1", "name": "Item 1"}, {"id": "2", "name": "Item 2"}]

---

selectedLabels

A list of labels for selected values, by index.

Type	array
Array values	string
Configurability	Read-only

---

showInEditor

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

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

style

Custom style options.

Type	object
Configurability	Inspector > Appearance > style

---

tooltipByIndex

A list of tooltips for each item, by index.

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

Examples

["Tooltip 1", "Tooltip 2"]

---

tooltipText

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

Type	string
Format	Markdown
Configurability	Inspector > Content > Add-ons > Helper text
Default	null

Examples

Submit

---

value

The current value.

Type	array
Array values	boolean
Configurability	Read-only

---

values

A list of possible values from which to select.

Type	array
Configurability	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.

switchGroup.clearValidation()

Clear the validation message from the input field.

Definition

switchGroup.clearValidation()

Examples

Clear the validation message from switchGroup.

switchGroup.clearValidation();

---

switchGroup.clearValue()

Clear the current values.

Definition

switchGroup.clearValue()

Examples

Clear the current value of switchGroup.

switchGroup.clearValue();

---

switchGroup.focus()

Set focus on the input field.

Definition

switchGroup.focus()

Examples

Set focus on switchGroup.

switchGroup.focus();

---

switchGroup.resetValue()

Reset the current value to the default value.

Definition

switchGroup.resetValue()

Examples

Reset the current value of switchGroup.

switchGroup.resetValue();

---

switchGroup.scrollIntoView()

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

Definition

switchGroup.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description auto Scroll immediately to the specified position. smooth Scroll gradually to the specified position.

---

block

The scroll position relative to the component.

Type	string
Allowed Values	Value Description 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 switchGroup into view.

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

---

switchGroup.setDisabled()

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

Definition

switchGroup.setDisabled(disabled)

Parameters

disabled

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

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Disable switchGroup.

switchGroup.setDisabled(true);

Enable switchGroup.

switchGroup.setDisabled(false);

---

switchGroup.setHidden()

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

Definition

switchGroup.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide switchGroup.

switchGroup.setHidden(true);

Unhide switchGroup.

switchGroup.setHidden(false);

---

switchGroup.setValue()

Set the current value.

Definition

switchGroup.setValue(key, value)

Parameters

key

The key.

Type

string

---

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of switchGroup to userValue.

switchGroup.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.