The Button component for Retool Mobile

A button to trigger actions when clicked.

Demo

Settings

Button includes the following configurable options when building apps in the IDE.

DisabledEvent handlersHiddenSuffix 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.

disabled

boolean

Whether input, interaction, selection, or triggering is disabled.

---

events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

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 true.
false	A user sets the value to false.
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

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

---

type

enum

The type of action to perform.

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

boolean

Whether the object is globally scoped for use in all app pages.

---

hidden

boolean

Whether the component is visible.

---

iconAfter

enum

The suffix icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

---

iconBefore

enum

The prefix icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

---

id

string

The unique identifier.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

loading

boolean

Whether to display a loading indicator.

---

maintainSpaceWhenHidden

boolean

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

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

pluginType

string

The plugin type.

---

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

---

size

enum

The size.

Values

default	The default size.
small	The smallest size.

---

style

object

Custom style options in use. Not all style options may be available for all components.

---

submit

boolean

Whether the button submits the form specified in the submitTargetId property when clicked.

---

submitTargetId

pluginId

The form to submit when the submit property is true.

---

text

string

The primary text content.

---

type

The type of content or action to perform.

---

width

number

The width.

---

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

disabled

boolean

Whether input, interaction, selection, or triggering is disabled.

---

---

setHidden

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

button.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---

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.

---