Checkbox

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

Installation

  1. Install the @radix-ui/react-checkbox component from radix-ui:
npm install @radix-ui/react-checkbox
  1. Copy and paste the following code into your project.
"use client"
 
import * as React from "react"
import * as CheckboxPrimitive from "@radix-ui/react-checkbox"
import { Check } from "lucide-react"
 
import { cn } from "@/lib/utils"
 
const Checkbox = React.forwardRef<
  React.ElementRef<typeof CheckboxPrimitive.Root>,
  React.ComponentPropsWithoutRef<typeof CheckboxPrimitive.Root>
>(({ className, ...props }, ref) => (
  <CheckboxPrimitive.Root
    ref={ref}
    className={cn(
      "peer h-4 w-4 shrink-0 rounded-sm border border-slate-300 focus:outline-none focus:ring-2 focus:ring-slate-400 focus:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50 dark:border-slate-700 dark:text-slate-50 dark:focus:ring-slate-400 dark:focus:ring-offset-slate-900",
      className
    )}
    {...props}
  >
    <CheckboxPrimitive.Indicator
      className={cn("flex items-center justify-center")}
    >
      <Check className="h-4 w-4" />
    </CheckboxPrimitive.Indicator>
  </CheckboxPrimitive.Root>
))
Checkbox.displayName = CheckboxPrimitive.Root.displayName
 
export { Checkbox }

This is the <Checkbox /> primitive. You can place it in a file at components/ui/checkbox.tsx.

Usage

import { Checkbox } from "@/components/ui/checkbox"
<Checkbox />

Examples

With text

You agree to our Terms of Service and Privacy Policy.

Disabled