Skip to main content

The List Collection mobile layout

A content area to display items in a grid or list.

List Collection

Settings

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

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

List Collection presents a list of options in the specified layout. Options are dynamically mapped from a query, transformer, or any other data source.

GeneralSizeTypeScroll
ContentDataOptions
InteractionEvent handlersEnable server side pagination
AppearanceElevationShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeShow separatorStyles

Properties

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

bodyByIndex

string[]

A list of item captions, by index.

The size of cards to display if cardType is media.

Values
full

Display full-size cards.

half

Display half-size cards.

The card style to use.

Values
flat

No border or shadow.

elevated

Include a border and shadow.

The type of cards to display.

Values
compact

Display as a list.

media

Display as cards.

data

any[]

The source data.

events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

The event type.

Values

A user changes the value.

A user clicks or taps the component.

A user submits the value.

A user selects the input field.

A user deselects the input field.

A user scans a barcode.

A user opens the component.

A user closes the component.

A user sets the value to true.

A user sets the value to false.

10

A user selects a value.

11

A user clears the value.

12

A user uploads a file.

13

An uploaded file is parsed.

14

A user changes the value of the input field.

change

A user changes the value.

click

A user clicks or taps the component.

submit

A user submits the value.

focus

A user selects the input field.

blur

A user deselects the input field.

scan

A user scans a barcode.

open

A user opens the component.

close

A user closes the component.

true

A user sets the value to true.

false

A user sets the value to false.

select

A user selects a value.

clear

A user clears the value.

upload

A user uploads a file.

parse

An uploaded file is parsed.

inputValueChange

A user changes the value of the input field.

method

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

The type of action to perform.

Values

Control query.

Control component.

Run script.

Set variable.

Set localStorage.

Perform utility action (e.g., Open URL or Confetti).

datasource

Control query.

widget

Control component.

script

Run script.

state

Set variable.

localStorage

Set localStorage.

util

Perform utility action (e.g., Open URL or Confetti).

boolean

Whether the component is visible.

id

string

The name.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

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

Values
dynamic

Options dynamically mapped from an array.

manual

Options manually configured in the IDE.

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.

pluginType

string

The plugin type.

iconByIndex

enum[]

A list of icons for each item, by index.

Values

You can select an icon or dynamically set one with a valid icon key.

prefixIconColorByIndex

string[]

A list of icon colors, by index.

prefixImageFitByIndex

string[]

A list of image fit settings, by index.

prefixImageShapeByIndex

string[]

A list of image shape settings, by index.

prefixImageSizeByIndex

string[]

A list of image aspect rations, by index.

prefixImageSourceByIndex

string[]

A list of image sources, by index.

prefixTypeByIndex

string[]

A list of prefix types, by index.

The direction for which items scroll.

Values
horizontal

Scroll horizontally.

vertical

Scroll vertically.

selectedIndex

number

The selected value, by index.

selectedItem

object

The selected item.

selectedPageIndex

number

The selected page, by index.

Whether to use server-side pagination.

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

Whether the show a separating line betweeen items.

style

object

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

subtitleByIndex

string[]

A list of item body text, by index.

subtitleLengthByIndex

number[]

A list of maximum lines to display values, by index.

iconByIndex

enum[]

A list of icons for each item, by index.

Values

You can select an icon or dynamically set one with a valid icon key.

suffixTextByIndex

string[]

A list of suffix text, by index.

suffixTypeByIndex

string[]

A list of action types, by index.

suffixValueByIndex

boolean[]

A list of boolean values, by index.

titleByIndex

string[]

A list of item titles, by index.

Methods

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

setHidden

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

listCollection.setHidden(hidden)
Parameters

boolean

Whether the component is visible.

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

buttonPress

A user clicks or presses the item's button.

checkboxPress

A user toggles the item's checkbox.

press

A user clicks or presses an item.

switchPress

A user toggles the item's switch.