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.

Legacy component

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.

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.

direction

enum

The layout of content.

Values

row	Horizontal row layout.
column	Vertical column layout.

dynamicHeightsEnabled

formDataKey

string

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

heightType

enum

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

Values

fixed	Fixed height.
auto	Expand to fit content.

hidden

boolean

Whether the component is visible.

id

string

The unique identifier.

instances

number

The number of instances.

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

itemHeight

number

The height of each item.

itemWidth

number

The width of each item.

layoutType

enum

The layout type.

Values

list	List layout.
grid	Grid layout.

maintainSpaceWhenHidden

boolean

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

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

numColumns

number

The number of columns to display.

overflowType

enum

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.

showBorder

boolean

Whether to show a border.

showDropShadow

boolean

Whether to show a drop shadow.

showInEditor

boolean

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.

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.