Skip to main content

Multi Select

Rocket 2.0

The Multi Select component lets the user pick several options from a dropdown list, such as teams, tags or regions. Picked options show as removable chips in the field.

Properties​

Property
Description
Expected Value
LabelText shown above the field.Text. Default: Teams
Help textHint text shown under the field.Text
OptionsOptions in the list. Each option has a label and a value, and can add a description, icon, group or disabled.Array
PlaceholderText shown in the field when nothing is selected.Text. Default: Select teams...
Search placeholderHint text shown in the empty search box at the top of the list.Text. Default: Search teams...
No results textMessage shown in the list when no option matches the search.Text. Default: No team found.
Show searchShows a search box at the top of the list that filters the options as the user types.On or off. Default: On
Server-side search (options already filtered by searchText)Stops the component from filtering the options itself. Use a query that reads searchText and returns the matching options.On or off. Default: Off
Show clear buttonShows a button in the field that clears the whole selection.On or off. Default: On
Options loading stateShows a loading indicator in the list, for example while a query fetches the options.On or off. Default: Off
Default valuesValues of the options selected when the app loads.Array. Default: ["design", "engineering"]
Show select allShows a Select all option at the top of the list. It is hidden while the user searches or when Max selections is set.On or off. Default: On
Max visible chips (0 shows all)Number of chips shown in the field before the rest collapse into a +N more chip. 0 shows all of them.Number. Default: 3
Max selections (0 for no limit)Most options the user can select. Once reached, the other options are disabled. 0 means no limit.Number. Default: 0

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On selectTriggers when the user selects or deselects an option.
On search text changedTriggers when the user types in the search box.
On focusTriggers when the field gets focus.
On blurTriggers when the field loses focus.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Select optionsAdds the options with the given Values to the selection.components.multiselect1.selectOptions("")
Deselect optionsRemoves the options with the given Values from the selection.components.multiselect1.deselectOptions("")
ClearClears the selection.components.multiselect1.clear()
Set focusMoves keyboard focus to the field.components.multiselect1.setFocus()
Set blurCloses the list and removes focus from the field.components.multiselect1.setBlur()
Set valuesReplaces the selection with the options whose values are in the given array.components.multiselect1.setValues("")
Set visibilityShows the component when true, hides it when false.components.multiselect1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.multiselect1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.multiselect1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the field.{{components.multiselect1.label}}
descriptionHint text shown under the field.{{components.multiselect1.description}}
optionsOptions in the list. Each option has a label and a value, and can add a description, icon, group or disabled.{{components.multiselect1.options}}
placeholderText shown in the field when nothing is selected.{{components.multiselect1.placeholder}}
searchPlaceholderHint text shown in the empty search box at the top of the list.{{components.multiselect1.searchPlaceholder}}
emptyTextMessage shown in the list when no option matches the search.{{components.multiselect1.emptyText}}
showSearchShows a search box at the top of the list that filters the options as the user types.{{components.multiselect1.showSearch}}
serverSideSearchStops the component from filtering the options itself. Use a query that reads searchText and returns the matching options.{{components.multiselect1.serverSideSearch}}
showClearBtnShows a button in the field that clears the whole selection.{{components.multiselect1.showClearBtn}}
optionsLoadingStateShows a loading indicator in the list, for example while a query fetches the options.{{components.multiselect1.optionsLoadingState}}
defaultValueValues of the options selected when the app loads.{{components.multiselect1.defaultValue}}
showSelectAllShows a Select all option at the top of the list. It is hidden while the user searches or when Max selections is set.{{components.multiselect1.showSelectAll}}
maxVisibleChipsNumber of chips shown in the field before the rest collapse into a +N more chip. 0 shows all of them.{{components.multiselect1.maxVisibleChips}}
maxSelectionsMost options the user can select. Once reached, the other options are disabled. 0 means no limit.{{components.multiselect1.maxSelections}}
valuesThe values of the selected options.{{components.multiselect1.values}}
selectedOptionsThe selected options, each with its label and value.{{components.multiselect1.selectedOptions}}
searchTextThe text the user has typed in the search box.{{components.multiselect1.searchText}}
isVisibleWhether the component is visible.{{components.multiselect1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.multiselect1.isLoading}}
isDisabledWhether the component is disabled.{{components.multiselect1.isDisabled}}

Styles​

Style
Default
Label colorTheme: Primary text
Help text colorTheme: Placeholder text
Field backgroundTheme: Surface 1
Field text colorTheme: Primary text
Placeholder colorTheme: Placeholder text
Field border colorTheme: Default border
Accent (focus ring, checks)Theme: Brand primary
Error color (message and border)Theme: Error
Field radius—
Chip backgroundTheme: Surface 3
Chip text colorTheme: Primary text
Menu backgroundTheme: Surface 1
Menu text colorTheme: Primary text
Highlighted option backgroundTheme: Surface 3
Chip background (earlier name)—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.