The Fab component for Retool Mobile

A floating action button to trigger actions.

Version: Cloud and 3.191 Edge

Fab floats above other content and remains at a fixed position.

Demo

Properties

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

disabled

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Disabled Method setDisabled()
Default	false

Examples

true

---

events

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

Type	array
Array values	object
Mutability	Control Usage Retool UI Inspector > Interaction > Event handlers

Array Object Properties

event

The event that triggers the action. Refer to the events section for details of available events for this object.

Type	string
Mutability	Control Usage Retool UI Inspector > Interaction > Event handlers > Event

---

method

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

Type	string
Mutability	Control Usage Retool UI Inspector > Interaction > Event handlers > Edit event handler > Run script actions

---

type

The type of action to perform.

Type	string
Mutability	Control Usage Retool UI Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values	Value Description 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).

---

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Hidden Method setHidden()
Default	false

Examples

true

---

icon

the icon to display.

Type	string
Format	Icon Key
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Icon
Default	null

Examples

/icon:bold/shopping-gift

---

loading

Whether to display a loading indicator.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Loading
Default	false

Examples

true

---

text

The primary text content.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Text

Examples

Submit

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

fab.setDisabled()

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

Definition

fab.setDisabled(disabled)

Parameters

disabled

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

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Disable fab.

fab.setDisabled(true);

Enable fab.

fab.setDisabled(false);

---

fab.setHidden()

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

Definition

fab.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide fab.

fab.setHidden(true);

Unhide fab.

fab.setHidden(false);

---

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

Event	Description
Click	An item is clicked or pressed.