The Multiselect component for Retool Mobile
An input field to select multiple options using a dropdown menu or manually enter values.
Settings
Multiselect includes the following configurable options when building apps in the IDE.
Custom ruleDisabledEvent handlersForm data keyShow on desktopShow on mobileLabelCaptionPositionMaintain space when hiddenMarginPlaceholderRequiredAlways show in edit modeStylesValue |
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.
customValidation
The custom validation message to display if the invalid
is true
.
Properties
event
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 |
false | A user sets the value to |
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
The JavaScript method to perform when type
is datasource
, widget
, state
, or localStorage
.
formDataKey
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
Whether the object is globally scoped for use in all app pages.
Whether to hide the validation message if the invalid
is true
.
id
The unique identifier.
invalid
Whether the value has failed any validation rules.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
labelCaption
The additional text to display with the label.
labelPosition
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
A list of labels for each item. Falls back to the corresponding value
if no label is provided.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
placeholder
The text to display within the input field when there is no value.
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
validationMessage
The validation message to display if invalid
is true
.
values
A list of possible values.
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()
setDisabled
Set the disabled
value to toggle whether the input field is disabled. Defaults to true
without a parameter.
setHidden
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
multiselect.setHidden(hidden)
Parameters
setValue
Set the current value.
validate
Validates the value of the input field.
multiselect.validate()
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.