@mks2508/mks-ui
Components

Checkbox

Animated checkbox with controlled/uncontrolled state support.

Checkbox

An animated checkbox component with spring-based check animation and controlled/uncontrolled state support.

Import

import { Checkbox } from '@mks2508/mks-ui/react';

Basic Usage

Basic Usage
.tsx
<div className="flex items-center gap-4">
<Checkbox />
<Checkbox defaultChecked />
</div>

With Label

With Label
.tsx
<div className="flex items-center gap-2">
<Checkbox id="terms" />
<Label htmlFor="terms">Accept terms and conditions</Label>
</div>

Controlled

const [checked, setChecked] = useState(false);

<Checkbox checked={checked} onCheckedChange={setChecked} />

Disabled

Disabled
.tsx
<div className="flex items-center gap-4">
<Checkbox disabled />
<Checkbox disabled defaultChecked />
</div>

API Reference

PropTypeDefaultDescription
checkedbooleanControlled checked state
defaultCheckedbooleanfalseInitial checked state (uncontrolled)
onCheckedChange(checked: boolean) => voidChange handler
disabledbooleanfalseDisable interactions
idstringHTML id for label association
classNamestringAdditional CSS classes