Sabil UI

Search documentation

Search for a command to run...

Components

Toggle

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

Installation#

  1. Install the dependencies

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

    components/ui/toggle.tsx
    "use client"import * as React from "react"import { cva, type VariantProps } from "class-variance-authority"import { cn } from "cn"import { Toggle as TogglePrimitive } from "radix-ui"const toggleVariants = cva(  "group/toggle inline-flex items-center justify-center gap-1 rounded-lg text-sm font-medium whitespace-nowrap transition-[transform,background-color,color,box-shadow] duration-150 ease-out active:scale-[0.97] outline-none hover:bg-muted hover:text-foreground focus-visible:border-ring focus-visible:ring-[3px] focus-visible:ring-ring/50 disabled:pointer-events-none disabled:opacity-50 aria-invalid:border-destructive aria-invalid:ring-destructive/20 aria-pressed:bg-muted data-[state=on]:bg-muted dark:aria-invalid:ring-destructive/40 [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4",  {    variants: {      variant: {        default: "bg-transparent",        outline: "border border-input bg-transparent hover:bg-muted",      },      size: {        default:          "h-10 min-w-10 px-3 has-data-[icon=inline-end]:pr-2 has-data-[icon=inline-start]:pl-2",        sm: "h-8 min-w-8 rounded-md px-2.5 text-[0.8rem] has-data-[icon=inline-end]:pr-1.5 has-data-[icon=inline-start]:pl-1.5 [&_svg:not([class*='size-'])]:size-3.5",        lg: "h-11 min-w-11 px-3.5 has-data-[icon=inline-end]:pr-2 has-data-[icon=inline-start]:pl-2",      },    },    defaultVariants: {      variant: "default",      size: "default",    },  })function Toggle({  className,  variant = "default",  size = "default",  ...props}: React.ComponentProps<typeof TogglePrimitive.Root> &  VariantProps<typeof toggleVariants>) {  return (    <TogglePrimitive.Root      data-slot="toggle"      className={cn(toggleVariants({ variant, size, className }))}      {...props}    />  )}export { Toggle, toggleVariants }
  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 { Toggle } from "@/components/ui/toggle"

Examples#

Disabled

Outline

Sizes

Text