---
url: "https://vueda.dev/v3/reference/api/vue/Sidebar.md"
title: "Sidebar"
---

# Sidebar

## Overview

The main sidebar container. Renders as an off-canvas sheet on mobile and a collapsible panel on desktop.

Theme entry: [Sidebar](/v3/reference/theming/keys/Sidebar.md)

## Props

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| <span id="prop-themeOverride">themeOverride</span> | `Object` |  | `null` | A partial ThemeObject keyed by component name, merged over this component's theme and provided to descendants. |
| <span id="prop-class">class</span> | `import('vue').HTMLAttributes['class']` |  | `undefined` | Additional CSS classes to apply to the root element. |
| <span id="prop-side">side</span> | `string` |  | `"left"` | The side of the viewport the sidebar appears on. |
| <span id="prop-variant">variant</span> | `string` |  | `"sidebar"` | The visual style variant. |
| <span id="prop-collapsible">collapsible</span> | `string` |  | `"offcanvas"` | The collapse behavior. |

## Slots

### `default` {#slot-default}

Slot.

## Source

`client/lib/navigation/sidebar/Sidebar.vue`