Link List

A list of links to trigger queries and other actions.

Properties

Available properties for Link List with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.

NameTypeDescriptioncaptionByIndexstring[]

A list of captions for each item, by index.

clickableboolean

Whether the component has an enabled Click event handler.

data{ [key: string]: unknown }[]

The source data for the component.

disabledboolean

Whether user input, interaction, or selection is disabled.

disabledByIndexboolean[]

A list of boolean values for each item, by index, that reflect whether they are disabled.

groupLayout'multiColumn' | 'singleColumn' | 'wrap'

The layout of grouped items.

hiddenboolean

Whether the component is visible.

hiddenByIndexboolean[]

A list of boolean values for each item, by index, that reflect whether they are hidden.

iconByIndexIconKey[]

A list of icons for each item, by index.

itemMode'dynamic' | 'static'

The configuration mode for option lists. Either dynamic for mapped options or static for manual options.

labelstring

The text to display as a label for the input field.

labelAlign'left' | 'right'

The horizontal alignment of the label.

labelCaptionstring

The additional text to display with the label.

labelPosition'left' | 'top'

The position of the label relative to the input field.

labelWidthnumber

The label width, in the unit specified in labelWidthUnit.

labelWidthUnit'%' | 'px' | 'col'

The specified units for labelWidth.

labelWrapboolean

Whether the label can wrap to multiple lines.

labelsstring[]

A list of labels for each item. Falls back to the corresponding value if no label is provided.

maintainSpaceWhenHiddenboolean

Whether the component takes up space on the canvas if hidden is true.

marginstring

The amount of margin to render outside of the component.

minColumnWidthnumber

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

showInEditorboolean

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

showUnderline'always' | 'hover' | 'never'

Whether to underline the content.

tooltipByIndexstring[]

A list of tooltips for each item, by index.

tooltipTextstring

The text to display in a tooltip on hover or focus.

underlineStyle'solid' | 'dashed' | 'dotted'

The style of the underline.

Events

Events are triggered by user interactions with Link List. Use event handling to trigger queries or other actions in response to events.

NameDescriptionClick

A user clicks the component.

Methods

Methods for interacting with Link List. You can write JavaScript almost anywhere in Retool and use methods to manipulate data or components.

NameDescriptionscrollIntoView(options: any)

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

setHidden(hidden: boolean)

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

setDisabled(disabled: boolean)

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

Related components