The Drawer frame
A container that slides in from the side of the viewport.
The Drawer frame is a container that slides into view when visible. You can add multiple instances of the Drawer frame that operate independently.
Try it out
Try out a demo of the Drawer frame.
Settings
Drawer includes the following configurable options when building apps in the IDE.
Properties
All properties for Drawer 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.
Whether to hide the dropdown when the Esc
key is pressed.
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
.
overlayInteraction
Whether to toggle hidden
to true
if the user clicks outside of the content area.
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
.
showOverlay
Whether to display a darkened overlay when visible.
Methods
JavaScript API methods for interacting with Drawer. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
hide
Hide the component.
drawer.hide()
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
drawer.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. |
setHidden
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
drawer.setHidden(hidden)
Parameters
show
Show the component.
drawer.show()
showHeader
Set the showHeader
value to toggle whether the component header is visible.
drawer.showHeader(showHeader)
Parameters
showHeader
Whether to show a header area.
toggleHidden
Toggle the hidden
value between true
and false
.
drawer.toggleHidden()