mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-28 23:24:13 +00:00
47c47eaed2
* feat: add base and radix docs * feat: transform code for display * fix * fix * fix * fix * fix * chore: remove claude files * fix * fix * fix * chore: run format:write * fix * feat: add more examples * fix * feat: add aspect-ratio * feat: add avatar * feat: add badge * feat: add breadcrumb * fix * feat: add button * fix * fix * fix * feat: add calendar and card * feat: add carousel * fix: chart * feat: add checkbox * feat: add collapsible * feat: add combobox * feat: add command * feat: add context menu * feat: add data-table dialog and drawer * feat: dropdown-menu * feat: add date-picker * feat: add empty * feat: add field and hover-card * fix: input * feat: add input * feat: add input-group * feat: add input-otp * feat: add item * feat: add kbd and label * feat: add menubar * feat: add native-select * feat: add more components * feat: more components * feat: more components * feat: add skeleton, slider and sonner * feat: add spinner and switch * feat: add more components * fix: tabs * fix: tabs * feat: add docs for sidebar * fix * fix * fi * docs: update * fix: create page * fix * fix * chore: add changelog * fix
128 lines
2.5 KiB
Plaintext
128 lines
2.5 KiB
Plaintext
---
|
|
title: Checkbox
|
|
description: A control that allows the user to toggle between checked and not checked.
|
|
base: base
|
|
component: true
|
|
links:
|
|
doc: https://base-ui.com/react/components/checkbox
|
|
api: https://base-ui.com/react/components/checkbox#api-reference
|
|
---
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="checkbox-demo"
|
|
previewClassName="h-80"
|
|
/>
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add checkbox
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<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"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { Checkbox } from "@/components/ui/checkbox"
|
|
```
|
|
|
|
```tsx
|
|
<Checkbox />
|
|
```
|
|
|
|
## Checked State
|
|
|
|
Use `defaultChecked` for uncontrolled checkboxes, or `checked` and
|
|
`onCheckedChange` to control the state.
|
|
|
|
```tsx showLineNumbers
|
|
import * as React from "react"
|
|
|
|
export function Example() {
|
|
const [checked, setChecked] = React.useState(false)
|
|
|
|
return <Checkbox checked={checked} onCheckedChange={setChecked} />
|
|
}
|
|
```
|
|
|
|
## Invalid State
|
|
|
|
Set `aria-invalid` on the checkbox and `data-invalid` on the field wrapper to
|
|
show the invalid styles.
|
|
|
|
<ComponentPreview styleName="base-nova" name="checkbox-invalid" />
|
|
|
|
## Examples
|
|
|
|
### Basic
|
|
|
|
Pair the checkbox with `Field` and `FieldLabel` for proper layout and labeling.
|
|
|
|
<ComponentPreview styleName="base-nova" name="checkbox-basic" />
|
|
|
|
### Description
|
|
|
|
Use `FieldContent` and `FieldDescription` for helper text.
|
|
|
|
<ComponentPreview styleName="base-nova" name="checkbox-description" />
|
|
|
|
### Disabled
|
|
|
|
Use the `disabled` prop to prevent interaction and add the `data-disabled` attribute to the `<Field>` component for disabled styles.
|
|
|
|
<ComponentPreview styleName="base-nova" name="checkbox-disabled" />
|
|
|
|
### Group
|
|
|
|
Use multiple fields to create a checkbox list.
|
|
|
|
<ComponentPreview styleName="base-nova" name="checkbox-group" />
|
|
|
|
### Table
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="checkbox-table"
|
|
previewClassName="p-4 md:p-8"
|
|
/>
|
|
|
|
## API Reference
|
|
|
|
See the [Base UI](https://base-ui.com/react/components/checkbox#api-reference) documentation for more information.
|