The Dropdown Button web component
A dropdown menu with buttons to trigger actions when clicked..
Settings
Dropdown Button includes the following configurable options when building apps in the IDE.
DataDisabledEvent handlersAlignIconShow on desktopShow on mobileOptionsMaintain space when hiddenMarginMax list heightMin list widthAlways show in edit modeStylesVariantTextHelper text |
Properties
All properties for Dropdown Button with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
clickable
Whether there is an enabled Click event handler.
disabledByIndex
A list of boolean values for each item, by index, that reflect whether they are disabled.
Properties
event
The event type.
Values
change | A user changes the value. |
click | A user clicks or taps the component. |
submit | A user submits the value. |
focus | A user selects the input field. |
blur | A user deselects the input field. |
scan | A user scans a barcode. |
open | A user opens the component. |
close | A user closes the component. |
true | A user sets the value to |
false | A user sets the value to |
select | A user selects a value. |
clear | A user clears the value. |
upload | A user uploads a file. |
parse | An uploaded file is parsed. |
inputValueChange | A user changes the value of the input field. |
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). |
global
Whether the object is globally scoped for use in all app pages.
horizontalAlign
The horizontal alignment of the contents.
Values
left | Left alignment. |
center | Center alignment. |
right | Right alignment. |
stretched | Justified alignment |
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.
iconPosition
The position of the icon relative to the label.
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
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. |
labels
A list of labels for each item. Falls back to the corresponding value
if no label is provided.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
overlayMaxHeight
The maximum height of the dropdown, in pixels.
overlayMinWidth
The minimum width of the dropdown, in pixels.
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
styleVariant
The button variant to use.
Values
solid | Solid background color. |
outline | Button outline only. |
tooltipByIndex
A list of tooltips for each item, by index.
tooltipText
The tooltip text to display.
Methods
JavaScript API methods for interacting with Dropdown Button. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
component.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. |
setDisabled
Set the disabled
value to toggle whether the input field is disabled. Defaults to true
without a parameter.
setHidden
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
component.setHidden(hidden)
Parameters
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.
click
The item is clicked or pressed.