The Image Grid web component
A content area to display images in a grid layout.
Settings
Image Grid includes the following configurable options when building apps in the IDE.
Aspect ratioColumn countMin col widthColumn typeDataEvent handlersShow on desktopShow on mobileOptionsMaintain space when hiddenMarginAlways show in edit modeStyles |
Properties
All properties for Image Grid with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
aspectRatio
The ratio of width-to-height (e.g., 1.3
to use 4:3 ratio).
clickable
Whether there is an enabled Click event handler.
clickableByIndex
A list of boolean values for each item, by index, that reflect whether they have an enabled Click event handler.
columnCount
The number of columns to display.
columnMinWidth
The minimum width of each column if columnType
is responsive
.
columnType
The type of columns to display.
Values
fixed | Fixed width. |
responsive | Responsive width. |
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.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
srcByIndex
A list of image URLs, by index.
tooltipByIndex
A list of tooltips for each item, by index.
Methods
JavaScript API methods for interacting with Image Grid. 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.
imageGrid.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.
click
The item is clicked or pressed.