Skip to main content

Combobox

Ant Design

The Combobox component is a dropdown that users can type in to search its options, such as picking a city or a customer from a long list.

Properties​

Property
Description
Expected Value
LabelText shown above the field, or beside it when Layout is horizontal.Text. Default: City
ExtraHelp text shown under the field. A validation message replaces it while the value is invalid.Text
TooltipText shown when the user hovers over an info icon after the label.Text
Layoutvertical puts the label above the field; horizontal puts it at the left.vertical, horizontal. Default: vertical
OptionsThe choices, as plain values or a list of {label, value}. Add disabled: true to show an option that can't be picked.Array
ValueValue of the option selected when the app loads. A value no option has is cleared. Reset field returns to this value.Text
PlaceholderHint shown in the field while nothing is selected.Text. Default: Search
Not found contentMessage shown in the list when no option matches the search.Text. Default: No matches
Allow clearShows a button in the field that clears the selection.On or off. Default: On
Filter optionShows only the options whose label contains the typed text. Turn it off when a query fetches the options as the user types, reading searchValue.On or off. Default: On
VariantStyle of the field box. outlined has a border, filled has a gray fill, borderless has neither, and underlined has only a bottom line.outlined, filled, borderless, underlined. Default: outlined
SizeHeight and text size of the field.small, middle, large. Default: middle

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 changeTriggers when the selected option changes, by the user or an action.
On selectTriggers when the user picks an option.
On searchTriggers when the user types in the field to search.
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
Set field valueSelects the option with the given Value and fires On change.components.combobox1.setFieldValue("")
Reset fieldReturns the selection to the Value property's value.components.combobox1.resetFields()
FocusMoves keyboard focus to the field.components.combobox1.focus()
BlurRemoves keyboard focus from the field.components.combobox1.blur()
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, or beside it when Layout is horizontal.{{components.combobox1.label}}
extraHelp text shown under the field. A validation message replaces it while the value is invalid.{{components.combobox1.extra}}
tooltipText shown when the user hovers over an info icon after the label.{{components.combobox1.tooltip}}
layoutvertical puts the label above the field; horizontal puts it at the left.{{components.combobox1.layout}}
optionsThe choices, as plain values or a list of {label, value}. Add disabled: true to show an option that can't be picked.{{components.combobox1.options}}
valueValue of the option selected when the app loads. A value no option has is cleared. Reset field returns to this value.{{components.combobox1.value}}
placeholderHint shown in the field while nothing is selected.{{components.combobox1.placeholder}}
notFoundContentMessage shown in the list when no option matches the search.{{components.combobox1.notFoundContent}}
allowClearShows a button in the field that clears the selection.{{components.combobox1.allowClear}}
filterOptionShows only the options whose label contains the typed text. Turn it off when a query fetches the options as the user types, reading searchValue.{{components.combobox1.filterOption}}
variantStyle of the field box. outlined has a border, filled has a gray fill, borderless has neither, and underlined has only a bottom line.{{components.combobox1.variant}}
sizeHeight and text size of the field.{{components.combobox1.size}}
selectedOptionThe selected option, as {label, value}. It is empty when nothing is selected.{{components.combobox1.selectedOption}}
selectedLabelLabel of the selected option.{{components.combobox1.selectedLabel}}
searchValueText the user has typed to search. It empties when the list closes.{{components.combobox1.searchValue}}
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
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
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.