The Toggle Link component for Retool Apps

A toggle link to trigger different actions when clicked.

Version: Cloud and 3.234 Edge

Demo

For more information about using the Toggle Link component, refer to the buttons and links guide.

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.

allowWrap

Whether content can wrap to multiple lines.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Wrap text
Default	true

Examples

true

---

disabled

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

Type	boolean
Format	True/False
Configurability	Inspector > Interaction > Disabled
Default	false

Examples

true

---

events

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

Type	array
Array values	object
Configurability	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
Configurability	Inspector > Interaction > Event handlers > Event

---

method

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

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Run script actions

---

type

The type of action to perform.

Type	string
Configurability	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).

---

---

horizontalAlign

The horizontal alignment of the contents.

Type	string
Format	Plain Text
Configurability	Inspector > Appearance > Alignment
Allowed Values	Value Description left Left alignment. center Center alignment. right Right alignment. stretch Justified alignment
Default	left

---

iconPosition

The position of the icon relative to the text.

Type	string
Format	Plain Text
Configurability	Inspector > Content > Add-ons > Icon position
Allowed Values	Value UI Option Description left Left Left of text. right Right Right of text. replace Replace text Replace text.
Default	left

Examples

left

---

iconType

The icon type.

Type	string
Configurability	Inspector
Allowed Values	Value Description caret plusMinus arrow

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Configurability	Inspector
Default	toggleLink1

Examples

query1

button1

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Configurability	Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

showUnderline

Whether to show a text underline.

Type	string
Format	string
Configurability	Inspector > Appearance > Underline
Allowed Values	Value UI Option Description always Always Underline items. hover On hover Underline items on hover. never Never Never underline items.
Default	always

Examples

hover

---

style

Custom style options.

Type	object
Configurability	Inspector > Appearance > style

---

text

The primary text content.

Type	string
Format	Plain Text
Configurability	Inspector > Content > Add-ons > Text

Examples

Submit

---

tooltipText

The tooltip text to display next to the label on hover.

Type	string
Format	Markdown
Configurability	Inspector > Content > Add-ons > Helper text
Default	null

Examples

Submit

---

underlineStyle

The style of the text underline.

Type	string
Configurability	Inspector
Allowed Values	Value UI Option Description solid Solid A single line. dashed Dashed A dashed line. dotted Dotted A dotted line.
Default	solid

Examples

solid

---

value

The current value or the default value.

Type	boolean
Format	True/False
Configurability	Inspector > Content > Default value
Default	false

Examples

true

---

Methods

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

toggleLink.clearValue()

Clear the current values.

Definition

toggleLink.clearValue()

Examples

Clear the current value of toggleLink.

toggleLink.clearValue();

---

toggleLink.resetValue()

Reset the current value to the default value.

Definition

toggleLink.resetValue()

Examples

Reset the current value of toggleLink.

toggleLink.resetValue();

---

toggleLink.scrollIntoView()

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

Definition

toggleLink.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description auto Scroll immediately to the specified position. smooth Scroll gradually to the specified position.

---

block

The scroll position relative to the component.

Type	string
Allowed Values	Value Description 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.

---

---

Examples

Scroll the minimum amount to immediately bring toggleLink into view.

toggleLink.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

toggleLink.setDisabled()

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

Definition

toggleLink.setDisabled(disabled)

Parameters

disabled

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

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Disable toggleLink.

toggleLink.setDisabled(true);

Enable toggleLink.

toggleLink.setDisabled(false);

---

toggleLink.setHidden()

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

Definition

toggleLink.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide toggleLink.

toggleLink.setHidden(true);

Unhide toggleLink.

toggleLink.setHidden(false);

---

toggleLink.setValue()

Set the current value.

Definition

toggleLink.setValue(key, value)

Parameters

key

The key.

Type

string

---

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of toggleLink to userValue.

toggleLink.setValue(userValue);

---

toggleLink.toggle()

Toggle the current value between true and false.

Definition

toggleLink.toggle()

Examples

Toggle the current value of toggleLink.

toggleLink.toggle();

---

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
Change	The value is changed.
False	The value is set to false.
True	The value is set to true.