Skip to content

Checkbox

Custom-box checkbox with checked/indeterminate/invalid/disabled states.

View as Markdown

Preview

Checked / unchecked

<label class="nx-checkbox">
  <input type="checkbox" checked>
  <span class="nx-checkbox__box"></span>
  Email notifications
</label>
<label class="nx-checkbox">
  <input type="checkbox">
  <span class="nx-checkbox__box"></span>
  SMS notifications
</label>

Variants

Indeterminate

No HTML attribute for indeterminate: it's set as a DOM property after mount.

<label class="nx-checkbox">
  <input type="checkbox" id="cb-indet-demo">
  <span class="nx-checkbox__box"></span>
  Select all (partial)
</label>

API

React props (NxKit)

React (NxKit) props
PropTypeDefaultRequiredDescription
labelReactNodeundefinedRendered after the box, inside the <label>.

Classes

Framework-agnostic classes
ClassDescription
.nx-checkboxLabel wrapper, 24px+ tap target
.nx-checkbox__box18×18 custom box

States

indeterminate

invalid

Consent required

disabled

Accessibility

  • Indeterminate is a DOM property, not an HTML attribute. Set el.indeterminate = true after mount (React: a ref callback).
  • Icon-only usage (no visible label text) still needs an accessible name via aria-label on the input; the width-axis tap-target floor applies via :has(input:not([id])).

Do / Don’t

  • Do: Wrap the input + box + label text in one <label>.Don't try to set indeterminate via a static HTML attribute. It silently does nothing.

View in spec