> ## 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.

# RadioGroupField

> Select one string value from a labeled option group

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>;
};

`RadioGroupField` renders all options and reports the selected string value.

<LocalUiPlayground component="radio-group-field" title="Interactive RadioGroupField example" />

## Usage

```tsx theme={null}
import { useState } from 'react';

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

const options = [
  { label: 'Monthly', value: 'monthly' },
  { label: 'Yearly', value: 'yearly' },
];

export const BillingCycleField = () => {
  const [cycle, setCycle] = useState('monthly');

  return (
    <RadioGroupField
      label="Billing cycle"
      value={cycle}
      options={options}
      onValueChange={setCycle}
    />
  );
};
```

## Props

| Prop            | Type                                      | Default     | Description                                   |
| --------------- | ----------------------------------------- | ----------- | --------------------------------------------- |
| `label`         | `string`                                  | `undefined` | Group label.                                  |
| `value`         | `string`                                  | Required    | Controlled selected value.                    |
| `options`       | `Array<{ label: string; value: string }>` | Required    | Available options.                            |
| `onValueChange` | `(nextValue: string) => void`             | Required    | Runs when an option is pressed.               |
| `helperText`    | `string`                                  | `undefined` | Supporting text shown when there is no error. |
| `error`         | `string`                                  | `undefined` | Error shown instead of helper text.           |
| `optionProps`   | `Omit<PressableProps, 'onPress'>`         | `undefined` | Native props spread onto every option.        |

`RadioGroupField` also accepts React Native `ViewProps`.