Docs

Toggle

Toggle

A two-state button that can be either on or off.

Component Source Primitive API Reference

Usage

vue

<script setup lang="ts">
import { Toggle } from "wedges-vue";
</script>

<template>
  <Toggle>Toggle</Toggle>
</template>

API Reference

Props

Prop	Type	Default
`as`	`AsTag \| Component`	`'div'`
`asChild`	`boolean`	`false`
`defaultValue`	`boolean`	`false`
`destructive`	`boolean`	`false`
`disabled`	`boolean`	`false`
`isIconOnly`	`boolean`	`false`
`pressed`	`boolean`	`false`
`shape`	`'rounded' \| 'pill' \| null`	`'rounded'`
`size`	`'sm' \| 'md' \| 'xs-icon' \| null`	`'md'`
`variant`	`'outline' \| 'transparent'`	`'outline'`

Emit	Description
`update:pressed`

Edit this page on GitHub