The Multiselect component for Retool Mobile

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

Version: Cloud and 3.185 Edge

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.

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

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Hidden Method setHidden()
Default	false

Examples

true

---

label

The text label to display.

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

Examples

"Label"

---

labelCaption

The additional text to display with the label.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label > Caption

---

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

---

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

---

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

---

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(value)

Parameters

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.