The 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.
Settings
Cascader includes the following configurable options when building apps in the IDE.
Properties
All properties for Cascader with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
displayValue
A list of values in nested order.
Properties
method
The JavaScript method to perform when type
is datasource
, widget
, state
, or localStorage
.
Values
datasource | Control query. |
widget | Control component. |
script | Run script. |
state | Set variable. |
localStorage | Set localStorage. |
util | Perform utility action (e.g., Open URL or Confetti). |
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.
global
Whether the object is globally scoped for use in all app pages.
Whether the component is visible.
Whether to hide the button that allows users to clear the value.
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
labelMaxWidth
The maximum label width, in px
.
labelPlacedOnLeft
Whether to show the label to the left.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
placeholder
The text to display within the input field when there is no value.
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
structure
A nested array of possible values.
tooltipText
The tooltip text to display.
Methods
JavaScript API methods for interacting with Cascader. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
clearValue
Clear the current values.
cascader.clearValue()
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
cascader.scrollIntoView(scrollIntoViewOptions)
Parameters
scrollIntoViewOptions
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
The scroll position relative to the component.
Values
nearest | Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view. |
start | Scrolls to position the component at the top of the visible area. |
center | Scrolls to position the component in the middle of the visible area. |
end | Scrolls to position the component at the bottom of the visible area. |
Events
Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.
change
The value is changed.