Checkbox
Checkbox Primitive
Demo
A box that is a checked (ticked) indicator when activated.
Installation
npx @react-native-reusables/cli@latest add checkboxCopy/paste the following code to ~/components/ui/checkbox.tsx:
import { Check } from '~/components/Icons';import * as React from 'react';import * as CheckboxPrimitive from '~/components/primitives/checkbox';
import { Platform } from 'react-native';import { cn } from '~/lib/utils';
const Checkbox = React.forwardRef< React.ElementRef<typeof CheckboxPrimitive.Root>, React.ComponentPropsWithoutRef<typeof CheckboxPrimitive.Root>>(({ className, ...props }, ref) => { return ( <CheckboxPrimitive.Root ref={ref} className={cn( 'web:peer h-4 w-4 native:h-[20] native:w-[20] shrink-0 rounded-sm native:rounded border border-primary web:ring-offset-background web:focus-visible:outline-none web:focus-visible:ring-2 web:focus-visible:ring-ring web:focus-visible:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50', props.checked && 'bg-primary', className )} {...props} > <CheckboxPrimitive.Indicator className={cn('items-center justify-center h-full w-full')}> <Check size={12} strokeWidth={Platform.OS === 'web' ? 2.5 : 3.5} className='text-primary-foreground' /> </CheckboxPrimitive.Indicator> </CheckboxPrimitive.Root> );});Checkbox.displayName = CheckboxPrimitive.Root.displayName;
export { Checkbox };Usage
import { Checkbox } from '~/components/ui/checkbox';
function Example() { const [checked, setChecked] = React.useState(false); return ( <Checkbox checked={checked} onCheckedChange={setChecked} /> );}Props
Checkbox
Extends Pressable props
| Prop | Type | Note |
|---|---|---|
| checked* | boolean | |
| onCheckedChange* | (checked: boolean) => void | |
| disabled | boolean | (optional) |