Checkbox
- Stable
- WCAG 2.2 evidence
- RTL
The bare 18 px checkbox: one independent yes/no choice applied on submit, or a row selector in a
table, list or tree. Built on React Aria CheckboxField + CheckboxButton: a native <input type="checkbox"> stays in
the DOM (visually hidden) so forms, autofill and form reset work; Tab focuses it, Space toggles it, and
isIndeterminate is exposed as "mixed" (WCAG 2.1.1, 4.1.2). Checked and indeterminate are shown by a check mark and a
dash, not by colour alone (1.4.1); keyboard focus draws the ring on the box (2.4.7); the pointer target is 24 x 24 px
(2.5.8). Inside a React Aria Table, GridList or Tree, slot="selection" makes it the row selector. Use CheckboxField for a labelled option with helper text, CheckboxCard for a large option, CheckboxGroup to
group options, and Switch for settings that apply immediately. Consumer duties: the label wording (positive
statements, "Send me payslip emails") and the name of an unlabelled box.
import { Checkbox } from "@nexera-ui/react";- 6
- examples
- 27
- props
- 6
- live controls
- 1
- platform
- 10
- WCAG criteria
- 3
- blocks use it
Try every prop. Copy the code.
Change the props and the code updates. Check light and dark, LTR and RTL, and phone width.
import { Checkbox } from "@nexera-ui/react";
<Checkbox />Examples 5
The same examples as Storybook, rendered live. Open Code to copy one.
Values
Figma Value: Unchecked, Checked (isSelected/defaultSelected) and Indeterminate (isIndeterminate).
import { Checkbox } from "@nexera-ui/react";
export function Values() {
return (
<div className="flex items-center gap-6">
<Checkbox aria-label="Unchecked" />
<Checkbox aria-label="Checked" defaultSelected />
<Checkbox aria-label="Indeterminate" isIndeterminate />
</div>
);
}
Disabled and invalid
Figma State=Disabled (isDisabled) and State=Error (isInvalid) for every value; hover and focus by interaction.
import { Checkbox } from "@nexera-ui/react";
export function DisabledAndInvalid() {
return (
<div className="flex flex-col gap-4">
<div className="flex items-center gap-6">
<Checkbox aria-label="Disabled" isDisabled />
<Checkbox aria-label="Disabled checked" isDisabled defaultSelected />
<Checkbox aria-label="Disabled indeterminate" isDisabled isIndeterminate />
</div>
<div className="flex items-center gap-6">
<Checkbox aria-label="Invalid" isInvalid />
<Checkbox aria-label="Invalid checked" isInvalid defaultSelected />
<Checkbox aria-label="Invalid indeterminate" isInvalid isIndeterminate />
</div>
</div>
);
}
With label
With a visible label (children): the whole row is the target and the label wraps. Use CheckboxField for helper text.
import { Checkbox } from "@nexera-ui/react";
export function WithLabel() {
return (
<div className="flex max-w-xs flex-col gap-3">
<Checkbox defaultSelected>Send me payslip emails</Checkbox>
<Checkbox>
Send me an email whenever someone on my team requests leave, including half days
</Checkbox>
</div>
);
}
Group
CheckboxGroup: a named group with helper text, a required asterisk and a group error. Its label, helper and error follow the Figma Radio group.
import { Checkbox, CheckboxGroup } from "@nexera-ui/react";
export function Group() {
return (
<CheckboxGroup
label="Notify me about"
description="Sent to your work email."
isRequired
defaultValue={["leave"]}
name="notify"
>
<Checkbox value="leave">Leave requests</Checkbox>
<Checkbox value="payslips">Payslips</Checkbox>
<Checkbox value="reviews">Performance reviews</Checkbox>
</CheckboxGroup>
);
}
Right to left
Right-to-left: the box moves to the start (right) of the label.
import { Checkbox, CheckboxGroup } from "@nexera-ui/react";
export function RightToLeft() {
return (
<CheckboxGroup label="أرسل لي إشعارات عن" defaultValue={["leave"]}>
<Checkbox value="leave">طلبات الإجازة</Checkbox>
<Checkbox value="payslips">قسائم الرواتب، بما في ذلك المكافآت والبدلات الشهرية</Checkbox>
</CheckboxGroup>
);
}
Props 27
Press "Try it" on a card to load that prop into the playground.
27 props shown
classNameNexerastringExtra classes for the root, merged last so they win over the defaults.
styleNexeraCSSPropertiesInline style of the root.
childrenNexeraVisibleContentVisible label after the box (Component/Label). It is the accessible name, wraps and is never truncated. For a label
with helper text use CheckboxField.
No visible label.
aria-labelNexerastringOverrides the name given by children. Avoid: the name must contain the visible text (WCAG 2.5.3).
Accessible name, for example "Select Ayesha Khan". Translate it.
Accessible name; aria-labelledby wins when both are set.
aria-labelledbyNexerastringId(s) of element(s) that name the checkbox instead of children.
Id(s) of element(s) that name the checkbox; wins over aria-label.
Id(s) of visible element(s) that name the checkbox.
validationBehaviorReact Aria"native" | "aria"Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.
isIndeterminateReact AriabooleanIndeterminism is presentational only. The indeterminate visual representation remains regardless of user interaction.
valueReact AriastringThe value of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefvalue).
defaultSelectedReact AriabooleanWhether the element should be selected (uncontrolled).
isSelectedReact AriabooleanWhether the element should be selected (controlled).
onChangeReact Aria(isSelected: boolean) => voidHandler that is called when the element's selection state changes.
isDisabledReact AriabooleanWhether the input is disabled.
isReadOnlyReact AriabooleanWhether the input can be selected but not changed by the user.
isRequiredReact AriabooleanWhether user input is required on the input before form submission.
isInvalidReact AriabooleanWhether the input value is invalid.
validateReact Aria(value: boolean) => true | ValidationError | nullA function that returns an error message if a given value is invalid.
Validation errors are displayed to the user when the form is submitted
if validationBehavior="native". For realtime validation, use the isInvalid
prop instead.
autoFocusReact AriabooleanWhether the element should receive focus on render.
nameReact AriastringThe name of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).
formReact AriastringThe <form> element to associate the input with.
The value of this attribute must be the id of a <form> in the same document.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#form).
idReact AriastringThe element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).
aria-describedbyReact AriastringIdentifies the element (or elements) that describes the object.
onPressReact Aria(e: PressEvent) => voidHandler that is called when the press is released over the target.
onPressStartReact Aria(e: PressEvent) => voidHandler that is called when a press interaction starts.
onPressEndReact Aria(e: PressEvent) => voidHandler that is called when a press interaction ends, either over the target or when the pointer leaves the target.
onPressChangeReact Aria(isPressed: boolean) => voidHandler that is called when the press state changes.
onPressUpReact Aria(e: PressEvent) => voidHandler that is called when a press is released over the target, regardless of whether it started on the target or not.
inputRefReact AriaRef<HTMLInputElement | null>A ref for the HTML input element.
* Required. React Aria props shown are the ones most apps use; the component accepts the rest of its React Aria props too.
Accessible by default.
Built on React Aria, and covered by the WCAG 2.2 evidence generated on every build.
WCAG 2.2 evidence
7 direct · 3 supporting- 1.1.1Non-text ContentLevel A · tested directly
- 1.3.1Info and RelationshipsLevel A · tested directly
- 1.4.1Use of ColorLevel A · tested directly
- 1.4.4Resize TextLevel AA · supporting test
- 1.4.12Text SpacingLevel AA · supporting test
- 2.1.1KeyboardLevel A · tested directly
- 2.4.7Focus VisibleLevel AA · tested directly
- 2.5.8Target Size (Minimum)Level AA · supporting test
- 3.3.1Error IdentificationLevel A · tested directly
- 4.1.2Name, Role, ValueLevel A · tested directly
Fits any width.
Nexera components respond to the space they are given. Drag the corner of the frame, or pick a width.
Styling hooks
Pass className to add Tailwind classes (merged last). State is exposed as data attributes, so you can style it with variants like data-pressed:.
data-disableddata-hovereddata-invaliddata-readonlydata-selected
<Checkbox className="data-disabled:opacity-90 shadow-sm" />Used in blocks
Related components
- CalendarDayOne day of a {@link CalendarMonth } grid, built on React Aria `CalendarCell`: a `gridcell` whose button is named by the full, localised date ("Wednesday, October 14, 2026"), with `aria-selected`, `aria-disabled` and the "today" and range descriptions read by screen readers (WCAG 1.3.1, 4.1.2).
- CalendarMonthA month calendar for picking a date or a date range: header with previous / next buttons and the localised month name, weekday row, and six weeks of `CalendarDay`s.
- CheckboxCardA large checkbox option with an icon, a title and a description, for a few options that need explanation (notification channels, benefits).
- CheckboxFieldA checkbox with a label and optional helper text: the box (the same element as `Checkbox`) followed by the label and description, applied on submit.
- ColorInputA hex colour field with a swatch and a picker popover.
- ColorPickerPicks a colour.
- ColorTokenCardDocumentation card for one colour token: a 96 px colour sample with an "Aa" text sample, then the name, token path, hex value and contrast note as text.
- ComboboxA text field with a filtered list of options.