Dropdown Button

A dropdown menu of options to trigger queries and other actions. It supports manual configuration or mapped evaluation of options, loading and disabled states, and solid and outline styles.

Properties

Available properties for Dropdown Button with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.

NameTypeDescriptioncaptionByIndexstring[]

A list of captions for each item, by index.

clickableboolean

Whether the component has an enabled Click event handler.

data{ [key: string]: unknown }[]

The source data for the component.

disabledboolean

Whether user input, interaction, or selection is disabled.

disabledByIndexboolean[]

A list of boolean values for each item, by index, that reflect whether they are disabled.

hiddenboolean

Whether the component is visible.

hiddenByIndexboolean[]

A list of boolean values for each item, by index, that reflect whether they are hidden.

horizontalAlign'stretch' | 'left' | 'center' | 'right'

The horizontal alignment of the contents.

iconIconKey

The icon to display.

iconByIndexIconKey[]

A list of icons for each item, by index.

iconPosition'left' | 'right' | 'replace'

The position of the icon relative to the label.

itemMode'dynamic' | 'static'

The configuration mode for option lists. Either dynamic for mapped options or static for manual options.

labelsstring[]

A list of labels for each item. Falls back to the corresponding value if no label is provided.

maintainSpaceWhenHiddenboolean

Whether the component takes up space on the canvas if hidden is true.

marginstring

The amount of margin to render outside of the component.

overlayMaxHeightnumber | null

The maximum height of the dropdown, in px.

overlayMinWidthnumber | null

The minimum width of the dropdown, in px.

showInEditorboolean

Whether the component remains visible in the editor if hidden is true.

textstring

The primary text content.

tooltipByIndexstring[]

A list of tooltips for each item, by index.

tooltipTextstring

The text to display in a tooltip on hover or focus.

Events

Events are triggered by user interactions with Dropdown Button. Use event handling to trigger queries or other actions in response to events.

NameDescriptionClick

A user clicks the component.

Methods

Methods for interacting with Dropdown Button. You can write JavaScript almost anywhere in Retool and use methods to manipulate data or components.

NameDescriptionscrollIntoView(options: any)

Scrolls the canvas or parent container so that the selected component appears in the visible area.

setHidden(hidden: boolean)

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

setDisabled(disabled: boolean)

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.