Skip to main content

The List View web component

A repeatable list of components with values that map to a list of data.

Refer to the List View guide to learn how to use repeatable components.

Demo

Settings​

List View includes the following configurable options when building apps in the IDE.

Show on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStyles

Properties​

All properties for List View with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

data​

any[]

The source data.

Whether to enable instance values. When true, descendent component values are evaluated with a formDataKey property for all instances, including those that haven't been evaluated yet due to virtualization. These values are aggregated on the instanceValues property.

global​

boolean

Whether the object is globally scoped for use in all app pages.

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

Values
fixed

Fixed height.

auto

Expand to fit content.

​

boolean

Whether the component is visible.

id​

string

The unique identifier.

instanceValues​

any[]

A list of instance values.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

The layout type.

Values
list

List layout.

grid

Grid layout.

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

The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.

The number of columns to display.

The overflow behavior when the contents exceeds the height.

Values
scroll

Display a scrollbar.

pagination

Use pagination.

padding​

number

The amount of padding to render inside.

pluginType​

string

The plugin type.

Whether to remain visible in the editor if hidden is true.

style​

object

Custom style options in use. Not all style options may be available for all components.

Methods​

JavaScript API methods for interacting with List View. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

clearInstanceValues​

Clear the values of all inputs in a repeatable component. Refer to the repeatables guide for more information.

listView.clearInstanceValues()

resetInstanceValues​

Reset the values of all inputs in a repeatable component to their default values. Refer to the repeatables guide for more information.

listView.resetInstanceValues()

scrollIntoView​

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

listView.scrollIntoView(scrollIntoViewOptions)
Parameters

scrollIntoViewOptions​

object

The scroll options.

Properties

behavior​

enum

The scroll behavior.

Values
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.

block​

enum

The scroll position relative to the component.

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.

scrollToIndex​

Scrolls to a specific row index.

listView.scrollToIndex(index)
Parameters

index​

number

The index of an item.

setHidden​

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

listView.setHidden(hidden)
Parameters

​

boolean

Whether the component is visible.