---
title: Checkbox
description: A control allowing the user to toggle between checked and not checked.

links:
  doc: https://base-ui.com/react/components/checkbox#api-reference
---

## Preview

<ComponentPreview name="p-checkbox-1" />

## Installation

<CodeTabs>

<TabsList>
  <TabsTab value="cli">CLI</TabsTab>
  <TabsTab value="manual">Manual</TabsTab>
</TabsList>

<TabsPanel value="cli">

```bash
npx @olyx/cli@latest add checkbox
```

</TabsPanel>

<TabsPanel value="manual">

<Steps>

<Step>Install the following dependencies:</Step>

```bash
npm install @base-ui/react
```

<Step>Copy and paste the following code into your project.</Step>

<ComponentSource name="checkbox" title="components/ui/checkbox.tsx" />

<Step>Update the import paths to match your project setup.</Step>

</Steps>

</TabsPanel>

</CodeTabs>

## Usage

```tsx
import { CheckBox } from "@/components/ui/checkbox"
```

```tsx
<CheckBox />
```

## API Reference

### CheckBox

Styled wrapper for `Checkbox.Root` from Base UI. Includes a built-in indicator with checkmark and indeterminate icons.

## Examples

### Disabled

<ComponentPreview name="p-checkbox-2" />

### Indeterminate

<ComponentPreview name="p-checkbox-3" />