mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-24 21:25:55 +00:00
78 lines
1.3 KiB
Plaintext
78 lines
1.3 KiB
Plaintext
---
|
|
title: Checkbox
|
|
description: A control that allows the user to toggle between checked and not checked.
|
|
component: true
|
|
links:
|
|
doc: https://www.radix-ui.com/docs/primitives/components/checkbox
|
|
api: https://www.radix-ui.com/docs/primitives/components/checkbox#api-reference
|
|
---
|
|
|
|
<ComponentPreview name="checkbox-demo" description="A checkbox" />
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">CLI</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add checkbox
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps>
|
|
|
|
<Step>Install the following dependencies:</Step>
|
|
|
|
```bash
|
|
npm install @radix-ui/react-checkbox
|
|
```
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource name="checkbox" />
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { Checkbox } from "@/components/ui/checkbox"
|
|
```
|
|
|
|
```tsx
|
|
<Checkbox />
|
|
```
|
|
|
|
## Examples
|
|
|
|
### With text
|
|
|
|
<ComponentPreview
|
|
name="checkbox-with-text"
|
|
description="A checkbox with label and description."
|
|
/>
|
|
|
|
### Disabled
|
|
|
|
<ComponentPreview name="checkbox-disabled" description="A disabled checkbox" />
|
|
|
|
### Form
|
|
|
|
<ComponentPreview name="checkbox-form-single" />
|
|
|
|
<ComponentPreview name="checkbox-form-multiple" />
|