Laurel

Switch

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

Installation

npx shadcn@latest add switch

Usage

import { Switch } from "@/components/ui/switch"
<Switch />

Description

Choice Card

Card-style selection where FieldLabel wraps the entire Field for a clickable card pattern.

Disabled

Add the disabled prop to the Switch component to disable the switch. Add the data-disabled prop to the Field component for styling.

Invalid

Add the aria-invalid prop to the Switch component to indicate an invalid state. Add the data-invalid prop to the Field component for styling.

Size

Use the size prop to change the size of the switch.

API Reference

See the Base UI Switch documentation.

On this page