Oros UI

Search documentation

Search Oros UI pages and components.

Checkbox

Lets people select or clear a single option.

Installation

Install Checkbox from Oros with shadcn CLI 4.13.0.

pnpm dlx shadcn@4.13.0 add @oros/checkbox

Usage

import {
  Checkbox,
} from "@/components/ui/checkbox"

Open the Source tab in the preview for a complete working example.

Anatomy

ExportResponsibility
CheckboxThe root component that owns the primary structure and state.

API Reference

Checkbox exports 1 named entry. Component exports accept the props of their underlying HTML element or Base UI component, plus an optional className, unless the source defines a more focused type.

  • Checkbox Component

Accessibility

  • Provide Checkbox with a visible label or an equivalent programmatic accessible name.
  • Expose disabled, required, selected, and invalid states through the component API instead of color alone, and keep keyboard focus visible.

Source

Checkbox uses the standard shadcn API and is distributed through Oros. Installing it adds the component source and required dependencies to your app. The Source tab above shows a complete usage example.