Container List View
A flexible list of repeated components with containers.
Refer to the List View guide to learn how to use repeatable components.
Settings
Container 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 Container List View with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
enableInstanceValues
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
Whether the object is globally scoped for use in all app pages.
heightType
Whether the height automatically resizes to fit content or is a fixed size.
Values
fixed | Fixed height. |
auto | Expand to fit content. |
id
The unique identifier.
instanceValues
A list of instance values.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
layoutType
The layout type.
Values
list | List layout. |
grid | Grid layout. |
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
numColumns
The number of columns to display.
overflowType
The overflow behavior when the contents exceeds the height.
Values
scroll | Display a scrollbar. |
pagination | Use pagination. |
padding
The amount of padding to render inside.
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
Methods
JavaScript API methods for interacting with Container 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.
containerListView.scrollIntoView(scrollIntoViewOptions)
Parameters
scrollIntoViewOptions
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
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.
containerListView.scrollToIndex(index)
Parameters
index
The index of an item.
setHidden
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
containerListView.setHidden(hidden)