The Link List component for Retool Apps

A group of links to trigger actions when clicked.

Version: Self-hosted 3.114 Stable

Demo

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	Control Usage Retool UI Inspector > Interaction
Default	false

Examples

true

---

disabled

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction Method setDisabled()
Default	false

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	Control Usage Retool UI Inspector > Appearance
Allowed Values	Value UI Option Description multiColumn Tree Display items in multiple columns based on the number of items and size. singleColumn Single column Always display items in a single column. wrap Wrap Wrap items. auto Auto Automatically display items in multiple columns based on the number of items and size.
Default	auto

---

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"]

---

labelPosition

The position of the label relative to the input field or value.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label
Allowed Values	Value UI Option Description top Top Above the input field or value. left Left Left of the input field or value.
Default	left

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"]

---

minColumnWidth

The minimum width of a column when using a multi-column layout.

Type	number
Format	number
Mutability	Control Usage Retool UI Inspector > Appearance
Default	null

Examples

100

---

showUnderline

Whether to show a text underline.

Type	string
Format	string
Mutability	Control Usage Retool UI Inspector > Appearance
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
Mutability	Control Usage Retool UI Inspector > Appearance

---

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	Control Usage Retool UI Inspector > Content > Add-ons
Default	null

Examples

Submit

---

underlineStyle

The style of the text underline.

Type	string
Mutability	Control Usage Retool UI 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

---

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.

Definition

linkList.scrollIntoView(options)

Parameters

options Required

object

The scroll options.

Object Properties

behavior Required

string

The scroll behavior.

Supported Values

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

block Required

string

The scroll position relative to the component.

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

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.

Definition

linkList.setDisabled(disabled)

Parameters

disabled

boolean

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

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.

Definition

linkList.setHidden(hidden)

Parameters

hidden

boolean

Whether this object is hidden from view.

Examples

Hide linkList.

linkList.setHidden(true);

Unhide linkList.

linkList.setHidden(false);

---

Events

Events triggered by user interactions. Use event handlers to trigger queries or other actions in response to events.

click

An item is clicked or pressed.

---