ComponentsCheckbox

formstexulinot agent-emittableapp

Checkbox

checkbox

A binary or indeterminate checkbox with optional label.

Live examples

Labeled checkbox

Labeled checkbox

Loading demo…

Indeterminate

Indeterminate

Props

Public props for Checkbox
NameKindRequiredDefaultDescription
checkedbooleannofalse—
defaultCheckedbooleannofalse—
indeterminatebooleannofalse—
defaultIndeterminatebooleannofalse—
namestringno——
valuestringno"on"—
disabledbooleannofalse—
requiredbooleannofalse—
idstringno——
labelstringno——
descriptionstringno——
sizeenum (sm, md)no"md"—
onCheckedChangeeventno——
onIndeterminateChangeeventno——
classstringno——

Keyboard

Keyboard behavior for Checkbox
KeyAction
—See accessibility notes for keyboard behavior.

Accessibility

  • Visible label is wired with for; description uses aria-describedby.

Evidence for checkbox

Latest committed gates for checkbox (as of 2026-10-23). Static snapshot — not live CI.

Behavior

checkedscenario checkbox

7 checks

Rows in tests/behavior/scenarios/checkbox.spec.ts, held to the WAI-ARIA APG pattern, run on Chromium, WebKit and the Pixel 7.

Size (gzip)

@texuli/primitives/checkbox · budget 4.00 KiB

Budget from texuli.budgets.json; re-measure with `pnpm size --filter <entry>`.

Axe

documented

  • tests/e2e/site-component-pages.spec.ts
  • docs/quality (a11y-*)

Site component pages axe gate; package-level a11y docs under docs/quality when present.

Browsers

  • chromium
  • webkit
  • mobile

Playwright projects: Desktop Chrome, Desktop Safari, Pixel 7. Firefox is a known gap on this host.

When to use

Use when

  • Independent on/off choices
  • Select-all with indeterminate

Don’t use when

Prefer another component

  • A single exclusive choice in a set (use radio-group)
  • A switch-style setting (use switch)