Skip to content
Clicky UI

Checkbox

A native <input type="checkbox"> in the ListMenu row-checkbox style.

Source

Import

Section titled “Import”
import { Checkbox } from "@flanksource/clicky-ui/components";

Demos

Section titled “Demos”
Default · Open in Storybook
With Label · Open in Storybook
Disabled · Open in Storybook

The props table documents the component-specific surface. Standard DOM attributes inherited from React, such as className, event handlers, and accessibility attributes, may also be accepted when the component’s prop type extends a native element.

Props

Section titled “Props”
Prop Type Default Description
aria-label string — Accessible name when no visible `label` is given.
checked* boolean — Current checked state.
className string — Classes applied to the wrapper (or the input when there is no label).
disabled boolean — Disable interaction.
label ReactNode — Optional clickable label rendered after the box.
onChange* (…) => void — Called with the next state when toggled.
onClick (…) => void — Fires before `onChange`; use it to read modifier keys or stop the click from reaching an enclosing clickable row.