The Container component for Retool Mobile
A container to group other components.
Properties
All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
align
The horizontal alignment of the contents.
| Type | string | ||||||||
| Format | Plain Text | ||||||||
| Configurability | Inspector | ||||||||
| Allowed Values |
| ||||||||
| Default | left |
Examples
"center"
collapsedIcon
The icon that's displayed when collapsed.
| Type | string |
| Configurability | Inspector |
| Default | null |
collapsible
Whether collapsible add-ons are configured.
| Type | boolean |
| Configurability | Inspector |
| Default | null |
cornerType
The corner style to use.
| Type | string | ||||||||
| Configurability | Inspector | ||||||||
| Allowed Values |
| ||||||||
| Default | null |
elevation
Whether items are rendered with a raised appearance.
| Type | string | ||||||
| Configurability | Inspector | ||||||
| Allowed Values |
| ||||||
| Default | null |
events
A list of configured event handlers that trigger actions or queries.
| Type | array |
| Array values | object |
| Configurability | Inspector > Interaction > Event handlers |
| Default | null |
Array Object Properties
event
The event that triggers the action. Refer to the events section for details of available events for this object.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Event |
| Default | null |
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Run script actions |
| Default | null |
type
The type of action to perform.
| Type | string | ||||||||||||||
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Action | ||||||||||||||
| Allowed Values |
| ||||||||||||||
| Default | null |
expandedIcon
The icon that's displayed when expanded.
| Type | string |
| Configurability | Inspector |
| Default | null |
gap
The gap between components.
| Type | string | ||||||||||||||||||||||||
| Configurability | Inspector | ||||||||||||||||||||||||
| Allowed Values |
| ||||||||||||||||||||||||
| Default | null |
hidden
Whether this object is hidden from view.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Hidden |
| Default | false |
Examples
true
justify
The horizontal alignment of the contents.
| Type | string | ||||||||||
| Configurability | Inspector | ||||||||||
| Allowed Values |
| ||||||||||
| Default | null |
layout
The layout of content.
| Type | string | ||||||
| Configurability | Inspector | ||||||
| Allowed Values |
| ||||||
| Default | null |
padding
The amount of padding to render inside.
| Type | string | ||||||
| Format | Plain Text | ||||||
| Configurability | Inspector > Spacing > Padding | ||||||
| Allowed Values |
| ||||||
| Default | 4px 8px |
Examples
4px 8px
showBorder
Whether to show a border.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Show border |
| Default | false |
Examples
true
widthGrowFactor
Sets the width grow factor of a width item's main width size, similar to the flex-grow CSS property.
| Type | unknown |
| Configurability | Read-only |
| Default | null |
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
container.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
container.setHidden(hidden)
Parameters
Examples
true
Examples
Hide container.
container.setHidden(true);
Unhide container.
container.setHidden(false);
Events
Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.
| Event | Description |
|---|---|
| Click | An item is clicked or pressed. |