Switch

A control that allows the user to toggle between checked and not checked.

View code

Airplane mode

Features

Install the component from your command line.

$ npm add reka-ui

Import all parts and piece them together.

vue

<script setup>
import { SwitchRoot, SwitchThumb } from 'reka-ui'
</script>

<template>
  <SwitchRoot>
    <SwitchThumb />
  </SwitchRoot>
</template>

Contains all the parts of a switch. An input will also render when used within a form to ensure events propagate correctly.

Prop	Default	Type
`as`	`'button'`	`AsTag \| Component` The element or component this component should render as. Can be overwrite by `asChild`
`asChild`		`boolean` Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
`defaultValue`		`boolean` The state of the switch when it is initially rendered. Use when you do not need to control its state.
`disabled`		`boolean` When `true`, prevents the user from interacting with the switch.
`id`		`string`
`modelValue`		`boolean` The controlled state of the switch. Can be bind as `v-model`.
`name`		`string` The name of the field. Submitted with its owning form as part of a name/value pair.
`required`		`boolean` When `true`, indicates that the user must set the value before the owning form can be submitted.
`value`	`'on'`	`string` The value given as data when submitted with a `name`.

Emit	Payload
`update:modelValue`	`[payload: boolean]` Event handler called when the value of the switch changes.

Slots (default)	Payload
`modelValue`	`boolean` Current value

Data Attribute	Value
`[data-state]`	`"checked" \| "unchecked"`
`[data-disabled]`	Present when disabled

The thumb that is used to visually indicate whether the switch is on or off.

Prop	Default	Type
`as`	`'span'`	`AsTag \| Component` The element or component this component should render as. Can be overwrite by `asChild`
`asChild`		`boolean` Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.

Data Attribute	Value
`[data-state]`	`"checked" \| "unchecked"`
`[data-disabled]`	Present when disabled

Key	Description
`Space`	Toggles the component's state.
`Enter`	Toggles the component's state.