Forms

Checkbox

A native checkbox with a chunky Swirski mark, label and optional description.

Component

import { Checkbox } from "@swirski/ui";

4 controls

Send launch updatesA compact, native checkbox with a custom Swirski mark.

Controls

label

description

checked

disabled

<Checkbox
  label="Send launch updates"
  description="A compact, native checkbox with a custom Swirski mark."
  defaultChecked
/>

7 generated

Prop	Type	Default	Notes
`containerClassName`	`string`	`-`	Adds classes to the root label wrapper.
`description`	`ReactNode`	`-`	Optional supporting text below the label.
`inputClassName`	`string`	`-`	Generated from CheckboxProps.
`label`	`ReactNode`	`-`	Visible label rendered beside the checkbox.
`size`	`'sm' \| 'md' \| 'lg'`	`"md"`	Generated from CheckboxProps.
`tone`	`'blue' \| 'yellow' \| 'red'`	`"yellow"`	Generated from CheckboxProps.
`variant`	`'default' \| 'card'`	`"default"`	Generated from CheckboxProps.
`className`	`string`	`-`	Adds classes to the hidden native checkbox input.
`disabled`	`boolean`	`false`	Disables interaction and dims the wrapper.
`...inputProps`	`Omit<InputHTMLAttributes<HTMLInputElement>, "type">`	`-`	Forwarded to the native checkbox input.