The Container component for Retool Mobile

A container to group other components.

Demo

Settings

Container includes the following configurable options when building apps in the IDE.

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

AlignCollapsed iconCollapsible add-onsCornersStyleEvent handlersExpanded iconGapHiddenShow on desktopShow on mobileAlignDirectionMaintain space when hiddenMarginShow borderAlways show in edit modeStylesWidth

Demo

Properties

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

align

enum

The horizontal alignment of the contents.

Values

left	Left alignment.
center	Center alignment.
right	Right alignment.

---

collapsedIcon

enum

The icon that's displayed when collapsed.

---

collapsible

boolean

Whether collapsible add-ons are configured.

---

cornerType

enum

The corner style to use.

Values

square	Square corners.
round	Rounded corners.

---

elevation

enum

Whether items are rendered with a raised appearance.

Values

none	No elevated style.
raised	Raised elevated style.

---

events

object[]

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

Properties

event

enum

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

---

type

enum

The type of action to perform.

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

---

---

expandedIcon

enum

The icon that's displayed when expanded.

---

gap

enum

The gap between components.

Values

0
4
8
12
16
24
32
48
64
128
256

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

hidden

boolean

Whether the component is visible.

---

id

string

The unique identifier.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

justify

enum

The horizontal alignment of the contents.

Values

left	Left alignment.
center	Center alignment.
right	Right alignment.
stretched	Justified alignment

---

layout

enum

The layout of content.

Values

row	Horizontal row layout.
column	Vertical column 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.

---

padding

number

The amount of padding to render inside.

---

pluginType

string

The plugin type.

---

showBorder

boolean

Whether to show a border.

---

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.

---

title

string

The text to display as a title.

---

width

number

The width.

---

widthGrowFactor

Sets the width grow factor of a width item's main width size, similar to the flex-grow CSS property.

---

Methods

JavaScript API methods for interacting with Container. 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.

container.setHidden(hidden)

Parameters

hidden

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.

click

The item is clicked or pressed.

---