The Grid View component for Retool Apps

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

Grid View is a preset version of List View. It has been preconfigured to use a grid layout.

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

Demo

Settings

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

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

Properties

All properties for Grid 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.

---

enableInstanceValues

boolean

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.

---

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.

---

instanceValues

any[]

A list of instance values.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

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.

---

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 Grid 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.

gridView.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.

gridView.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.

gridView.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---