UnreviewedOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptional UnreviewedkeyReact/Preact reconciliation key when rendered inside a list.
Optional UnreviewedidHTML id attribute.
Optional UnreviewedclassHTML class attribute (standard DOM).
Optional UnreviewedclassReact/Preact-style class name. Alias for class.
Optional UnreviewedstyleInline styles applied to the element.
OptionalchildrenOptional UnreviewedslotAssigns the element to a named <slot> (e.g. slot="title").
Optional UnreviewedtabTab order. Set to 0 to make the element keyboard-focusable.
Optional UnreviewedroleARIA role override.
Optional UnreviewedtoneMark color, or any literal CSS color for a one-off custom tone. Named tones
track light/dark mode automatically. Its scope is controlled by tone-scope. 'neutral' is the
default (same as omitting it). The label + hint
stay neutral — recolor them in plain CSS via the --text-N-{tone} tokens.
Optional Unreviewedtone-Apply tone to every state (all, the default) or only while checked.
Optional UnreviewedsizeSize variant. small = 14px, medium (default) = 16px, large = 18px box.
Optional UnreviewedstateControlled state — the element reflects changes to this attribute. Use this
(driven from your store) for a controlled checkbox; use default-state for
an uncontrolled one.
Optional Unrevieweddefault-Uncontrolled initial state — read once at connect / form-reset, then the element self-manages.
Optional UnrevieweddisabledDisabled state. Presence-based ('' on, omit off).
Optional UnreviewedroundRound the mark to a circle (::before border-radius: 999px), or a rounded
square via a length value (round="5px"). Presence-based for the boolean form.
Optional UnreviewednameForm field name — the key this checkbox submits under inside a <form>.
Optional UnreviewedvalueValue submitted when checked. Defaults to "on".
Optional UnreviewedonstatechangeFires before the element applies any change. The element dispatches a
cancelable statechange CustomEvent whose detail carries
{ next, prev } (the same string enum as state); a synchronous
preventDefault() vetoes the transition. The all-lowercase spelling is
deliberate — it's the one form both renderers bind to a custom event
(React 19 keeps the case of whatever follows on; Preact lowercases).
Optional UnreviewedonchangeNative change, fired after a toggle applies (post-apply counterpart to
onstatechange). Lowercase so both renderers bind the native event.
Optional Unreviewedaria-ARIA — set by the consumer / the Checkbox wrapper (the element never
touches these itself).
Optionalaria-Optionalaria-
Attributes for the
<a-checkbox>custom element.<a-checkbox>is a light-DOM interactive element: its visual state lives onElementInternals(styled via the:state(checked)/:state(indeterminate)pseudo-class, not host attributes), driven by thestateattribute (controlled) ordefault-state(uncontrolled seed). It sets no ARIA itself —role/aria-*are the consumer's job (the wrapper supplies them). The label is its children. Low-level attributes — for the typed JSX wrapper useCheckboxfrom@antadesign/anta.