@k8ordo/ui

Checkbox

A checkbox. The label goes in label, and onChange receives checked.

Import

ts
import { Checkbox } from '@k8ordo/ui';

Usage

tsx
<Checkbox label="I agree to the terms" />

Checked by default

tsx
<Checkbox defaultChecked label="Checked by default" />

Controlled

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

<Checkbox
  checked={checked}
  label="Controlled checkbox"
  onChange={(checked) => setChecked(checked)}
/>

Disabled

tsx
<Checkbox disabled label="Unchecked disabled" />
<Checkbox defaultChecked disabled label="Checked disabled" />

Group

Frameworks

tsx
<p id="checkbox-group-label">Frameworks</p>
<CheckboxGroup.Root
  aria-labelledby="checkbox-group-label"
  name="frameworks"
  onChange={setValue}
  value={value}
>
  <Checkbox itemValue="react" label="React" />
  <Checkbox itemValue="vue" label="Vue" />
  <Checkbox itemValue="svelte" label="Svelte" />
</CheckboxGroup.Root>

Group Disabled

Frameworks

tsx
<p id="checkbox-group-disabled-label">Frameworks</p>
<CheckboxGroup.Root
  aria-labelledby="checkbox-group-disabled-label"
  defaultValue={['vue']}
  disabled
  name="frameworks-disabled"
>
  <Checkbox itemValue="react" label="React" />
  <Checkbox itemValue="vue" label="Vue" />
  <Checkbox itemValue="svelte" label="Svelte" />
</CheckboxGroup.Root>

Props

label
Type: string
Default: -
checked?
Type: boolean
Default: -
defaultChecked?
Type: boolean
Default: -
indeterminate?
Type: boolean
Default: false
invalid?
Type: boolean
Default: false
itemValue?
Type: string
Default: -
labelHidden?
Type: boolean
Default: false
onChange?
Type: (checked: boolean, event: ChangeEvent<HTMLInputElement>) => void
Default: -
ref?
Type: Ref<HTMLInputElement>
Default: -
PropTypeDefault
labelstring-
checked?boolean-
defaultChecked?boolean-
indeterminate?booleanfalse
invalid?booleanfalse
itemValue?string-
labelHidden?booleanfalse
onChange?(checked: boolean, event: ChangeEvent<HTMLInputElement>) => void-
ref?Ref<HTMLInputElement>-

Inherited attributes (except the ones set internally): InputHTMLAttributes<HTMLInputElement>

CheckboxGroup.Root Props

aria-labelledby
Type: string
Default: -
name
Type: string
Default: -
children?
Type: ReactNode
Default: -
defaultValue?
Type: string[]
Default: -
invalid?
Type: boolean
Default: false
onChange?
Type: (value: string[]) => void
Default: -
ref?
Type: Ref<HTMLFieldSetElement>
Default: -
value?
Type: string[]
Default: -
PropTypeDefault
aria-labelledbystring-
namestring-
children?ReactNode-
defaultValue?string[]-
invalid?booleanfalse
onChange?(value: string[]) => void-
ref?Ref<HTMLFieldSetElement>-
value?string[]-

Inherited attributes (except the ones set internally): FieldsetHTMLAttributes<HTMLFieldSetElement>

k8ordo

React libraries that use Baseline features without holding back.