> For the complete documentation index, see [llms.txt](https://help.brickspacelab.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.brickspacelab.com/slab/content/blocks/overlays/sidebar.md).
# 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:
* [Container](/slab/content/blocks/layout/container.md) (for sidebar content)
* [Container](/slab/content/blocks/layout/container.md) (for sidebar footer)
## 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 |
|
| Overlay ID | Custom identifier for the overlay (used to trigger it programmatically) |
Text input
Visible when overlay preset is "Custom"
|
| 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 • Base (default)
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) • Body foreground • Accent 1–3 • Shade 1–3 • Blur • Transparent
Visible when type is Base, Show advanced settings is on, and Enable inheritance is off
|
| Border color | Sidebar border |
• Subtle (default) • Strong • None
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)
Visible when Show advanced settings is on
|
### Layout
| Setting | Description | Options |
| ------------------- | ------------------------------------------------- | ---------------------------------- |
| Horizontal position | Position of the sidebar along the horizontal axis |
• Left • Right (default)
|
### Display
| Setting | Description | Options |
| ---------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| Visibility | Controls when the block is visible |
• All (default) • Mobile only • Desktop only
Visible when Show advanced settings is on
|
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://help.brickspacelab.com/slab/content/blocks/overlays/sidebar.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
