Multi-select
Multi-select widget is used to capture user inputs from a specified list of permitted options. This widget captures multiple choices.

Displaying Data

Multi-select's options can be populated from a data source like an API / Query by transforming the incoming data to an array of (label, value). The transformation can be performed using javascript. So if the data is an array, we can transform it using the Array.map function.
1
// Query1.data is assumed to be an array here
2
{{ Query1.data.map((row) => {
3
return { label: row.name, value: row.id }
4
})
5
}}
Copied!

Filtering Data

A MultiSelect widget can be used to filter a dataset based on the user's input. The selected value can be passed to an API using**{{ multiselect1.selectedOptionValues }}** .
Server Side Filtering can also be enabled on the widget by enabling Server Side Filtering property.

Form Submission

Multi-select widgets can be used to capture from a fixed set of options inside a form such as gender, role, status.
Some forms need to be pre-filled data from a table or API. We can bind the data to the default text property to enable this.
1
{{ Table1.selectedRow.gender }}
2
/**
3
* Binding this to the default option will update the selected option
4
* of the MultiSelect widget with the gender of the selected row in Table1
5
*/
Copied!
Read more about submitting Input data to an API below.

Properties

Internal Property
Description
selectedOptionValues
An array of values of the options that are displayed in a Multi-Select dropdown. This value changes if the default values of the dropdown change or the user changes an option selection
selectedOptionLabels
An array of Labels of the options that are displayed in a Multi-Select dropdown. This label changes if the default values of the dropdown change or the user changes an option selection
filterText
The filter text for Server side filtering
Property
Description
Placeholder
Sets the Placeholder of the multiselect widget.
Options
Lets you set labels and values for different items/options in the list of the multiselect widget. Options must be specified as an array of objects with a label and value property.
Default Option
Sets a default option that will be captured as user input unless it is changed by the user. Multiple values can be provided as CSV or an array of value string for a Multi-Select dropdown.
Required
When turned on, it makes a user input required and disables any form submission until an input is made.
Visible
Controls widget's visibility on the page. When turned off, the widget will not be visible when the app is published
Disabled
Disables input/selection to the widget. The widget will remain visible to the user but user input/selection will not be allowed.
Server Side Filtering
Enables server side filtering of the via an API / Query request. Use this property when your Select option data is being bound to an API / Query.
Action
Description
onOptionChange
Sets the action to be run when the user selects/unselects an option. See a list of supported actions
onFilterUpdate
Trigger an action on change of filterText. See a list of supported actions
Last modified 25d ago