Skip to main content

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.

Demo

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.

Whether the container is in full bleed mode, where it can only contain a single component which expands to fit the available space.

footerPadding​

string

The amount of padding used within the footer.

global​

boolean

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

headerPadding​

string

The amount of padding used within the header.

​

boolean

Whether the component is visible.

id​

string

The unique identifier.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

loading​

boolean

Whether to display a loading indicator.

Whether the component takes up space on the canvas if hidden is true.

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.

Whether to show a border.

Whether to show a footer area.

Whether to show a border above the footer.

Whether to show a header area.

Whether to show a border under the header.

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.

width​

number

The width.

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

​

boolean

Whether the component is visible.

showFooter​

Set the showFooter value to toggle whether the component footer is visible.

sidebar.showFooter(showFooter)
Parameters

Whether to show a footer area.

showHeader​

Set the showHeader value to toggle whether the component header is visible.

sidebar.showHeader(showHeader)
Parameters

Whether to show a header area.