52 lines
999 B
Plaintext
52 lines
999 B
Plaintext
---
|
|
title: Checkbox
|
|
description: An easily stylable checkbox component.
|
|
author:
|
|
name: imskyleen
|
|
url: https://github.com/imskyleen
|
|
---
|
|
|
|
<ComponentPreview name="base-checkbox-demo" />
|
|
|
|
## Installation
|
|
|
|
<ComponentInstallation name="base-checkbox" />
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
<Checkbox />
|
|
```
|
|
|
|
## Props
|
|
|
|
<div className="flex flex-row gap-x-3">
|
|
<ExternalLink
|
|
href="https://base-ui.com/react/components/checkbox"
|
|
text="Docs"
|
|
/>
|
|
<ExternalLink
|
|
href="https://base-ui.com/react/components/checkbox#api-reference"
|
|
text="API Reference"
|
|
/>
|
|
</div>
|
|
|
|
### Animate UI Props
|
|
|
|
#### Checkbox
|
|
|
|
<TypeTable
|
|
type={{
|
|
motionProps: {
|
|
description: 'The props to pass to the motion component.',
|
|
type: "HTMLMotionProps<'button'>",
|
|
required: false,
|
|
},
|
|
}}
|
|
/>
|
|
|
|
## Credits
|
|
|
|
- We use [Base UI](https://base-ui.com/react/components/checkbox) for the checkbox component.
|
|
- We take our inspiration from [Shadcn UI](https://ui.shadcn.com/docs/components/checkbox) for the checkbox style.
|