For the complete documentation index, see llms.txt. Markdown variants are available by appending .md to any URL or sending an Accept: text/markdown header. An agent skill is available at /.well-known/agent-skills/site-skill.md.
43
Sponsor

Switch

PreviousNext

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

import { Switch } from "@/components/ui/switch";

export function SwitchDemo() {
  return (
    <label style={{ alignItems: "center", display: "flex", gap: 8 }}>
      <Switch defaultChecked />

Installation

$ pnpm dlx shadcn@latest add https://shadcn-cssinjs.com/r/switch.json

Usage

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

Examples

Description

Focus is shared across devices, and turns off when you leave the app.

import {
  Field,
  FieldContent,
  FieldDescription,
  FieldLabel,
} from "@/components/ui/field";

Choice Card

import {
  Field,
  FieldContent,
  FieldDescription,
  FieldGroup,
  FieldLabel,

Disabled

import { Field, FieldLabel } from "@/components/ui/field";
import { Switch } from "@/components/ui/switch";

export function SwitchDisabled() {
  return (
    <Field className="w-fit" data-disabled orientation="horizontal">

Invalid

You must accept the terms and conditions to continue.

import {
  Field,
  FieldContent,
  FieldDescription,
  FieldLabel,
} from "@/components/ui/field";

Size

import {
  Field,
  FieldGroup,
  FieldLabel,
} from "@/components/ui/field";
import { Switch } from "@/components/ui/switch";

RTL

To enable right-to-left support, see the RTL guide.

"use client";

import { useTranslation } from "@/components/language-selector";
import type { Translations } from "@/components/language-selector";
import { Switch } from "@/components/ui/switch";

API Reference

See the Base UI documentation for the full API.