Checkbox
Installation
npx shadcn@latest add https://ui.timkit.cn/r/checkbox.json
Usage
import { Checkbox } from "@/components/ui/checkbox"
Examples
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Structured API
Component
checkbox
Logic
zag / checkbox
Runtime Frameworks
ReactVueWeappHTML
Supported Platforms
WebWeChat Mini Program
Configuration
| Prop | Type | Default | Description |
|---|---|---|---|
| logic.provider* | enum (zag | native | none) | zag | State and interaction provider used by this component. |
| logic.machine | string | checkbox | Underlying state machine identifier when provider is zag. |
| platforms* | array | Web, WeChat Mini Program | Platforms officially supported by this schema. |
| frameworks* | array | React, Vue, Weapp, HTML | Framework demos/code currently available in registry files. |
| dependencies | array | @timui/core, @zag-js/react | Runtime package dependencies required by this registry item. |
| optionalPeerDependencies | array | - | Optional peer dependencies used by this registry item. |
| registryDependencies | array | use-machine | Dependent Timkit registry components/hook entries. |
Props
| Prop | Type | Default | Description |
|---|---|---|---|
| checked | boolean | - | The controlled checked state. |
| disabled | boolean | false | Whether the checkbox is disabled. |
Events
| Prop | Type | Default | Description |
|---|---|---|---|
| onCheckedChange | event | - | Callback called when checked state changes. |
Slots
| Prop | Type | Default | Description |
|---|---|---|---|
| default | slot | - | The content of the checkbox |
Parts
| Prop | Type | Default | Description |
|---|---|---|---|
| root* | root | - | The checkbox container |
| indicator | part | - | The visual indicator of the checked state |
This API reference is generated from `/packages/core` component schemas to keep React/Vue/Weapp docs consistent.
Extended notes are not available for this component yet.
On This Page
- Installation
- Usage
- Examples
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- API Reference
Checkbox
Installation
npx shadcn@latest add https://ui.timkit.cn/r/checkbox.json
Usage
import { Checkbox } from "@/components/ui/checkbox"
Examples
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Checkbox · With label
Loading preview...
Structured API
Component
checkbox
Logic
zag / checkbox
Runtime Frameworks
ReactVueWeappHTML
Supported Platforms
WebWeChat Mini Program
Configuration
| Prop | Type | Default | Description |
|---|---|---|---|
| logic.provider* | enum (zag | native | none) | zag | State and interaction provider used by this component. |
| logic.machine | string | checkbox | Underlying state machine identifier when provider is zag. |
| platforms* | array | Web, WeChat Mini Program | Platforms officially supported by this schema. |
| frameworks* | array | React, Vue, Weapp, HTML | Framework demos/code currently available in registry files. |
| dependencies | array | @timui/core, @zag-js/react | Runtime package dependencies required by this registry item. |
| optionalPeerDependencies | array | - | Optional peer dependencies used by this registry item. |
| registryDependencies | array | use-machine | Dependent Timkit registry components/hook entries. |
Props
| Prop | Type | Default | Description |
|---|---|---|---|
| checked | boolean | - | The controlled checked state. |
| disabled | boolean | false | Whether the checkbox is disabled. |
Events
| Prop | Type | Default | Description |
|---|---|---|---|
| onCheckedChange | event | - | Callback called when checked state changes. |
Slots
| Prop | Type | Default | Description |
|---|---|---|---|
| default | slot | - | The content of the checkbox |
Parts
| Prop | Type | Default | Description |
|---|---|---|---|
| root* | root | - | The checkbox container |
| indicator | part | - | The visual indicator of the checked state |
This API reference is generated from `/packages/core` component schemas to keep React/Vue/Weapp docs consistent.
Extended notes are not available for this component yet.
On This Page
- Installation
- Usage
- Examples
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- Checkbox · With label
- API Reference