Skip to content
GaudiGaudi Design System home

Search documentation

Search every page, heading and paragraph.

Checkbox

Checkbox renders a token-styled binary control.

CoreBasics@gaudi/design-system/core/CheckboxView in StorybookSource

Installation

pnpm add github:ahmadassaf/design-system

Import from @gaudi/design-system. Load @gaudi/design-system/global.css once and add transpilePackages: ['@gaudi/design-system'] in Next.js.

import Checkbox from '@gaudi/design-system/core/Checkbox';

Copy an example into your project with the shadcn CLI: npx shadcn@latest add https://design.gaudi.site/r/checkbox-corner-cards.json.

Usage

import { Checkbox } from '@gaudi/design-system';
<Checkbox label='Include drafts' defaultChecked />

Playground

Checkbox props
Props
Checkbox.jsx
import Checkbox from '@gaudi/design-system/core/Checkbox';
<Checkbox label='Accept the terms' />

Examples

Corner-check cards

Storybook

Groups

Storybook

Label extras and styles

Storybook

Nested group

Storybook

Row cards

Storybook

States

Storybook

API

7 props

Accessibility

Checkbox exposes role checkbox, aria-checked, disabled state, and a visible label when provided.