Checkbox

Animated checkbox, as a row or a selectable card.

A checkbox with an animated check. variant="card" turns the whole surface into the target, for pickable options where the box confirms a choice rather than being the affordance.

Installation

Checkbox ships with the library — no separate install.

import { Checkbox } from 'panelui-native';

Usage

<Checkbox
  checked={accepted}
  onCheckedChange={setAccepted}
  label="Marketing & promotions"
  description="Special offers and exclusive deals"
/>

<Checkbox
  variant="card"
  checked={plan === 'pro'}
  onCheckedChange={() => setPlan('pro')}
  label="Pro"
  description="Advanced analytics and priority support."
/>

Variants

variant

  • default (default)
  • card

API Reference

Checkbox

PropTypeDefaultDescription
classNamestring
checkedboolean
onCheckedChange(checked: boolean) => void
disabledboolean
labelstringOptional label rendered next to the box; pressing it also toggles.
descriptionstringSecondary line under the label, for extra context.

Every part also accepts the underlying React Native props (ViewProps or TextProps) and a className for Tailwind utilities.

Notes

With a description the row aligns the box to the label rather than centring it against the whole block. The card variant moves the box after the content so it sits top-right, and takes the primary border when checked.

On this page