The Legacy Cascader component for Retool Apps
An input field to select options using a dropdown menu or manually enter a value in a multi-level tree structure.
This component is considered legacy and will be deprecated in the future. Use the newer version of the Cascader component, which has more features available.
Properties
All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Disabled |
| Default | false |
Examples
true
displayValue
A list of values in nested order.
| Type | array |
| Array values | string |
| Configurability | Read-only |
| Default | null |
events
A list of configured event handlers that trigger actions or queries.
| Type | array |
| Array values | object |
| Configurability | Inspector > Interaction > Event handlers |
| Default | null |
Array Object Properties
event
The event that triggers the action. Refer to the events section for details of available events for this object.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Event |
| Default | null |
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Run script actions |
| Default | null |
type
The type of action to perform.
| Type | string | ||||||||||||||
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Action | ||||||||||||||
| Allowed Values |
| ||||||||||||||
| Default | null |
formDataKey
The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Interaction > Form data key |
| Default | {{ self.id }} |
Examples
table1.selectedRow.id
hideClearButton
Whether to hide the button that allows users to clear the value.
| Type | boolean |
| Configurability | Inspector |
| Default | null |
id
The unique identifier (name).
| Type | string |
| Format | Plain Text |
| Configurability | Inspector |
| Default | legacyCascader1 |
Examples
query1
button1
isHiddenOnDesktop
Whether to show or hide this object in the desktop layout.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Show on desktop |
| Default | false |
Examples
true
isHiddenOnMobile
Whether to show or hide this object in the mobile layout.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Show on mobile |
| Default | true |
Examples
true
maintainSpaceWhenHidden
Whether to take up space on the canvas if hidden is true.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Maintain space when hidden |
| Default | false |
Examples
true
margin
The amount of margin to render outside.
| Type | string | |||||||||
| Format | Plain Text | |||||||||
| Configurability | Inspector > Spacing > Margin | |||||||||
| Allowed Values |
| |||||||||
| Default | 4px 8px |
Examples
4px 8px
onSelect
The event handler that runs when a value is selected.
| Type | string |
| Configurability | Read-only |
| Default | null |
placeholder
The text to display within the input field when there is no value.
| Type | string |
| Format | string |
| Configurability | Inspector > Content > Placeholder |
| Default | Enter a value |
Examples
Enter a value
required
Whether a value is required to be selected.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Validation rules > Required |
| Default | false |
Examples
true
showInEditor
Whether the component remains visible in the editor if hidden is true.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Always show in edit mode |
| Default | false |
Examples
true
tooltipText
The tooltip text to display next to the label on hover.
| Type | string |
| Format | Markdown |
| Configurability | Inspector > Content > Add-ons > Helper text |
| Default | null |
Examples
Submit
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
legacyCascader.clearValue()
Clear the current values.
legacyCascader.clearValue()
Examples
Clear the current value of legacyCascader.
legacyCascader.clearValue();
legacyCascader.scrollIntoView()
Scrolls the canvas or parent container so that the selected component appears in the visible area.
legacyCascader.scrollIntoView(options)
Parameters
Object Properties
behavior
The scroll behavior.
| Type | string | ||||||
| Allowed Values |
|
block
The scroll position relative to the component.
| Type | string | ||||||||||
| Allowed Values |
|
Examples
Scroll the minimum amount to immediately bring legacyCascader into view.
legacyCascader.scrollIntoView({behavior: 'auto', block: 'nearest'});
legacyCascader.setValue()
Set the current value.
legacyCascader.setValue(key, value)
Examples
Set the current value of legacyCascader to userValue.
legacyCascader.setValue(userValue);
Events
Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.
| Event | Description |
|---|---|
| Change | The value is changed. |