Skip to main content

The Fab mobile component

A floating action button to trigger actions.

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

Fab

Settings

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

ContentIconText
InteractionDisabledEvent handlersLoading
AppearanceShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStyles

Properties

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

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

A user changes the value.

A user clicks or taps the component.

A user submits the value.

A user selects the input field.

A user deselects the input field.

A user scans a barcode.

A user opens the component.

A user closes the component.

A user sets the value to true.

A user sets the value to false.

10

A user selects a value.

11

A user clears the value.

12

A user uploads a file.

13

An uploaded file is parsed.

14

A user changes the value of the input field.

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.

The type of action to perform.

Values

Control query.

Control component.

Run script.

Set variable.

Set localStorage.

Perform utility action (e.g., Open URL or Confetti).

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).

boolean

Whether the component is visible.

The icon to display.

Values

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

id

string

The name.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

loading

boolean

Whether to display a loading indicator.

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

The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.

pluginType

string

The plugin type.

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

style

object

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

text

string

The primary text content.

Methods

JavaScript API methods for interacting with Fab. 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.

fab.setDisabled(disabled)
Parameters

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.

fab.setHidden(hidden)
Parameters

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

A user clicks or presses the component.