Multiselect Listbox
A list to select multiple values. It can perform validation of required field, minimum or maximum selection, and custom rules.
Multiselect Listbox can display a footer with selection count and buttons to select or clear all values.
Properties
Available properties for Multiselect Listbox with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.
The currently selected values
Whether to automatically assign a color to each item.
A list of captions for each item, by index.
A list of colors for each item, by index.
The source data for the component.
Whether user input, interaction, or selection is disabled.
A list of boolean values for each item, by index, that reflect whether they are disabled.
A list of values not available for selection.
The message to display if no value is set.
A list of values to use as fallback text for each option. Only the first two characters are displayed. If multiple words are provided, the first letter of each word is used.
The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.
Whether the component is visible.
A list of boolean values for each item, by index, that reflect whether they are hidden.
Whether to hide the validation message if the invalid is true.
A list of icons for each item, by index.
A list of images for each item, by index.
Whether the current value has failed any validation rules.
The adornment shape.
The adornment size.
The configuration mode for option lists. Either dynamic for mapped options or static for manual options.
The text to display as a label for the input field.
The horizontal alignment of the label.
The additional text to display with the label.
The position of the label relative to the input field.
The label width, in the unit specified in labelWidthUnit.
The specified units for labelWidth.
Whether the label can wrap to multiple lines.
A list of labels for each item. Falls back to the corresponding value if no label is provided.
Whether the component takes up space on the canvas if hidden is true.
The amount of margin to render outside of the component.
The maximum number of items to allow.
The minimum number of items to allow.
Whether the input is required for validation.
The type of search to perform.
The search term currently filtering items.
A list of currently selected values, by index.
A list of currently selected items.
A list of labels for currently selected values, by index.
Whether to display a footer containing select actions.
Whether the component remains visible in the editor if hidden is true.
Whether to display an icon next to a selected item.
A list of tooltips for each item, by index.
The text to display in a tooltip on hover or focus.
The validation message to display if the input is invalid.
A list of possible values.
Events
Events are triggered by user interactions with Multiselect Listbox. Use event handling to trigger queries or other actions in response to events.
A user changes the current value.
A user clears the current value.
Methods
Methods for interacting with Multiselect Listbox. You can write JavaScript almost anywhere in Retool and use methods to manipulate data or components.
Set the current value.
Clear the current value.
Scrolls the canvas or parent container so that the selected component appears in the visible area.
Validates the value of the input field.
Clear the validation message from the input field.
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
Reset value to the default value.
Set focus on the input field.