137 lines
2.6 KiB
Plaintext
137 lines
2.6 KiB
Plaintext
---
|
|
title: Checkbox
|
|
description: A control that allows the user to toggle between checked and not checked.
|
|
base: aria
|
|
component: true
|
|
links:
|
|
doc: https://react-aria.adobe.com/Checkbox
|
|
api: https://react-aria.adobe.com/Checkbox#api
|
|
---
|
|
|
|
<ComponentPreview
|
|
styleName="aria-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 react-aria-components
|
|
```
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource
|
|
name="checkbox"
|
|
title="components/ui/checkbox.tsx"
|
|
styleName="aria-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 `defaultSelected` for uncontrolled checkboxes, or `isSelected` and
|
|
`onChange` to control the state.
|
|
|
|
```tsx showLineNumbers
|
|
import * as React from "react"
|
|
|
|
export function Example() {
|
|
const [checked, setChecked] = React.useState(false)
|
|
|
|
return <Checkbox isSelected={checked} onChange={setChecked} />
|
|
}
|
|
```
|
|
|
|
## Invalid State
|
|
|
|
Set `isInvalid` on the checkbox and `data-invalid` on the field wrapper to
|
|
show the invalid styles.
|
|
|
|
<ComponentPreview styleName="aria-nova" name="checkbox-invalid" />
|
|
|
|
## Basic
|
|
|
|
Pair the checkbox with `Field` and `FieldLabel` for proper layout and labeling.
|
|
|
|
<ComponentPreview styleName="aria-nova" name="checkbox-basic" />
|
|
|
|
## Description
|
|
|
|
Use `FieldContent` and `FieldDescription` for helper text.
|
|
|
|
<ComponentPreview styleName="aria-nova" name="checkbox-description" />
|
|
|
|
## Disabled
|
|
|
|
Use the `isDisabled` prop to prevent interaction and add the `data-disabled` attribute to the `<Field>` component for disabled styles.
|
|
|
|
<ComponentPreview styleName="aria-nova" name="checkbox-disabled" />
|
|
|
|
## Group
|
|
|
|
Use multiple fields to create a checkbox list.
|
|
|
|
<ComponentPreview styleName="aria-nova" name="checkbox-group" />
|
|
|
|
## Table
|
|
|
|
<ComponentPreview
|
|
styleName="aria-nova"
|
|
name="checkbox-table"
|
|
previewClassName="p-4 md:p-8"
|
|
/>
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview
|
|
styleName="aria-nova"
|
|
name="checkbox-rtl"
|
|
direction="rtl"
|
|
previewClassName="h-80"
|
|
/>
|
|
|
|
## API Reference
|
|
|
|
See the [React Aria](https://react-aria.adobe.com/Checkbox#api) documentation for more information.
|