The Button component for Retool Mobile
A button to trigger actions when clicked.
Settings
Button includes the following configurable options when building apps in the IDE.
DisabledEvent handlersSuffix iconPrefix iconShow on desktopShow on mobileLoadingMaintain space when hiddenMarginAlways show in edit modeSizeStylesTextTypeWidth |
Properties
All properties for Button with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
global
Whether the object is globally scoped for use in all app pages.
Whether the component is visible.
iconBefore
The prefix icon to display.
Values
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
submit
Whether the button submits the form specified in the submitTargetId
property when clicked.
submitTargetId
The form to submit when the submit
property is true
.
Methods
JavaScript API methods for interacting with Button. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
setDisabled
Set the disabled
value to toggle whether the input field is disabled. Defaults to true
without a parameter.
button.setDisabled(disabled)
Parameters
setHidden
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
button.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.