The List Collection mobile layout
A content area to display items in a grid or list.
Settings
List Collection includes the following configurable options when building apps in the IDE.
Show 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.
SizeElevationTypeDataEvent handlersShow on desktopShow on mobileOptionsMaintain space when hiddenMarginScrollEnable server side paginationAlways 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
A list of item captions, by index.
Values
full | Display full-size cards. |
half | Display half-size cards. |
Values
flat | No border or shadow. |
elevated | Include a border and shadow. |
Properties
event
The event type.
Values
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 |
false | A user sets the value to |
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
The JavaScript method to perform when type
is datasource
, widget
, state
, or localStorage
.
Values
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). |
global
Whether the object is globally scoped for use in all app pages.
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
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. |
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
pluginType
The plugin type.
prefixIconByIndex
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
A list of icon colors, by index.
prefixImageFitByIndex
A list of image fit settings, by index.
prefixImageShapeByIndex
A list of image shape settings, by index.
prefixImageSizeByIndex
A list of image aspect rations, by index.
prefixImageSourceByIndex
A list of image sources, by index.
prefixTypeByIndex
A list of prefix types, by index.
scrollDirection
The direction for which items scroll.
Values
horizontal | Scroll horizontally. |
vertical | Scroll vertically. |
selectedIndex
The selected value, by index.
selectedItem
The selected item.
selectedPageIndex
The selected page, by index.
serverPaginated
Whether to use server-side pagination.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
showSeparator
Whether the show a separating line betweeen items.
subtitleByIndex
A list of item body text, by index.
subtitleLengthByIndex
A list of maximum lines to display values, by index.
suffixIconByIndex
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
A list of suffix text, by index.
suffixTypeByIndex
A list of action types, by index.
suffixValueByIndex
A list of boolean values, by index.
titleByIndex
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
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
The item is clicked or pressed.
checkboxPress
A checkbox is toggled.
press
The item is clicked or pressed.
switchPress
A switch is toggled.