The Listbox component for Retool Apps

An input field 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.

allowDeselect

Whether to allow deselection of an item.

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

Examples

true

---

deprecatedLabels

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"]

---

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

---

disabledValues

A list of values not available for selection.

Type	array
Array values	boolean
Mutability	Read-only

---

emptyMessage

The message to display if no value is set.

Type	string
Mutability	Control Usage Retool UI Inspector > Appearance > Empty state

---

id

The unique identifier (name).

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

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

---

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

---

searchMode

The type of search to perform.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description fuzzy Searches using fuzzy logic. caseInsensitive Ignores the case used in search terms. caseSensitive Matches the case used in search terms.

---

searchTerm

An optional string to filter the displayed options. Matches values or labels if provided.

Type	string
Mutability	Control Usage Retool UI Inspector > Interaction > Search term

---

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

---

showSelectionIndicator

Whether to display an icon next to a selected item.

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

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

A list of selected 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.

listbox.clearValidation()

Clear the validation message from the input field.

Definition

listbox.clearValidation()

Examples

Clear the validation message from listbox.

listbox.clearValidation();

---

listbox.clearValue()

Clear the current values.

Definition

listbox.clearValue()

Examples

Clear the current value of listbox.

listbox.clearValue();

---

listbox.focus()

Set focus on the input field.

Definition

listbox.focus()

Examples

Set focus on listbox.

listbox.focus();

---

listbox.resetValue()

Reset the current value to the default value.

Definition

listbox.resetValue()

Examples

Reset the current value of listbox.

listbox.resetValue();

---

listbox.scrollIntoView()

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

Definition

listbox.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 listbox into view.

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

---

listbox.setDisabled()

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

Definition

listbox.setDisabled(disabled)

Parameters

disabled

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

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Disable listbox.

listbox.setDisabled(true);

Enable listbox.

listbox.setDisabled(false);

---

listbox.setHidden()

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

Definition

listbox.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide listbox.

listbox.setHidden(true);

Unhide listbox.

listbox.setHidden(false);

---

listbox.setValue()

Set the current value.

Definition

listbox.setValue(value)

Parameters

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of listbox to userValue.

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