Checkbox Primitive
A box that is a checked (ticked) indicator when activated.
Installation
Install the component via your command line.
npx expo install @rn-primitives/checkboxInstall @radix-ui/react-checkbox
npx expo install @radix-ui/react-checkboxCopy/paste the following code for web to ~/components/primitives/checkbox/checkbox.web.tsx
import * as Checkbox from '@radix-ui/react-checkbox';import { useAugmentedRef } from '~/components/primitives/hooks';import * as Slot from '~/components/primitives/slot';import type { ComponentPropsWithAsChild, PressableRef, SlottablePressableProps,} from '~/components/primitives/types';import * as React from 'react';import { GestureResponderEvent, Pressable, View } from 'react-native';import type { CheckboxIndicator, CheckboxRootProps } from './types';
const CheckboxContext = React.createContext<CheckboxRootProps | null>(null);
const Root = React.forwardRef<PressableRef, SlottablePressableProps & CheckboxRootProps>( ( { asChild, disabled, checked, onCheckedChange, onPress: onPressProp, role: _role, ...props }, ref ) => { const augmentedRef = useAugmentedRef({ ref });
function onPress(ev: GestureResponderEvent) { onPressProp?.(ev); onCheckedChange(!checked); }
React.useLayoutEffect(() => { if (augmentedRef.current) { const augRef = augmentedRef.current as unknown as HTMLButtonElement; augRef.dataset.state = checked ? 'checked' : 'unchecked'; augRef.value = checked ? 'on' : 'off'; } }, [checked]);
React.useLayoutEffect(() => { if (augmentedRef.current) { const augRef = augmentedRef.current as unknown as HTMLButtonElement; augRef.type = 'button'; augRef.role = 'checkbox';
if (disabled) { augRef.dataset.disabled = 'true'; } else { augRef.dataset.disabled = undefined; } } }, [disabled]);
const Component = asChild ? Slot.Pressable : Pressable; return ( <CheckboxContext.Provider value={{ checked, disabled, onCheckedChange }}> <Checkbox.Root checked={checked} onCheckedChange={onCheckedChange} disabled={disabled} asChild > <Component ref={augmentedRef} role='button' onPress={onPress} disabled={disabled} {...props} /> </Checkbox.Root> </CheckboxContext.Provider> ); });
Root.displayName = 'RootWebCheckbox';
function useCheckboxContext() { const context = React.useContext(CheckboxContext); if (context === null) { throw new Error( 'Checkbox compound components cannot be rendered outside the Checkbox component' ); } return context;}
const Indicator = React.forwardRef< React.ElementRef<typeof View>, ComponentPropsWithAsChild<typeof View> & CheckboxIndicator>(({ asChild, forceMount, ...props }, ref) => { const { checked, disabled } = useCheckboxContext(); const augmentedRef = useAugmentedRef({ ref });
React.useLayoutEffect(() => { if (augmentedRef.current) { const augRef = augmentedRef.current as unknown as HTMLDivElement; augRef.dataset.state = checked ? 'checked' : 'unchecked'; } }, [checked]);
React.useLayoutEffect(() => { if (augmentedRef.current) { const augRef = augmentedRef.current as unknown as HTMLDivElement; if (disabled) { augRef.dataset.disabled = 'true'; } else { augRef.dataset.disabled = undefined; } } }, [disabled]);
const Component = asChild ? Slot.View : View; return ( <Checkbox.Indicator forceMount={forceMount} asChild> <Component ref={ref} {...props} /> </Checkbox.Indicator> );});
Indicator.displayName = 'IndicatorWebCheckbox';
export { Indicator, Root };Copy/paste the following code for native to ~/components/primitives/checkbox/checkbox.tsx
import * as React from 'react';import { GestureResponderEvent, Pressable, View } from 'react-native';import * as Slot from '~/components/primitives/slot';import type { ComponentPropsWithAsChild, PressableRef, SlottablePressableProps,} from '~/components/primitives/types';import type { CheckboxIndicator, CheckboxRootProps } from './types';
interface RootContext extends CheckboxRootProps { nativeID?: string;}
const CheckboxContext = React.createContext<RootContext | null>(null);
const Root = React.forwardRef<PressableRef, SlottablePressableProps & CheckboxRootProps>( ({ asChild, disabled = false, checked, onCheckedChange, nativeID, ...props }, ref) => { return ( <CheckboxContext.Provider value={{ disabled, checked, onCheckedChange, nativeID, }} > <Trigger ref={ref} {...props} /> </CheckboxContext.Provider> ); });
Root.displayName = 'RootNativeCheckbox';
function useCheckboxContext() { const context = React.useContext(CheckboxContext); if (!context) { throw new Error( 'Checkbox compound components cannot be rendered outside the Checkbox component' ); } return context;}
const Trigger = React.forwardRef<PressableRef, SlottablePressableProps>( ({ asChild, onPress: onPressProp, ...props }, ref) => { const { disabled, checked, onCheckedChange, nativeID } = useCheckboxContext();
function onPress(ev: GestureResponderEvent) { if (disabled) return; const newValue = !checked; onCheckedChange(newValue); onPressProp?.(ev); }
const Component = asChild ? Slot.Pressable : Pressable; return ( <Component ref={ref} nativeID={nativeID} aria-disabled={disabled} role='checkbox' aria-checked={checked} onPress={onPress} accessibilityState={{ checked, disabled, }} disabled={disabled} {...props} /> ); });
Trigger.displayName = 'TriggerNativeCheckbox';
const Indicator = React.forwardRef< React.ElementRef<typeof View>, ComponentPropsWithAsChild<typeof View> & CheckboxIndicator>(({ asChild, forceMount, ...props }, ref) => { const { checked, disabled } = useCheckboxContext();
if (!forceMount) { if (!checked) { return null; } }
const Component = asChild ? Slot.View : View; return ( <Component ref={ref} aria-disabled={disabled} aria-hidden={!(forceMount || checked)} role={'presentation'} {...props} /> );});
Indicator.displayName = 'IndicatorNativeCheckbox';
export { Indicator, Root };Copy/paste the following code for types to ~/components/primitives/checkbox/types.ts
import type { ForceMountable } from '~/components/primitives/types';
interface CheckboxRootProps { checked: boolean; onCheckedChange: (checked: boolean) => void; disabled?: boolean;}
type CheckboxIndicator = ForceMountable;
export type { CheckboxRootProps, CheckboxIndicator };Copy/paste the following code for exporting to ~/components/primitives/checkbox/index.ts
export * from './checkbox';Copy/paste the following code for native to ~/components/primitives/checkbox/index.tsx
import * as React from 'react';import { GestureResponderEvent, Pressable, View } from 'react-native';import * as Slot from '~/components/primitives/slot';import type { ComponentPropsWithAsChild, PressableRef, SlottablePressableProps,} from '~/components/primitives/types';import type { CheckboxIndicator, CheckboxRootProps } from './types';
interface RootContext extends CheckboxRootProps { nativeID?: string;}
const CheckboxContext = React.createContext<RootContext | null>(null);
const Root = React.forwardRef<PressableRef, SlottablePressableProps & CheckboxRootProps>( ({ asChild, disabled = false, checked, onCheckedChange, nativeID, ...props }, ref) => { return ( <CheckboxContext.Provider value={{ disabled, checked, onCheckedChange, nativeID, }} > <Trigger ref={ref} {...props} /> </CheckboxContext.Provider> ); });
Root.displayName = 'RootNativeCheckbox';
function useCheckboxContext() { const context = React.useContext(CheckboxContext); if (!context) { throw new Error( 'Checkbox compound components cannot be rendered outside the Checkbox component' ); } return context;}
const Trigger = React.forwardRef<PressableRef, SlottablePressableProps>( ({ asChild, onPress: onPressProp, ...props }, ref) => { const { disabled, checked, onCheckedChange, nativeID } = useCheckboxContext();
function onPress(ev: GestureResponderEvent) { if (disabled) return; const newValue = !checked; onCheckedChange(newValue); onPressProp?.(ev); }
const Component = asChild ? Slot.Pressable : Pressable; return ( <Component ref={ref} nativeID={nativeID} aria-disabled={disabled} role='checkbox' aria-checked={checked} onPress={onPress} accessibilityState={{ checked, disabled, }} disabled={disabled} {...props} /> ); });
Trigger.displayName = 'TriggerNativeCheckbox';
const Indicator = React.forwardRef< React.ElementRef<typeof View>, ComponentPropsWithAsChild<typeof View> & CheckboxIndicator>(({ asChild, forceMount, ...props }, ref) => { const { checked, disabled } = useCheckboxContext();
if (!forceMount) { if (!checked) { return null; } }
const Component = asChild ? Slot.View : View; return ( <Component ref={ref} aria-disabled={disabled} aria-hidden={!(forceMount || checked)} role={'presentation'} {...props} /> );});
Indicator.displayName = 'IndicatorNativeCheckbox';
export { Indicator, Root };Copy/paste the following code for types to ~/components/primitives/checkbox/types.ts
import type { ForceMountable } from '~/components/primitives/types';
interface CheckboxRootProps { checked: boolean; onCheckedChange: (checked: boolean) => void; disabled?: boolean;}
type CheckboxIndicator = ForceMountable;
export type { CheckboxRootProps, CheckboxIndicator };Usage
import * as CheckboxPrimitive from '@rn-primitives/checkbox';
function Example() { const [checked, setChecked] = React.useState(false); return ( <CheckboxPrimitive.Root checked={checked} onCheckedChange={setChecked}> <CheckboxPrimitive.Indicator style={{ height: 4, width: 4, backgroundColor: 'red'}} /> </CheckboxPrimitive.Root> );}Props
Root
Extends Pressable props
| Prop | Type | Note |
|---|---|---|
| checked* | boolean | |
| onCheckedChange* | (checked: boolean) => void | |
| disabled | boolean | (optional) |
Indicator
Extends View props
| Prop | Type | Note |
|---|---|---|
| forceMount | true | undefined | (optional) |