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

# SidebarProvider

## Overview

Provider component that manages sidebar state and provides context to all child sidebar components.

Theme entry: [SidebarProvider](/v3/reference/theming/keys/SidebarProvider.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-defaultOpen">defaultOpen</span> | `boolean` |  | `` () => !defaultDocument?.cookie.includes(`${SIDEBAR_COOKIE_NAME}=false`) `` | Whether the sidebar is open by default. Reads from cookie if available. |
| <span id="prop-open">open</span> | `boolean` |  | `undefined` | Controlled open state. |

## Slots

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

Slot.

## Events

| Name | Description |
| --- | --- |
| `update:open` | Emitted when the open state changes. |

[Full event reference](/v3/reference/api/vue/SidebarProvider/events.md)

## Source

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