> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mobile-starter.amisi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CheckboxField

> Toggle a labeled boolean value with validation feedback

export const LocalUiPlayground = ({component, title, height = 640}) => {
  const [playgroundUrl, setPlaygroundUrl] = useState(null);
  useEffect(() => {
    const isLocal = window.location.hostname === 'localhost' || window.location.hostname === '127.0.0.1';
    setPlaygroundUrl(isLocal ? 'http://localhost:8090/' : 'https://selcouthdigital.github.io/amisi-mobile-starter/');
  }, []);
  if (!playgroundUrl) {
    return null;
  }
  return <div className="not-prose my-6 overflow-hidden rounded-xl border border-zinc-950/10 bg-white dark:border-white/10 dark:bg-zinc-950">
      <iframe src={`${playgroundUrl}?component=${component}`} title={title} className="block w-full" style={{
    height
  }} loading="lazy" />
    </div>;
};

`CheckboxField` is a controlled checkbox presented as a pressable field.

<LocalUiPlayground component="checkbox-field" title="Interactive CheckboxField example" />

## Usage

```tsx theme={null}
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`.