The Listbox component for Retool Apps
An input field to select an option from a list.
Settings
Listbox includes the following configurable options when building apps in the IDE.
Properties
All properties for Listbox 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.
automaticItemColors
Whether to automatically assign a color to each item.
captionByIndex
A list of captions for each item, by index.
colorByIndex
A list of colors for each item, by index.
customValidation
The custom validation message to display if the invalid is true.
disabledByIndex
A list of boolean values for each item, by index, that reflect whether they are disabled.
disabledValues
A list of values not available for selection.
emptyMessage
The message to display if no value is set.
Properties
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
Values
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). |
fallbackTextByIndex
A list of values to use as fallback text for each option.
formDataKey
The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.
global
Whether the object is globally scoped for use in all app pages.
Whether the component is visible.
hiddenByIndex
A list of items, by index, and whether they are hidden.
Whether to hide the validation message if the invalid is true.
iconByIndex
A list of icons for each item, by index.
Values
You can select an icon or dynamically set one with a valid icon key.
id
The unique identifier.
imageByIndex
A list of images for each item, by index.
invalid
Whether the value has failed any validation rules.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
The adornment shape.
Values
circle | Sets the item adornment to a circle. |
square | Sets the item adornment to a square. |
The adornment size.
Values
auto | Automatically adjusts the item adornment size. |
small | Sets the item adornment size to small. |
large | Sets the item adornment size to large. |
The configuration mode for option lists. Either dynamic for mapped options or static for manual options.
Values
dynamic | Options dynamically mapped from an array. |
manual | Options manually configured in the IDE. |
labelAlign
The horizontal alignment of the label.
Values
left | Left of the input field. |
top | Above the input field. |
labelCaption
The label for the node.
labelPosition
The position of the label relative to the input field or value.
Values
top | Above the input field or value. |
left | Left of the input field or value. |
labels
A list of labels for each item. Falls back to the corresponding value if no label is provided.
labelWidth
The label width, in the unit specified in labelWidthUnit.
labelWidthUnit
The specified units for labelWidth, if labelPosition is left.
Values
% | Percent. |
px | Pixels. |
col | Columns. |
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden is true.
pluginType
The plugin type.
searchMode
The type of search to perform.
Values
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.
selectedIndex
The selected value, by index.
selectedItem
The selected item.
selectedLabel
The label of the selected value, by index.
showInEditor
Whether to remain visible in the editor if hidden is true.
showSelectionIndicator
Whether to display an icon next to a selected item.
tooltipByIndex
A list of tooltips for each item, by index.
tooltipText
The tooltip text to display.
validationMessage
The validation message to display if invalid is true.
values
A list of possible values.
Methods
JavaScript API methods for interacting with Listbox. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
clearValidation
Clear the validation message from the input field.
listbox.clearValidation()
clearValue
Clear the current values.
listbox.clearValue()
focus
Set focus on the input field.
listbox.focus()
resetValue
Reset the current value to the default value.
listbox.resetValue()
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
listbox.scrollIntoView(scrollIntoViewOptions)
Parameters
scrollIntoViewOptions
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
The scroll position relative to the component.
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. |
setDisabled
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
setHidden
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
listbox.setHidden(hidden)
Parameters
Whether the component is visible.
Events
Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.
change
The value is changed.