The Sidebar frame
A container that renders on the left-side of the viewport.
The Sidebar frame is a container that appears as next to the Main frame. Sidebar can automatically configure an optimized mobile layout when viewing web apps on devices with smaller screens. Only one instance of Sidebar can be used.
Try it out
Try out a demo of the Sidebar frame.
Settings
Sidebar includes the following configurable options when building apps in the IDE.
Expand contents to fitShow on desktopShow on mobileLoadingMaintain space when hiddenMarginShow borderFooterShow borderHeaderShow borderAlways show in edit modeStylesWidth |
Properties
All properties for Sidebar with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
enableFullBleed
Whether the container is in full bleed mode, where it can only contain a single component which expands to fit the available space.
global
Whether the object is globally scoped for use in all app pages.
headerPadding
The amount of padding used within the header.
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
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
.
Methods
JavaScript API methods for interacting with Sidebar. 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.
sidebar.setHidden(hidden)
Parameters
showHeader
Set the showHeader
value to toggle whether the component header is visible.
sidebar.showHeader(showHeader)
Parameters
showHeader
Whether to show a header area.