The Multiselect web component

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

Demo

Settings

Multiselect includes the following configurable options when building apps in the IDE.

Allow custom valuesAssign option colors automaticallyCustom ruleDataDisabledEmpty stateEvent handlersForm data keyHiddenHide validation messageSuffix iconPrefix iconShow on desktopShow on mobileImage shapeImage sizeOptionsLabelAlignmentLabelsPositionWidthWidth (units)Allow wrappingLoadingMaintain space when hiddenMarginMax itemsMax linesMin itemsMin linesMax list heightMin list widthPersist search term after selectionPlaceholderRead onlyRequiredSearchShow clear buttonAlways show in edit modeShow selection indicatorStylesSuffix textPrefix textHelper textValueWrap tags

Properties

All properties for Multiselect with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

allowCustomValue

boolean

Whether to allow values that do not exist in values.

---

automaticItemColors

boolean[]

Whether to automatically assign a color to each item.

---

captionByIndex

string

A list of captions for each item, by index.

---

colorByIndex

string[]

A list of colors for each item, by index.

---

customValidation

string

The custom validation message to display if the invalid is true.

---

data

any[]

The source data.

---

disabled

boolean

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

---

disabledByIndex

boolean[]

A list of boolean values for each item, by index, that reflect whether they are disabled.

---

disabledValues

boolean[]

A list of values not available for selection.

---

emptyMessage

string

The message to display if no value is set.

---

events

object[]

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

Properties

event

enum

The event type.

Values

change	A user changes the value.
click	A user clicks or taps the component.
submit	A user submits the value.
focus	A user selects the input field.
blur	A user deselects the input field.
scan	A user scans a barcode.
open	A user opens the component.
close	A user closes the component.
true	A user sets the value to true.
false	A user sets the value to false.
select	A user selects a value.
clear	A user clears the value.
upload	A user uploads a file.
parse	An uploaded file is parsed.
inputValueChange	A user changes the value of the input field.

---

method

enum

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

---

type

enum

The type of action to perform.

Values

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).

---

---

fallbackTextByIndex

string[]

A list of values to use as fallback text for each option.

---

formDataKey

string

The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

hidden

boolean

Whether the component is visible.

---

hiddenByIndex

boolean[]

A list of items, by index, and whether they are hidden.

---

hideValidationMessage

boolean

Whether to hide the validation message if the invalid is true.

---

iconAfter

enum

The suffix icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

---

iconBefore

enum

The prefix icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

---

iconByIndex

enum[]

A list of icons for each item, by index.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

---

id

string

The unique identifier.

---

imageByIndex

string[]

A list of images for each item, by index.

---

inputValue

string

The or most recently entered value.

---

invalid

boolean

Whether the value has failed any validation rules.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

itemAdornmentShape

enum

The adornment shape.

Values

circle	Sets the item adornment to a circle.
square	Sets the item adornment to a square.

---

itemAdornmentSize

enum

The adornment size.

Values

auto	Automatically adjusts the item adornment size.
small	Sets the item adornment size to small.
large	Sets the item adornment size to large.

---

itemMode

enum

The configuration mode for option lists. Either dynamic for mapped options or static for manual options.

Values

dynamic	Options dynamically mapped from an array.
manual	Options manually configured in the IDE.

---

label

string

The text label to display.

---

labelAlign

enum

The horizontal alignment of the label.

Values

left	Left of the input field.
top	Above the input field.

---

labelCaption

string[]

The label for the node.

---

labelPosition

enum

The position of the label relative to the input field or value.

Values

top	Above the input field or value.
left	Left of the input field or value.

---

labels

string

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

---

labelWidth

number

The label width, in the unit specified in labelWidthUnit.

---

labelWidthUnit

enum

The specified units for labelWidth, if labelPosition is left.

Values

%	Percent.
px	Pixels.
col	Columns.

---

labelWrap

boolean

Whether the label can wrap to multiple lines.

---

loading

boolean

Whether to display a loading indicator.

---

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

maxCount

number

The maximum number of items to allow.

---

maxLines

number

The maximum number of lines to show.

---

minCount

number

The minimum number of items to allow.

---

minLines

number

The minimum number of lines.

---

overlayMaxHeight

number

The maximum height of the dropdown, in pixels.

---

overlayMinWidth

number

The minimum width of the dropdown, in pixels.

---

persistSearchTerm

boolean[]

Whether to persist the search term after making a selection.

---

placeholder

string

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

---

pluginType

string

The plugin type.

---

readOnly

boolean

Whether user input is read-only.

---

required

boolean

Whether a value is required.

---

searchMode

enum

The type of search to perform.

Values

fuzzy	Searches using fuzzy logic.
caseInsensitive	Ignores the case used in search terms.
caseSensitive	Matches the case used in search terms.

---

selectedIndexes

number[]

A list of selected values, by index.

---

selectedItems

object[]

A list of selected items.

---

selectedLabels

string[]

A list of labels for selected values, by index.

---

showClear

boolean

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

---

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

---

showSelectionIndicator

boolean

Whether to display an icon next to a selected item.

---

style

object

Custom style options in use. Not all style options may be available for all components.

---

textAfter

string

The suffix text to display.

---

textBefore

string

The prefix text to display.

---

tooltipByIndex

string[]

A list of tooltips for each item, by index.

---

tooltipText

string

The tooltip text to display.

---

validationMessage

string

The validation message to display if invalid is true.

---

value

string[] | number[] | boolean[]

The value.

---

values

string[] | number[] | boolean[]

A list of possible values.

---

wrapTags

boolean[]

Whether to wrap selected tags.

---

Methods

JavaScript API methods for interacting with Multiselect. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

clearValidation

Clear the validation message from the input field.

multiselect.clearValidation()

---

clearValue

Clear the current values.

multiselect.clearValue()

---

focus

Set focus on the input field.

multiselect.focus()

---

resetValue

Reset the current value to the default value.

multiselect.resetValue()

---

scrollIntoView

Scrolls the canvas or parent container so that the selected component appears in the visible area.

multiselect.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

---

block

enum

The scroll position relative to the component.

Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

---

---

---

setDisabled

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

multiselect.setDisabled(disabled)

Parameters

disabled

boolean

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

---

---

setHidden

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

multiselect.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---

setValue

Set the current value.

multiselect.setValue(value)

Parameters

value

string[] | number[] | boolean[]

The value.

---

---

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

blur

The input field is blurred.

---

change

The value is changed.

---

focus

The input field is focused.

---

inputValueChange

The input value is changed.

---