The List View component for Retool Apps

A list that renders each item from an array of data using a custom-built row of components.

Version: Cloud and 3.179 Edge

This is a legacy component that is no longer supported. Use the newer version of this component which has more features and functionality.

List View supports unique row keys and displays rows using dynamic or fixed height. Rows can contain any combination of components to customize how data is interacted with or presented.

Demo

Settings

LegacyListView includes the following configurable options when building apps in the IDE.

DataDynamic heightForm data keyHeightHiddenNameItem heightItem widthLayoutColumnsOverflowPaddingShow borderShow drop shadowstyle

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.

data

The data.

Type	array
Format	Custom data
Mutability	Control Usage Retool UI Inspector Method copyToClipboard()

---

direction

The layout of content.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description row Horizontal row layout. column Vertical column layout.

---

dynamicHeightsEnabled

Whether list item height is dynamically set.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

formDataKey

The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Interaction
Default	{{ self.id }}

Examples

table1.selectedRow.id

---

heightType

Whether the height automatically adjusts to fit content or is a fixed size.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Spacing
Allowed Values	Value Description fixed Fixed height. auto Expand to fit content.
Default	fixed

---

hidden

Whether this object is hidden from view.

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

Examples

true

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	legacyListView1

Examples

query1

button1

---

instances

The number of instances.

Type	number
Mutability	Read-only

---

itemHeight

The height of each item.

Type	number
Mutability	Control Usage Retool UI Inspector

---

itemWidth

The width of each item.

Type	number
Mutability	Control Usage Retool UI Inspector

---

layoutType

The layout type.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description list List layout. grid Grid layout.

---

numColumns

The number of columns to display.

Type	number
Mutability	Control Usage Retool UI Inspector

---

overflowType

The overflow behavior when the contents exceeds the height.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description scroll Display a scrollbar. pagination Use pagination.

---

padding

The amount of padding to render inside.

Type	number
Mutability	Control Usage Retool UI Inspector

---

showBorder

Whether to show a border.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

showDropShadow

Whether to show a drop shadow.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

legacyListView.scrollIntoView()

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

Definition

legacyListView.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 legacyListView into view.

legacyListView.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

Events

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