The Container web component
A container to group other components together with flexible layout controls.
Settings
Container 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 with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
clickable
Whether there is an enabled Click event handler.
currentViewIndex
The index of the selected view.
currentViewKey
The key value of the selected view.
disabledByIndex
A list of boolean values for each item, by index, that reflect whether they are disabled.
enableFullBleed
Whether the container is in full bleed mode, where it can only contain a single component which expands to fit the available space.
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.
headerPadding
The amount of padding used within the header.
heightType
Whether the height automatically resizes to fit content or is a fixed size.
Values
fixed | Fixed height. |
auto | Expand to fit content. |
hoistFetching
Whether to display a loading indicator whenever nested components are fetching data.
hovered
Whether the component is hovered.
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. |
labels
A list of labels for each item. Falls back to the corresponding value if no label is provided.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden is true.
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.
showBorder
Whether to show a border.
showHeader
Whether to show a header area.
showHeaderBorder
Whether to show a border under the header.
showInEditor
Whether to remain visible in the editor if hidden is true.
tooltipByIndex
A list of tooltips for each item, by index.
tooltipText
The tooltip text to display.
transition
The transition animation used when switching views.
Values
none | No animation. |
fade | Views fade in and out. |
slide | Views slide in and out. |
viewKeys
A list of view keys.
views
A list of views configured for the container.
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.
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
container.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. |
setCurrentView
Set the current view of the container by key.
container.setCurrentView(view)
Parameters
view
The view.
Values
day | Day |
week | Week |
month | Month |
year | Year |
list | List |
setCurrentViewIndex
Set the current view of the container by index.
container.setCurrentViewIndex(index)
Parameters
index
The index of an item.
setDisabled
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
setHidden
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
container.setHidden(hidden)
Parameters
setShowBody
Set the showBody value to toggle whether the component body is visible.
container.setShowBody(showBody)
Parameters
showBody
Whether to show the body.
setShowHeader
Set the showHeader value to toggle whether the component header is visible.
container.setShowHeader(showHeader)
Parameters
showHeader
Whether to show a header area.
showNextView
Show the next view of the container.
container.showNextView()
showNextVisibleView
Show the next visible view of the container.
container.showNextVisibleView()
showPreviousView
Show the previous view of the container.
container.showPreviousView()
showPreviousVisibleView
Show the previous visible view of the container.
container.showPreviousVisibleView()
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.
change
The value is changed.
click
The item is clicked or pressed.