Skip to main content

Cascader

Ant Design

The Cascader component lets users pick from options nested in levels, one column per level, such as a region, then a country, then a city.

Properties​

Property
Description
Expected Value
LabelText shown above the field, or beside it when Layout is horizontal.Text. Default: Location
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 a list of {label, value, children}, where children holds the next level's options. Add disabled: true to an option that can't be picked.Array
ValueThe selected path, as a list of values from the top level down, such as ['asia', 'japan']. A path the options don't hold is cleared. Reset field returns to this value.Array
PlaceholderHint shown in the field while nothing is selected.Text. Default: Pick a city
Expand triggerWhether the next level opens when the user clicks an option or hovers over it.click, hover. Default: click
Change on selectLets the user pick an option at any level, not only at the last level.On or off. Default: Off
Show searchLets the user type to search all paths.On or off. Default: Off
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 path changes, by the user or an action.

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 path given as Value, a list of values, and fires On change.components.cascader1.setFieldValue("")
Reset fieldReturns the selection to the Value property's value.components.cascader1.resetFields()
Set visibilityShows the component when true, hides it when false.components.cascader1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.cascader1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.cascader1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the field, or beside it when Layout is horizontal.{{components.cascader1.label}}
extraHelp text shown under the field. A validation message replaces it while the value is invalid.{{components.cascader1.extra}}
tooltipText shown when the user hovers over an info icon after the label.{{components.cascader1.tooltip}}
layoutvertical puts the label above the field; horizontal puts it at the left.{{components.cascader1.layout}}
optionsThe choices, as a list of {label, value, children}, where children holds the next level's options. Add disabled: true to an option that can't be picked.{{components.cascader1.options}}
valueThe selected path, as a list of values from the top level down, such as ['asia', 'japan']. A path the options don't hold is cleared. Reset field returns to this value.{{components.cascader1.value}}
placeholderHint shown in the field while nothing is selected.{{components.cascader1.placeholder}}
expandTriggerWhether the next level opens when the user clicks an option or hovers over it.{{components.cascader1.expandTrigger}}
changeOnSelectLets the user pick an option at any level, not only at the last level.{{components.cascader1.changeOnSelect}}
showSearchLets the user type to search all paths.{{components.cascader1.showSearch}}
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.cascader1.variant}}
sizeHeight and text size of the field.{{components.cascader1.size}}
isVisibleWhether the component is visible.{{components.cascader1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.cascader1.isLoading}}
isDisabledWhether the component is disabled.{{components.cascader1.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.