The Toggle Link web component
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.
Settings
Toggle Link includes the following configurable options when building apps in the IDE.
DisabledEvent handlersAlignShow 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.
Properties
event
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 |
false | A user sets the value to |
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
The JavaScript method to perform when type
is datasource
, widget
, state
, or localStorage
.
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
Whether the object is globally scoped for use in all app pages.
horizontalAlign
The horizontal alignment of the contents.
Values
left | Left alignment. |
center | Center alignment. |
right | Right alignment. |
stretched | Justified alignment |
iconForFalse
The icon to display when value
is false
.
Values
You can select an icon or dynamically set one with a valid icon key.
iconForTrue
The icon to display when value
is true
.
Values
You can select an icon or dynamically set one with a valid icon key.
iconPosition
The position of the icon relative to the label.
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
loaderPosition
The position of the loading indicator if loading
is true
.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
styleVariant
The button variant to use.
Values
solid | Solid background color. |
outline | Button outline only. |
tooltipText
The tooltip text to display.
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
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
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.
setHidden
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
component.setHidden(hidden)