The Multiselect component for Retool Apps

An input field to select multiple options using a dropdown menu or manually enter values.

Version: Cloud and 3.223 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.

allowCustomValue

Whether to allow values that do not exist in values.

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

Examples

true

---

clearInputValueOnChange

Whether to clear the input value when the selection changes.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

deprecatedLabels

A list of labels (deprecated).

Type	array
Array values	string
Mutability	Read-only

---

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

---

events

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

Type	array
Array values	object
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI Inspector > Interaction > Event handlers > Event

---

method

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

Type	string
Mutability	Control Usage Retool UI Inspector > Interaction > Event handlers > Edit event handler > Run script actions

---

type

The type of action to perform.

Type	string
Mutability	Control Usage Retool UI 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).

---

---

iconAfter

The suffix icon to display.

Type	string
Format	Icon Key
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Suffix icon
Default	null

Examples

/icon:bold/shopping-gift

---

iconBefore

The prefix icon to display.

Type	string
Format	Icon Key
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Prefix icon
Default	null

Examples

/icon:bold/shopping-gift

---

id

The unique identifier (name).

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

Examples

query1

button1

---

inputValue

The default or most recently entered value.

Type	string
Mutability	Read-only

---

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

---

loading

Whether to display a loading indicator.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI 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
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

---

maxCount

The maximum number of items to allow.

Type	number
Mutability	Control Usage Retool UI Inspector

---

maxLines

The maximum number of lines to show.

Type	number
Mutability	Control Usage Retool UI Inspector

---

minCount

The minimum number of items to allow.

Type	number
Mutability	Control Usage Retool UI Inspector

---

minLines

The minimum number of lines.

Type	number
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules > Min lines

---

overlayMaxHeight

The maximum height of the options list, in pixels.

Type	number
Format	Integer
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Max list height
Default	null

Examples

200

---

overlayMinWidth

The minimum width of the options list, in pixels.

Type	number
Format	Integer
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI Inspector

---

placeholder

The text to display within the input field when there is no value.

Type	string
Format	string
Mutability	Control Usage Retool UI Inspector > Content > Placeholder
Default	Enter a value

Examples

Enter a value

---

readOnly

Whether user input is read-only.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Advanced > Read only
Default	false

Examples

true

---

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.

---

selectedIndexes

A list of selected values, by index.

Type	array
Array values	number
Mutability	Read-only

---

selectedItems

A list of selected items.

Type	array
Mutability	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
Mutability	Read-only

---

showClear

Whether to display a button to clear the value of the input field.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI 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
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

---

textAfter

The suffix text to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Suffix text
Default	null

Examples

USD

px

@example.com

---

textBefore

The prefix text to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Helper text
Default	null

Examples

Submit

---

value

The value.

Type	string | number | boolean | object | array
Mutability	Read-only

---

values

A list of possible values from which to select.

Type	array
Mutability	Read-only

---

wrapTags

Whether to wrap selected tags.

Type	array
Array values	boolean
Mutability	Control Usage Retool UI Inspector

---

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.

Definition

multiselect.clearValidation()

Examples

Clear the validation message from multiselect.

multiselect.clearValidation();

---

multiselect.clearValue()

Clear the current values.

Definition

multiselect.clearValue()

Examples

Clear the current value of multiselect.

multiselect.clearValue();

---

multiselect.focus()

Set focus on the input field.

Definition

multiselect.focus()

Examples

Set focus on multiselect.

multiselect.focus();

---

multiselect.resetValue()

Reset the current value to the default value.

Definition

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.

Definition

multiselect.setDisabled(disabled)

Parameters

disabled

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

Type	boolean
Format	True/False
Default	false

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.

Definition

multiselect.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide multiselect.

multiselect.setHidden(true);

Unhide multiselect.

multiselect.setHidden(false);

---

multiselect.setValue()

Set the current value.

Definition

multiselect.setValue(key, value)

Parameters

key

The key.

Type

string

---

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of multiselect to userValue.

multiselect.setValue(userValue);

---

multiselect.validate()

Validates the value of the input field.

Definition

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.