The Multiselect component for Retool Apps
An input field to select multiple options using a dropdown menu or manually enter values.
Refer to the selection input guide for more information on using this component.
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.
allowCustomValue
Whether to allow values that do not exist in values
.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
clearInputValueOnChange
Whether to clear the input value when the selection changes.
Type | boolean | ||||
Mutability |
|
disabled
Whether input, interaction, selection, or triggering is disabled.
Type | boolean | ||||||
Format | True/False | ||||||
Mutability |
| ||||||
Default |
|
Examples
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 |
|
iconAfter
The suffix icon to display.
Type | string | ||||
Format | Icon Key | ||||
Mutability |
| ||||
Default |
|
Examples
iconBefore
The prefix icon to display.
Type | string | ||||
Format | Icon Key | ||||
Mutability |
| ||||
Default |
|
Examples
id
The unique identifier (name).
Type | string | ||||
Format | Plain Text | ||||
Mutability |
| ||||
Default |
|
Examples
isHiddenOnDesktop
Whether to show or hide this object in the desktop layout.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
isHiddenOnMobile
Whether to show or hide this object in the mobile layout.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
labelPosition
The position of the label relative to the input field or value.
Type | string | |||||||||
Format | Plain Text | |||||||||
Mutability |
| |||||||||
Allowed Values |
| |||||||||
Default |
|
Examples
loading
Whether to display a loading indicator.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
maintainSpaceWhenHidden
Whether to take up space on the canvas if hidden
is true
.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
margin
The amount of margin to render outside.
Type | string | |||||||||
Format | Plain Text | |||||||||
Mutability |
| |||||||||
Allowed Values |
| |||||||||
Default |
|
Examples
minLines
The minimum number of lines.
Type | number | ||||
Mutability |
|
overlayMaxHeight
The maximum height of the options list, in pixels.
Type | number | ||||
Format | Integer | ||||
Mutability |
| ||||
Default |
|
Examples
overlayMinWidth
The minimum width of the options list, in pixels.
Type | number | ||||
Format | Integer | ||||
Mutability |
| ||||
Default |
|
Examples
persistSearchTerm
Whether to persist the search term after making a selection.
Type | array | ||||
Array values | boolean | ||||
Mutability |
|
placeholder
The text to display within the input field when there is no value.
Type | string | ||||
Format | string | ||||
Mutability |
| ||||
Default |
|
Examples
readOnly
Whether user input is read-only.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
required
Whether a value is required to be selected.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
searchMode
The type of search to perform.
Type | string | ||||||||
Mutability |
| ||||||||
Allowed Values |
|
selectedIndexes
A list of selected values, by index.
Type | array |
Array values | number |
Mutability | Read-only |
Examples
selectedLabels
A list of labels for selected values, by index.
Type | array |
Array values | string |
Mutability | Read-only |
showClear
Whether to display a button to clear the value of the input field.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
showInEditor
Whether the component remains visible in the editor if hidden
is true
.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
showSelectionIndicator
Whether to display an icon next to a selected item.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
style
Custom style options.
Type | object | ||||
Mutability |
|
textAfter
The suffix text to display.
Type | string | ||||
Format | Plain Text | ||||
Mutability |
| ||||
Default |
|
Examples
textBefore
The prefix text to display.
Type | string | ||||
Format | Plain Text | ||||
Mutability |
| ||||
Default |
|
Examples
tooltipText
The tooltip text to display next to the label on hover.
Type | string | ||||
Format | Markdown | ||||
Mutability |
| ||||
Default |
|
Examples
wrapTags
Whether to wrap selected tags.
Type | array | ||||
Array values | boolean | ||||
Mutability |
|
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
multiselect.clearValidation()
Clear the validation message from the input field.
multiselect.clearValidation()
Examples
multiselect.resetValue()
Reset the current value to the default value.
multiselect.resetValue()
Examples
multiselect.setDisabled()
Set the disabled
value to toggle whether the input field is disabled. Defaults to true
without a parameter.
multiselect.setDisabled(disabled)
Parameters
Examples
multiselect.setHidden()
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
multiselect.setHidden(hidden)
Parameters
Examples
multiselect.setValue()
Set the current value.
multiselect.setValue(value)
Parameters
Examples
multiselect.validate()
Validates the value of the input field.
multiselect.validate()
Examples
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. |