Checkbox

Overview

Copy the source into your project, then import the parts you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without wrapping or replacing a package.

Installation

Run bunx @yopem-ui/cli init from your project root first. The CLI configures StyleX and installs shared files and dependencies.

bunx @yopem-ui/cli init

bunx @yopem-ui/cli add checkbox

Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. Existing files are preserved. To refresh installed source, use update; locally edited files need an explicit --force to overwrite.

bunx @yopem-ui/cli update checkbox

Preview

import { Checkbox } from "@registry/components/ui/checkbox"
import { Label } from "@registry/components/ui/label"

export function Preview() {
  return (

Usage

Use Checkbox with a visible label for an independent yes-or-no choice.

Use checked and onCheckedChange for controlled state, or defaultChecked for uncontrolled state. indeterminate represents a partially selected group.

Import from the local file installed by the CLI.

"use client"

import { Checkbox } from "@/components/ui/checkbox"
import { Label } from "@/components/ui/label"

export function Preview() {
  return (
    <Label>
      <Checkbox name="terms" />
      Accept terms and conditions
    </Label>
  )
}

API reference

Generated from canonical TypeScript source. Only component and Base UI props appear below. Required marks a required property, not a required component.