useCheckbox

Provides the behavior and accessibility implementation for a checkbox component. Checkboxes allow users to select multiple items from a list of individual items, or to mark one individual item as selected.

Install

Yarn

yarn add @react-native-aria/checkbox

npm

npm install @react-native-aria/checkbox

Import

import { useCheckbox } from "@react-native-aria/checkbox";

API

useCheckbox(props: AriaCheckboxProps, state: ToggleState, inputRef: RefObject): CheckboxAria

AriaCheckboxProps

• Props for the checkbox.

ToggleState

• State for the checkbox, as returned by useToggleState.

inputRef

• A ref for the HTML or Pressable/Touchable element.

CheckboxAria

{ inputProps: InputHTMLAttributes<HTMLInputElement> & AccessibilityProps }

Props for the input or Pressable/Touchable element.

Example