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

# SidebarTrigger

## Overview

A button that toggles the sidebar open or closed. The toggle glyph resolves through
`useIcons("SidebarTrigger", props)("toggle")`; consumers register a default (canon is
`fa-regular fa-rectangle-list`) via `setIcons` or replace per-instance via `iconOverride`.

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

## Props

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| <span id="prop-iconOverride">iconOverride</span> | `Object` |  | `null` | A partial icon registry (`{ [componentName]: { [iconName]: { component, props } } }`) merged with inherited and default icon entries; scopes icon overrides to this component and its descendants. |
| <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. |

## Source

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