Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
React Native docs
FormsReact Native

Checkbox

Capture a controlled Boolean choice with a generous native target and supporting text.

Public APILumenCheckboxReact Native

Native example

Use Checkbox

Use for an independently selectable Boolean choice. Prefer Toggle when changing the value applies immediately as a setting.

View verified React Native runtime capture
Checkbox rendered in the Expo web renderer Lumen playground
Verified runtime captureExpo web renderer
tsx
<LumenCheckbox
  label="Share analytics"
  checked={sharesAnalytics}
  onCheckedChange={setSharesAnalytics}
/>

Reference

Public API

The primary shared and platform-specific options exposed by LumenCheckbox.

APIValues or typeDefaultDescription
labelStringRequiredProvides the visible and accessible label.
checkedbooleanRequiredStores the controlled checked state.
onCheckedChange(Boolean) -> UnitRequiredUpdates the controlled state.
descriptionString?nilAdds optional supporting text.
disabledBooleanfalseControls native disabled state.

Native behavior

Design and accessibility

When to use it

Use for an independently selectable Boolean choice. Prefer Toggle when changing the value applies immediately as a setting.

Accessibility

The full labeled row is a native checkbox target and exposes checked and disabled state without duplicating the visual indicator.

Shared component

Available on other platforms

Apple / SwiftUIAndroid / Compose
React Native docsNative primitives