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

# Toggle

## Overview

A toggle button built on Reka UI's Toggle, supporting variant and size styles via the theme system.

Theme entry: [Toggle](/v3/reference/theming/keys/Toggle.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-variant">variant</span> | `string` |  | `"default"` | Visual style variant. |
| <span id="prop-size">size</span> | `string` |  | `"default"` | Size variant. |
| <span id="prop-pressed">pressed</span> | `boolean` |  | `undefined` | Whether the toggle is pressed. |
| <span id="prop-defaultPressed">defaultPressed</span> | `boolean` |  | `undefined` | The default pressed state. |
| <span id="prop-disabled">disabled</span> | `boolean` |  | `false` | Whether the toggle is disabled. |
| <span id="prop-as">as</span> | `string\|object` |  | `undefined` | The element or component to render as. |
| <span id="prop-asChild">asChild</span> | `boolean` |  | `false` | When true, merges props onto the child element instead of rendering a wrapper. |

## Slots

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

Scoped slot.

## Events

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

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

## Source

`client/lib/controls/toggle/Toggle.vue`