Skip to main content

The Multiselect Listbox component for Retool Apps

An input field to select multiple options from a list.

Settings

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

Assign option colors automaticallyCustom ruleDataDisabledEmpty stateEvent handlersForm data keyHide validation messageShow on desktopShow on mobileImage shapeImage sizeOptionsLabelAlignmentLabelsPositionWidthWidth (units)Allow wrappingMaintain space when hiddenMarginMax itemsMin itemsRequiredSearchSearch termShow footerAlways show in edit modeShow selection indicatorStylesHelper textValue

Properties

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

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.


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


data

any[]

The source data.


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.


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.


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.


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.


boolean

Whether the component is visible.


hiddenByIndex

boolean[]

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


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


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.


id

string

The unique identifier.


imageByIndex

string[]

A list of images for each item, by index.


invalid

boolean

Whether the value has failed any validation rules.


Whether the component is visible in the desktop layout.


Whether the component is visible in the mobile layout.


The adornment shape.

Values
circle

Sets the item adornment to a circle.

square

Sets the item adornment to a square.


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.


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.


The horizontal alignment of the label.

Values
left

Left of the input field.

top

Above the input field.


The label for the node.


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.


The label width, in the unit specified in labelWidthUnit.


The specified units for labelWidth, if labelPosition is left.

Values
%

Percent.

px

Pixels.

col

Columns.


Whether the label can wrap to multiple lines.


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


The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.


The maximum number of items to allow.


The minimum number of items to allow.


pluginType

string

The plugin type.


Whether a value is required.


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.


An optional string to filter the displayed options. Matches values or labels if provided.


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.


Whether to show a footer that displays selected items and allows users to select and clear all items.


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


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.


tooltipByIndex

string[]

A list of tooltips for each item, by index.


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.


Methods

JavaScript API methods for interacting with Multiselect Listbox. 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.

multiselectListbox.clearValidation()

clearValue

Clear the current values.

multiselectListbox.clearValue()

focus

Set focus on the input field.

multiselectListbox.focus()

resetValue

Reset the current value to the default value.

multiselectListbox.resetValue()

scrollIntoView

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

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

multiselectListbox.setDisabled(disabled)
Parameters

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.

multiselectListbox.setHidden(hidden)
Parameters

boolean

Whether the component is visible.



setValue

Set the current value.

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

change

The value is changed.


clear

The value is cleared.