The Toggle Link component for Retool Apps

A toggle link to trigger different actions when clicked.

Toggle Link is a clickable text link with boolean value that triggers event handlers, such as running a query or displaying a notification.

For more information about this component, refer to the Buttons and links guide.

Demo

Settings

Toggle Link includes the following configurable options when building apps in the IDE.

DisabledEvent handlersHiddenAlignShow on desktopShow on mobileLoadingMaintain space when hiddenMarginAlways show in edit modeStylesVariantTextHelper textValue

Properties

All properties for Toggle Link 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. Refer to the events section for a list of supported events.

---

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.

---

horizontalAlign

enum

The horizontal alignment of the contents.

Values

left	Left alignment.
center	Center alignment.
right	Right alignment.
stretched	Justified alignment

---

iconForFalse

enum

The icon to display when value is false.

Values

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

Demo

---

iconForTrue

enum

The icon to display when value is true.

Values

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

Demo

---

iconPosition

The position of the icon relative to the label.

---

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.

---

loaderPosition

The position of the loading indicator if loading is true.

---

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.

---

style

object

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

---

styleVariant

enum

The button variant to use.

Values

solid	Solid background color.
outline	Button outline only.

---

text

string

The primary text content.

---

tooltipText

string

The tooltip text to display.

---

value

boolean

The value.

---

Methods

JavaScript API methods for interacting with Toggle Link. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

clearValue

Clear the current values.

component.clearValue()

---

resetValue

Reset the current value to the default value.

component.resetValue()

---

scrollIntoView

Scrolls the canvas or parent container so that the selected component appears in the visible area.

component.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

---

block

enum

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.

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

component.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---

setValue

Set the current value.

component.setValue(value)

Parameters

value

boolean

The value.

---

---

toggle

Toggle the current value between true and false

component.toggle()

---

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.

change

The value is changed.

---

false

The value is set to false.

---

true

The value is set to true.

---