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 |
| Configurability | Inspector |
| Default | false |
Examples
true
clearInputValueOnChange
Whether to clear the input value when the selection changes.
| Type | boolean |
| Configurability | Inspector |
| Default | null |
deprecatedLabels
A list of labels (deprecated).
| Type | array |
| Array values | string |
| Configurability | Read-only |
| Default | null |
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Disabled |
| Default | false |
Examples
true
disabledValues
A list of values not available for selection.
| Type | array |
| Array values | boolean |
| Configurability | Read-only |
| Default | null |
emptyMessage
The message to display if no value is set.
| Type | string |
| Configurability | Inspector > Appearance > Empty state |
| Default | null |
events
A list of configured event handlers that trigger actions or queries.
| Type | array |
| Array values | object |
| Configurability | Inspector > Interaction > Event handlers |
| Default | null |
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 |
| Default | null |
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 |
| Default | null |
type
The type of action to perform.
| Type | string | ||||||||||||||
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Action | ||||||||||||||
| Allowed Values |
| ||||||||||||||
| Default | null |
iconAfter
The suffix icon to display.
| Type | string |
| Format | Icon Key |
| Configurability | Inspector > Content > Add-ons > Suffix icon |
| Default | null |
Examples
/icon:bold/shopping-gift
iconBefore
The prefix icon to display.
| Type | string |
| Format | Icon Key |
| Configurability | Inspector > Content > Add-ons > Prefix icon |
| Default | null |
Examples
/icon:bold/shopping-gift
id
The unique identifier (name).
| Type | string |
| Format | Plain Text |
| Configurability | Inspector |
| Default | multiselect1 |
Examples
query1
button1
inputValue
The default or most recently entered value.
| Type | string |
| Configurability | Read-only |
| Default | null |
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 |
| |||||||||
| Default | left |
Examples
top
loading
Whether to display a loading indicator.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Loading |
| Default | false |
Examples
true
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 |
| |||||||||
| Default | 4px 8px |
Examples
4px 8px
minLines
The minimum number of lines.
| Type | number |
| Configurability | Inspector > Interaction > Validation rules > Min lines |
| Default | null |
overlayMaxHeight
The maximum height of the options list, in pixels.
| Type | number |
| Format | Integer |
| Configurability | Inspector > Appearance > Advanced > Max list height |
| Default | null |
Examples
200
overlayMinWidth
The minimum width of the options list, in pixels.
| Type | number |
| Format | Integer |
| Configurability | Inspector > Appearance > Advanced > Min list width |
| Default | null |
Examples
200
persistSearchTerm
Whether to persist the search term after making a selection.
| Type | array |
| Array values | boolean |
| Configurability | Inspector |
| Default | null |
placeholder
The text to display within the input field when there is no value.
| Type | string |
| Format | string |
| Configurability | Inspector > Content > Placeholder |
| Default | Enter a value |
Examples
Enter a value
readOnly
Whether user input is read-only.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Advanced > Read only |
| Default | false |
Examples
true
required
Whether a value is required to be selected.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Validation rules > Required |
| Default | false |
Examples
true
searchMode
The type of search to perform.
| Type | string | ||||||||
| Configurability | Inspector | ||||||||
| Allowed Values |
| ||||||||
| Default | null |
selectedIndexes
A list of selected values, by index.
| Type | array |
| Array values | number |
| Configurability | Read-only |
| Default | null |
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 |
| Default | null |
showClear
Whether to display a button to clear the value of the input field.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Show clear button |
| Default | false |
Examples
true
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
showSelectionIndicator
Whether to display an icon next to a selected item.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Show selection indicator |
| Default | true |
Examples
true
textAfter
The suffix text to display.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Suffix text |
| Default | null |
Examples
USD
px
@example.com
textBefore
The prefix text to display.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Prefix text |
| Default | null |
Examples
$
Email address
SKU
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
values
A list of possible values from which to select.
| Type | array |
| Configurability | Read-only |
| Default | null |
wrapTags
Whether to wrap selected tags.
| Type | array |
| Array values | boolean |
| Configurability | Inspector |
| Default | null |
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
Clear the validation message from multiselect.
multiselect.clearValidation();
multiselect.clearValue()
Clear the current values.
multiselect.clearValue()
Examples
Clear the current value of multiselect.
multiselect.clearValue();
multiselect.focus()
Set focus on the input field.
multiselect.focus()
Examples
Set focus on multiselect.
multiselect.focus();
multiselect.resetValue()
Reset the current value to the default value.
multiselect.resetValue()
Examples
Reset the current value of multiselect.
multiselect.resetValue();
multiselect.setDisabled()
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
multiselect.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Default | |
Examples
true
Examples
Disable multiselect.
multiselect.setDisabled(true);
Enable multiselect.
multiselect.setDisabled(false);
multiselect.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
multiselect.setHidden(hidden)
Parameters
Examples
true
Examples
Hide multiselect.
multiselect.setHidden(true);
Unhide multiselect.
multiselect.setHidden(false);
multiselect.setValue()
Set the current value.
multiselect.setValue(key, value)
Examples
Set the current value of multiselect to userValue.
multiselect.setValue(userValue);
multiselect.validate()
Validates the value of the input field.
multiselect.validate()
Examples
Validate the value of multiselect.
multiselect.validate();
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. |