Skip to main content

Combobox

Rocket 2.0

The Combobox component is a dropdown with a search box for picking one option from a long list, such as a country or customer. Options can have descriptions, icons and group headings.

Properties​

Property
Description
Expected Value
LabelText shown above the field.Text. Default: Country
Help textHelp text shown under the field.Text
OptionsThe options to choose from: plain values, or objects with label and value and optional description, icon, group and disabled.Array
PlaceholderText shown in the field when nothing is selected.Text. Default: Select a country...
Search placeholderHint text shown in the search box.Text. Default: Search countries...
No results textText shown when no option matches the search.Text. Default: No country found.
Show searchShows a search box at the top of the option list.On or off. Default: On
Server-side search (options already filtered by searchText)Stops the component from filtering options itself. Use a query that filters the options by searchText instead.On or off. Default: Off
Show clear buttonShows a button that clears the selection.On or off. Default: On
Options loading stateShows a loading indicator in the option list, such as while a query fetches options.On or off. Default: Off
Default valueThe value of the option selected when the app loads. Changing it resets the selection.Text

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 an option or clears the selection.
On search text changedTriggers when the user changes the text 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 optionSelects the option whose value is Value, and fires On select if the selection changes.components.combobox1.selectOption("")
ClearClears the selection.components.combobox1.clear()
Set focusMoves keyboard focus to the field.components.combobox1.setFocus()
Set blurCloses the option list and removes keyboard focus from the field.components.combobox1.setBlur()
Set visibilityShows the component when true, hides it when false.components.combobox1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.combobox1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.combobox1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the field.{{components.combobox1.label}}
descriptionHelp text shown under the field.{{components.combobox1.description}}
optionsThe options to choose from: plain values, or objects with label and value and optional description, icon, group and disabled.{{components.combobox1.options}}
placeholderText shown in the field when nothing is selected.{{components.combobox1.placeholder}}
searchPlaceholderHint text shown in the search box.{{components.combobox1.searchPlaceholder}}
emptyTextText shown when no option matches the search.{{components.combobox1.emptyText}}
showSearchShows a search box at the top of the option list.{{components.combobox1.showSearch}}
serverSideSearchStops the component from filtering options itself. Use a query that filters the options by searchText instead.{{components.combobox1.serverSideSearch}}
showClearBtnShows a button that clears the selection.{{components.combobox1.showClearBtn}}
optionsLoadingStateShows a loading indicator in the option list, such as while a query fetches options.{{components.combobox1.optionsLoadingState}}
defaultValueThe value of the option selected when the app loads. Changing it resets the selection.{{components.combobox1.defaultValue}}
valueThe value of the selected option, or empty when nothing is selected.{{components.combobox1.value}}
selectedOptionThe whole selected option, with its label, value and other fields.{{components.combobox1.selectedOption}}
selectedLabelThe label of the selected option.{{components.combobox1.selectedLabel}}
searchTextThe text in the search box now.{{components.combobox1.searchText}}
isVisibleWhether the component is visible.{{components.combobox1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.combobox1.isLoading}}
isDisabledWhether the component is disabled.{{components.combobox1.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—
Menu backgroundTheme: Surface 1
Menu text colorTheme: Primary text
Highlighted option backgroundTheme: Surface 3
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.