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.
Retool recently released this improved version of the Cascader component. Use of the legacy Cascader component is discouraged.
Refer to the selection input guide for more information on using this component.
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.
automaticItemColors
Whether to automatically assign a color to each item.
captionByIndex
A list of captions for each item, by index.
colorByIndex
A list of colors for each item, by index.
customValidation
The custom validation message to display if the invalid
is true
.
disabledByIndex
A list of boolean values for each item, by index, that reflect whether they are disabled.
disabledValues
A list of values not available for selection.
emptyMessage
The message to display if no value is set.
fallbackTextByIndex
A list of values to use as fallback text for each option.
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.
heightType
Whether the height automatically resizes to fit content or is a fixed size.
Values
fixed | Fixed height. |
auto | Expand to fit content. |
Whether the component is visible.
hiddenByIndex
A list of items, by index, and whether they are hidden.
Whether to hide the validation message if the invalid
is true
.
Values
You can select an icon or dynamically set one with a valid icon key.
iconBefore
The prefix icon to display.
Values
You can select an icon or dynamically set one with a valid icon key.
iconByIndex
A list of icons for each item, by index.
Values
You can select an icon or dynamically set one with a valid icon key.
id
The unique identifier.
imageByIndex
A list of images for each item, by index.
invalid
Whether the value has failed any validation rules.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
The adornment shape.
Values
circle | Sets the item adornment to a circle. |
square | Sets the item adornment to a square. |
The adornment size.
Values
auto | Automatically adjusts the item adornment size. |
small | Sets the item adornment size to small. |
large | Sets the item adornment size to large. |
The configuration mode for option lists. Either dynamic
for mapped options or static
for manual options.
Values
dynamic | Options dynamically mapped from an array. |
manual | Options manually configured in the IDE. |
keyByIndex
A list of IDs, by index, for each item.
labelAlign
The horizontal alignment of the label.
Values
left | Left of the input field. |
top | Above the input field. |
labelCaption
The label for the node.
labelPosition
The position of the label relative to the input field or value.
Values
top | Above the input field or value. |
left | Left of the input field or value. |
labels
A list of labels for each item. Falls back to the corresponding value
if no label is provided.
labelWidth
The label width, in the unit specified in labelWidthUnit
.
labelWidthUnit
The specified units for labelWidth
, if labelPosition
is left
.
Values
% | Percent. |
px | Pixels. |
col | Columns. |
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
overflowType
The overflow behavior when the contents exceeds the height.
Values
scroll | Display a scrollbar. |
pagination | Use pagination. |
overlayMaxHeight
The maximum height of the dropdown, in pixels.
overlayMinWidth
The minimum width of the dropdown, in pixels.
parentKeyByIndex
A list of parent keys for each item, by index.
placeholder
The text to display within the input field when there is no value.
pluginType
The plugin type.
searchMode
The type of search to perform.
Values
fuzzy | Searches using fuzzy logic. |
caseInsensitive | Ignores the case used in search terms. |
caseSensitive | Matches the case used in search terms. |
showInEditor
Whether to remain visible in the editor if hidden
is true
.
textBefore
The prefix text to display.
tooltipByIndex
A list of tooltips for each item, by index.
tooltipText
The tooltip text to display.
validationMessage
The validation message to display if invalid
is true
.
valuePath
The path of values to the final value of the component.
values
A list of possible values.
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.