CheckboxField - AMiSi Mobile Starter

CheckboxField is a controlled checkbox presented as a pressable field.

Usage

import { useState } from 'react';

import { CheckboxField } from '@amisi-mobile-starter/ui';

export const TermsField = () => {
  const [isAccepted, setIsAccepted] = useState(false);

  return (
    <CheckboxField
      label="I accept the terms"
      value={isAccepted}
      onValueChange={setIsAccepted}
      helperText="Required before you continue."
    />
  );
};

Props

Prop	Type	Default	Description
`label`	`string`	Required	Checkbox label.
`value`	`boolean`	Required	Controlled checked state.
`onValueChange`	`(nextValue: boolean) => void`	Required	Receives the inverted value after a press.
`helperText`	`string`	`undefined`	Supporting text shown when there is no error.
`error`	`string`	`undefined`	Error shown instead of helper text.
`containerStyle`	`StyleProp<ViewStyle>`	`undefined`	Style for the outer wrapper.

It accepts PressableProps except children, onPress, and style.