Skip to main content

The Multiselect component for Retool Mobile

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

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
Configurability Inspector > Interaction > Disabled
Defaultfalse
Examples
true

events

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

Type array
Array values object
Configurability Inspector > Interaction > Event handlers
Defaultnull
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
Defaultnull

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
Defaultnull

type

The type of action to perform.

Type string
Configurability Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values
ValueDescription
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).

Defaultnull


hidden

Whether this object is hidden from view.

Type boolean
Format True/False
Configurability Inspector > Appearance > Hidden
Defaultfalse
Examples
true


labelCaption

The additional text to display with the label.

Type string
Format Plain Text
Configurability Inspector > Content > Add-ons > Label > Caption
Defaultnull

labels

A list of labels for each item. Falls back to the corresponding value if no label is provided.

Type array
Array values string
Configurability 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
Formatstring
Configurability Inspector > Content > Placeholder
DefaultEnter a value
Examples
Enter a value

value

The value.

Type string | number | boolean | object | array
Configurability Read-only
Defaultnull

values

A list of possible values from which to select.

Type array
Configurability Read-only
Defaultnull

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.

EventDescription
ChangeThe value is changed.