Skip to content
Sidebar
Overview
A configurable sidebar overlay component that can slide in from either the left or right side of the screen. Creates a responsive sidebar drawer with customizable styling, positioning, and content.
Common use cases
- Provide a unique overlay_id for each sidebar instance
- Use the visibility settings to control display on different device sizes
- Consider user experience when configuring close button visibility
- Create navigation menus, filters, or supplementary content panels
Compatible blocks
The following blocks can be nested within this block:
Block settings
General
| Setting | Description | Options |
|---|---|---|
| Show advanced settings | Reveals 6 advanced options including show close button, type, and more | Checkbox (default: false) |
Content
| Setting | Description | Options |
|---|---|---|
| Overlay preset | Select a preset overlay ID or use a custom one | • Account |
| Overlay ID | Custom identifier for the overlay (used to trigger it programmatically) | Text input |
| Show close button | Displays a close button in the sidebar | Checkbox (default: false) Visible when Show advanced settings is on |
Color
| Setting | Description | Options |
|---|---|---|
| Type | Custom scheme vs preset surface colors | • Custom Visible when Show advanced settings is on and Enable inheritance is off |
| Color scheme | Background and text pairing | Color scheme picker Visible when type is Custom, Show advanced settings is on, and Enable inheritance is off |
| Color scheme | Background and text pairing | • Body background (default) Visible when type is Base, Show advanced settings is on, and Enable inheritance is off |
| Border color | Sidebar border | • Subtle (default) Visible when Show advanced settings is on, type is Base, and Enable inheritance is off |
| Enable inheritance | Inherit colors from the closest parent with a set scheme | Checkbox (default: false) |
Layout
| Setting | Description | Options |
|---|---|---|
| Horizontal position | Position of the sidebar along the horizontal axis | • Left |
Display
| Setting | Description | Options |
|---|---|---|
| Visibility | Controls when the block is visible | • All (default) Visible when Show advanced settings is on |