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 |
|---|---|---|
| Label | Text shown above the field. | Text. Default: Country |
| Help text | Help text shown under the field. | Text |
| Options | The options to choose from: plain values, or objects with label and value and optional description, icon, group and disabled. | Array |
| Placeholder | Text shown in the field when nothing is selected. | Text. Default: Select a country... |
| Search placeholder | Hint text shown in the search box. | Text. Default: Search countries... |
| No results text | Text shown when no option matches the search. | Text. Default: No country found. |
| Show search | Shows 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 button | Shows a button that clears the selection. | On or off. Default: On |
| Options loading state | Shows a loading indicator in the option list, such as while a query fetches options. | On or off. Default: Off |
| Default value | The 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 |
|---|---|---|
| Visibility | Shows or hides the component. Hidden components keep their space unless Collapse when hidden is on. | On or off. Default: On |
| Collapse when hidden | Removes the hidden component's space, so the components below it move up. | On or off. Default: Off |
| Loading state | Shows the component's loading look and blocks interaction, for example while a query runs. | On or off. Default: Off |
| Disable | Stops the user from interacting with the component. | On or off. Default: Off |
| Dynamic height | Lets 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 desktop | Shows the component in the desktop layout. | On or off. Default: On |
| Show on mobile | Shows 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 select | Triggers when the user selects an option or clears the selection. |
| On search text changed | Triggers when the user changes the text in the search box. |
| On focus | Triggers when the field gets focus. |
| On blur | Triggers 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 option | Selects the option whose value is Value, and fires On select if the selection changes. | components.combobox1.selectOption("") |
| Clear | Clears the selection. | components.combobox1.clear() |
| Set focus | Moves keyboard focus to the field. | components.combobox1.setFocus() |
| Set blur | Closes the option list and removes keyboard focus from the field. | components.combobox1.setBlur() |
| Set visibility | Shows the component when true, hides it when false. | components.combobox1.setVisibility(false) |
| Set disable | Disables the component when true, enables it when false. | components.combobox1.setDisable(false) |
| Set loading | Turns the loading state on with true, off with false. | components.combobox1.setLoading(false) |
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
label | Text shown above the field. | {{components.combobox1.label}} |
description | Help text shown under the field. | {{components.combobox1.description}} |
options | The options to choose from: plain values, or objects with label and value and optional description, icon, group and disabled. | {{components.combobox1.options}} |
placeholder | Text shown in the field when nothing is selected. | {{components.combobox1.placeholder}} |
searchPlaceholder | Hint text shown in the search box. | {{components.combobox1.searchPlaceholder}} |
emptyText | Text shown when no option matches the search. | {{components.combobox1.emptyText}} |
showSearch | Shows a search box at the top of the option list. | {{components.combobox1.showSearch}} |
serverSideSearch | Stops the component from filtering options itself. Use a query that filters the options by searchText instead. | {{components.combobox1.serverSideSearch}} |
showClearBtn | Shows a button that clears the selection. | {{components.combobox1.showClearBtn}} |
optionsLoadingState | Shows a loading indicator in the option list, such as while a query fetches options. | {{components.combobox1.optionsLoadingState}} |
defaultValue | The value of the option selected when the app loads. Changing it resets the selection. | {{components.combobox1.defaultValue}} |
value | The value of the selected option, or empty when nothing is selected. | {{components.combobox1.value}} |
selectedOption | The whole selected option, with its label, value and other fields. | {{components.combobox1.selectedOption}} |
selectedLabel | The label of the selected option. | {{components.combobox1.selectedLabel}} |
searchText | The text in the search box now. | {{components.combobox1.searchText}} |
isVisible | Whether the component is visible. | {{components.combobox1.isVisible}} |
isLoading | Whether the component is in its loading state. | {{components.combobox1.isLoading}} |
isDisabled | Whether the component is disabled. | {{components.combobox1.isDisabled}} |
Styles​
Style | Default |
|---|---|
| Label color | Theme: Primary text |
| Help text color | Theme: Placeholder text |
| Field background | Theme: Surface 1 |
| Field text color | Theme: Primary text |
| Placeholder color | Theme: Placeholder text |
| Field border color | Theme: Default border |
| Accent (focus ring, checks) | Theme: Brand primary |
| Error color (message and border) | Theme: Error |
| Field radius | — |
| Menu background | Theme: Surface 1 |
| Menu text color | Theme: Primary text |
| Highlighted option background | Theme: Surface 3 |
| Box shadow | 0px 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.