The Link component for Retool Apps
A link to trigger actions when clicked.
For more information about this component, refer to the Buttons and links guide.
Settings
Link includes the following configurable options when building apps in the IDE.
DisabledEvent handlersAlignSuffix iconPrefix iconShow on desktopShow on mobileLoadingMaintain space when hiddenMarginAlways show in edit modeStylesTextText sizeHelper text |
Properties
All properties for Link 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.
clickable
Whether there is an enabled Click event handler.
global
Whether the object is globally scoped for use in all app pages.
Whether the component is visible.
horizontalAlign
The horizontal alignment of the contents.
Values
iconBefore
The prefix icon to display.
Values
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
.
showUnderline
How to underline each item in A list.
Values
tooltipText
The tooltip text to display.
underlineStyle
The style of the underline.
Values
Methods
JavaScript API methods for interacting with Link. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
component.scrollIntoView(scrollIntoViewOptions)
Parameters
setDisabled
Set the disabled
value to toggle whether the input field is disabled. Defaults to true
without a parameter.
component.setDisabled(disabled)
Parameters
setHidden
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
component.setHidden(hidden)
Parameters
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
The item is clicked or pressed.