The Link List component for Retool Apps
A group of links to trigger actions when clicked.
For more information about using the Link List 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.
captionByIndex
A list of captions for each item, by index.
Type | array |
Format | Plain Text |
Array values | string |
Mutability | Read-only |
Default |
|
Examples
["Caption 1", "Caption 2"]
clickable
Whether there is an enabled Click event handler.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
true
disabled
Whether input, interaction, selection, or triggering is disabled.
Type | boolean | ||||||
Format | True/False | ||||||
Mutability |
| ||||||
Default |
|
Examples
true
disabledByIndex
A list of values for each item, by index, that reflect whether they are disabled.
Type | array |
Array values | boolean |
Mutability | Read-only |
Default |
|
Examples
[true, false, true]
groupLayout
The layout of grouped items.
Type | string | |||||||||||||||
Mutability |
| |||||||||||||||
Allowed Values |
| |||||||||||||||
Default |
|
hiddenByIndex
A list of items, by index, and whether they are hidden.
Type | array |
Array values | boolean |
Mutability | Read-only |
Default |
|
Examples
[true, false, true]
iconByIndex
A list of icons for each item, by index.
Type | array |
Array values | string |
Mutability | Read-only |
Default |
|
Examples
["/icon:bold/shopping-gift", "/icon:bold/interface-user-single", "/icon:bold/interface-align-layers-1"]
id
The unique identifier (name).
Type | string | ||||
Format | Plain Text | ||||
Mutability |
| ||||
Default |
|
Examples
query1
button1
isHiddenOnDesktop
Whether to show or hide this object in the desktop layout.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
true
isHiddenOnMobile
Whether to show or hide this object in the mobile layout.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
true
labelPosition
The position of the label relative to the input field or value.
Type | string | |||||||||
Format | Plain Text | |||||||||
Mutability |
| |||||||||
Allowed Values |
| |||||||||
Default |
|
Examples
top
labels
A list of labels for each item. Falls back to the corresponding value
if no label is provided.
Type | array |
Array values | string |
Mutability | Read-only |
Default |
|
Examples
["Label 1", "Label 2", "Label 3"]
maintainSpaceWhenHidden
Whether to take up space on the canvas if hidden
is true
.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
true
margin
The amount of margin to render outside.
Type | string | |||||||||
Format | Plain Text | |||||||||
Mutability |
| |||||||||
Allowed Values |
| |||||||||
Default |
|
Examples
4px 8px
minColumnWidth
The minimum width of a column when using a multi-column layout.
Type | number | ||||
Format | number | ||||
Mutability |
| ||||
Default |
|
Examples
100
showInEditor
Whether the component remains visible in the editor if hidden
is true
.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
true
showUnderline
Whether to show a text underline.
Type | string | ||||||||||||
Format | string | ||||||||||||
Mutability |
| ||||||||||||
Allowed Values |
| ||||||||||||
Default |
|
Examples
hover
style
Custom style options.
Type | object | ||||
Mutability |
|
tooltipByIndex
A list of tooltips for each item, by index.
Type | array |
Array values | string |
Mutability | Read-only |
Default |
|
Examples
["Tooltip 1", "Tooltip 2"]
tooltipText
The tooltip text to display next to the label on hover.
Type | string | ||||
Format | Markdown | ||||
Mutability |
| ||||
Default |
|
Examples
Submit
underlineStyle
The style of the text underline.
Type | string | ||||||||||||
Mutability |
| ||||||||||||
Allowed Values |
| ||||||||||||
Default |
|
Examples
solid
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
linkList.scrollIntoView()
Scrolls the canvas or parent container so that the selected component appears in the visible area.
linkList.scrollIntoView(options)
Parameters
Object Properties
behavior
The scroll behavior.
Type | string | ||||||
Allowed Values |
|
block
The scroll position relative to the component.
Type | string | ||||||||||
Allowed Values |
|
Examples
Scroll the minimum amount to immediately bring linkList
into view.
linkList.scrollIntoView({behavior: 'auto', block: 'nearest'});
linkList.setDisabled()
Set the disabled
value to toggle whether the input field is disabled. Defaults to true
without a parameter.
linkList.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
Type | boolean |
Format | True/False |
Default |
|
Examples
true
Examples
Disable linkList
.
linkList.setDisabled(true);
Enable linkList
.
linkList.setDisabled(false);
linkList.setHidden()
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
linkList.setHidden(hidden)
Parameters
Examples
true
Examples
Hide linkList
.
linkList.setHidden(true);
Unhide linkList
.
linkList.setHidden(false);
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 |
---|---|
Click | An item is clicked or pressed. |