Sabil UI

Search documentation

Search for a command to run...

Components

Switch

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

Installation#

  1. Install the dependencies

    npm install cn radix-ui
  2. Copy the source into your project

    components/ui/switch.tsx
    "use client"import * as React from "react"import { cn } from "cn"import { Switch as SwitchPrimitive } from "radix-ui"function Switch({  className,  size = "default",  ...props}: React.ComponentProps<typeof SwitchPrimitive.Root> & {  size?: "sm" | "default"}) {  return (    <SwitchPrimitive.Root      data-slot="switch"      data-size={size}      className={cn(        "peer group/switch relative inline-flex shrink-0 items-center rounded-full border border-transparent transition-all outline-none group-has-[:focus-visible]/field-label:border-transparent group-has-[:focus-visible]/field-label:ring-0 after:absolute after:-inset-x-3 after:-inset-y-2 focus-visible:border-ring focus-visible:ring-3 focus-visible:ring-ring/50 aria-invalid:border-destructive aria-invalid:ring-3 aria-invalid:ring-destructive/20 data-[size=default]:h-[18.4px] data-[size=default]:w-[32px] data-[size=sm]:h-[14px] data-[size=sm]:w-[24px] dark:aria-invalid:border-destructive/50 dark:aria-invalid:ring-destructive/40 data-checked:bg-primary data-unchecked:bg-input dark:data-unchecked:bg-input/80 data-disabled:cursor-not-allowed data-disabled:opacity-50",        className      )}      {...props}    >      <SwitchPrimitive.Thumb        data-slot="switch-thumb"        className="pointer-events-none block rounded-full bg-background ring-0 transition-transform group-data-[size=default]/switch:size-4 group-data-[size=sm]/switch:size-3 group-data-[size=default]/switch:data-checked:translate-x-[calc(100%-2px)] group-data-[size=sm]/switch:data-checked:translate-x-[calc(100%-2px)] dark:data-checked:bg-primary-foreground group-data-[size=default]/switch:data-unchecked:translate-x-0 group-data-[size=sm]/switch:data-unchecked:translate-x-0 dark:data-unchecked:bg-foreground"      />    </SwitchPrimitive.Root>  )}export { Switch }
  3. Make sure the foundation is in place

    Components read their colors, radius and surfaces from the tokens in app/globals.css. See Theming.

Usage#

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

Examples#

Choice Card

Description

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

Disabled

Invalid

You must accept the terms and conditions to continue.

Sizes