Checkbox

Controlled boolean/indeterminate checkbox; enabled usage without onCheckedChange warns in development.

Distribution status

BeeUI 0.86.2-rc.3 is public on npm under the opt-in next dist-tag (observed 2026-09-25T06:25:18.371Z). latest currently resolves to 0.86.2-rc.3 and lags next until the owner moves it for all four packages. See Start for the full install commands. The import shape below works against the published package; the repository-local Registry command remains available as a no-registry-required alternative from a BeeUI checkout. Pin @0.86.2-rc.3 instead of @next for an immutable version in CI.

Identity

• Category: Forms & selection
• Status: stable public Registry/export-map component family
• Targets: iOS · Android · Web, subject to the compatibility contract
• Prerequisites: @beemvp/beeui-ui installed (or this component’s source copied via the Registry CLI below) and, on Web, the BeeUI Tailwind/Uniwind theme CSS loaded — see Start for full platform setup.
• Source: packages/ui/src/components/checkbox.tsx

Import

import { Checkbox, checkboxIndicatorVariants } from '@beemvp/beeui-ui';

There is no documented deep/private source import. For source ownership from a BeeUI checkout:

pnpm beeui add checkbox

Registry (used throughout this page) is BeeUI’s source-ownership manifest — registry/registry.json — that the pnpm beeui/@beemvp/beeui-cli CLI reads to copy a component’s real source into your app and rewrite its internal imports; it is not an npm package index. This component’s own Registry entry: registry/registry.json.

Composition and public API

• Family exports: Checkbox checkboxIndicatorVariants
  • Also routed here, outside the Registry family:
    • checkbox
  • Package export subpath: @beemvp/beeui-ui/checkbox

Exported types: CheckboxProps, CheckboxValue

The generated API inventory is mechanically joined to packages/ui/src/index.ts, Registry metadata, and the component reference contract. Each type’s field table below is parsed directly from that source, not a second hand-maintained copy; for the fuller behavior narrative see the canonical component behavior catalog.

State and behavior contract

Controlled boolean/indeterminate checked/onCheckedChange checkbox; enabling it without onCheckedChange warns in development instead of silently doing nothing, and disabled blocks both press handling and the accessibility toggle action.

Props

CheckboxProps

Prop	Type	Default	Description
checked	CheckboxValue	false	The checkbox’s state: true (checked), false (unchecked), or 'indeterminate' (a dash, e.g. a “select all” with a partial selection). Always controlled by the caller; defaults to false.
className	string	—	Extra utility classes, merged after the component’s own via cn(...), so they win on conflict. An escape hatch for source-owned and application work, not a cross-engine portability guarantee.
indicatorClassName	string	—	Applied to the checkbox’s own box, not its label.
label	string	—	The visible text naming this element, and the accessible name unless one is set explicitly.
labelClassName	string	—	Extra utility classes for the label text specifically, merged after the component’s own.
onCheckedChange	(checked: boolean) => void	—	Called with the next checked state (true/false, never 'indeterminate') when pressed. Toggles from 'indeterminate' to true.

Also carries every prop of Omit<PressableProps, 'accessibilityRole' | 'role' | 'children' | 'onPress'> — that upstream contract is not reproduced here.

Related exported types:

• CheckboxValue — alias of boolean | 'indeterminate'.

The executable fixtures below are the source-grounded usage examples; consumers should not infer state ownership from DOM structure or another UI library.

Provider and dependencies

• No additional provider is required by this family. BeeUIProvider remains the recommended application root.
• Peer/native dependencies visible to this Registry item: react, react-native
• Registry dependency closure: core-cn, text, theme, use-required-callback-warning
• Safe-area ownership remains explicit: shell surfaces touching system edges opt into SafeArea; components do not silently invent app-shell insets.
• Web consumers load the BeeUI semantic theme CSS as documented in Web onboarding.

Platform behavior

This family ships no platform-specific file, and its own source takes no Platform branch.

The same public family is exposed across the supported target matrix; meaningful platform differences remain governed by the compatibility contract.

Evidence classes are not equal and this page does not blur them: Web behavior is exercised in a real browser, while iOS and Android carry package/export and native-compile evidence, which is not device-runtime proof. The compatibility contract records which class each claim rests on.

Accessibility

• Roles this family assigns: checkbox — set in checkbox.tsx by the components themselves, not by the caller.
• Accessibility states and properties it sets: accessibilityHint, accessibilityLabel, accessibilityLabelledBy, accessible, checked, disabled, required — read from checkbox.tsx.

Keyboard/focus behavior, announcements, Dynamic Type/Web zoom, RTL and reduced-motion expectations are not derived here — see Accessibility overview, Keyboard & focus, RTL/localization and Large text & zoom. BeeUI does not claim universal accessibility certification from automated tests.

Styling and theming

• Style axes: none of its own — its appearance comes from tokens and your own classes; it also carries Omit<PressableProps, 'accessibilityRole' | 'role' | 'children' | 'onPress'>.
• Class-name surfaces: className, indicatorClassName, labelClassName.

Colors, spacing and typography come from semantic tokens rather than from values written here — see Theming and Density. A className is an escape hatch for source-owned and application work, not a cross-engine portability guarantee.

Executable examples

• Primary executable fixture: apps/showcase/__tests__/checkbox-radio-field-form-group-context.test.tsx
• Additional fixture: apps/showcase/__tests__/component-contracts.test.tsx
• Additional fixture: apps/showcase/__tests__/dynamic-type-contract.test.tsx
• Additional fixture: apps/showcase/__tests__/form-group-checkbox-list-group-semantics.test.tsx

Addressable examples

Each link below opens the Showcase at that exact example, not at the top of the gallery:

• basic — smallest meaningful complete usage
• states — the states example

The Showcase links demonstrate Web behavior; use the native-preview guide for real simulator/emulator/device paths.

Live Web preview

This frame loads the real BeeUI Web Showcase on demand; it is not a second docs-only implementation. It proves browser behavior only. Use native preview for iOS/Android simulator, emulator or device paths.

Composition anatomy

• Family root / primary export: Checkbox
  • Public composition parts / helpers:
    • checkboxIndicatorVariants
  • Exported type surface:
    • CheckboxProps
    • CheckboxValue

The tree above is ordinary document structure so it remains readable with keyboard and assistive technology; it is derived from the real public export family rather than a canvas-only diagram.

Verified example source

These are the parts of the typechecked runtime Showcase fixture behind this live preview — apps/showcase/component-gallery/component-gallery.tsx, 1103 lines — where Checkbox is actually used: 19 lines in 2 places. Each block is copied verbatim from the line range named above it, so it is the same executable source, not a retelling of it. The rest of that file exercises other families and is not reproduced here.

Imports the examples below need (a filtered subset of the fixture’s own top-level imports):

import { Checkbox } from '@beemvp/beeui-ui';
import * as React from 'react';

Fixture state this block reads (same file, line 459):

  const [accepted, setAccepted] = React.useState(false);

lines 623–630:

              <Checkbox checked={accepted} label="Accept terms" onCheckedChange={setAccepted} />
              <Checkbox
                checked
                disabled
                label="Managed by policy"
                onCheckedChange={() => undefined}
                testID="checkbox-managed-state"
              />

Fixture state this block reads (same file, line 460):

  const [assignedStores, setAssignedStores] = React.useState<string[]>([]);

lines 652–662:

                  <Checkbox
                    checked={assignedStores.includes(store)}
                    key={store}
                    label={store}
                    onCheckedChange={(checked) =>
                      setAssignedStores((current) =>
                        checked ? [...current, store] : current.filter((value) => value !== store),
                      )
                    }
                    testID={`stores-checkbox-${store.replace(/\s+/g, '-').toLowerCase()}`}
                  />

Open the fixture itself for the full surrounding component. For a smaller app-specific example, start from the imports and fixture-state blocks above and keep only the state your screen owns.

Limitations

Pressing an indeterminate checkbox reports true: onCheckedChange is never called with the indeterminate value, so the component can never return to that state on its own — the caller has to set checked back. label accepts a string only, and press handling is owned here.

Related

• All components
• Production patterns
• Showcase
• CLI & source ownership
• Source