# Radio Group Field

Source: https://payloadcms.com/docs/beta/fields/radio

The Radio Field allows for the selection of one value from a predefined set of possible values and presents a radio group-style set of inputs to the [Admin Panel](/docs/v4/admin/overview.md).

![Shows a Radio field in the Payload Admin Panel](https://payloadcms.com/images/docs/fields/radio.png)

_Admin Panel screenshot of a Radio field_

To add a Radio Field, set the `type` to `radio` in your [Field Config](/docs/v4/fields/overview.md):

```ts
import type { Field } from 'payload'

export const MyRadioField: Field = {
  // ...
  // highlight-start
  type: 'radio',
  options: [
    // ...
  ],
  // highlight-end
}
```

## Config Options

| Option              | Description                                                                                                                                                                                                                                                                                             |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`name`** \*       | To be used as the property name when stored and retrieved from the database. [More details](/docs/v4/fields/overview.md#field-names).                                                                                                                                                                         |
| **`options`** \*    | Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing a `label` string and a `value` string.                                                                                                                                               |
| **`label`**         | Text used as a field label in the Admin Panel or an object with keys for each language.                                                                                                                                                                                                                 |
| **`validate`**      | Provide a custom validation function that will be executed on both the Admin Panel and the backend. [More details](/docs/v4/fields/overview.md#validation).                                                                                                                                                   |
| **`index`**         | Build an [index](/docs/v4/database/indexes.md) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often.                                                                                                                                 |
| **`saveToJWT`**     | If this field is top-level and nested in a config supporting [Authentication](/docs/v4/authentication/overview.md), include its data in the user JWT.                                                                                                                                                         |
| **`hooks`**         | Provide Field Hooks to control logic for this field. [More details](/docs/v4/hooks/fields.md).                                                                                                                                                                                                                   |
| **`access`**        | Provide Field Access Control to denote what users can see and do with this field's data. [More details](/docs/v4/access-control/fields.md).                                                                                                                                                                      |
| **`hidden`**        | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel.                                                                                                                                                        |
| **`defaultValue`**  | Provide data to be used for this field's default value. The default value must exist within provided values in `options`. [More details](/docs/v4/fields/overview.md#default-values).                                                                                                                         |
| **`localized`**     | Enable localization for this field. Requires [localization to be enabled](/docs/v4/configuration/localization.md) in the Base config.                                                                                                                                                                         |
| **`required`**      | Require this field to have a value.                                                                                                                                                                                                                                                                     |
| **`admin`**         | Admin-specific configuration. [More details](#admin-options).                                                                                                                                                                                                                                           |
| **`custom`**        | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                                                                                               |
| **`enumName`**      | Custom enum name for this field when using SQL Database Adapter ([Postgres](/docs/v4/database/postgres.md)). Auto-generated from name if not defined.                                                                                                                                                         |
| **`interfaceName`** | Create a top level, reusable [Typescript interface](/docs/v4/typescript/generating-types.md#custom-field-interfaces) & [GraphQL type](/docs/v4/graphql/graphql-schema.md#custom-field-schemas).                                                                                                                     |
| **`jsonSchema`**    | Override field JSON Schema used for type generation and MCP validation                                                                                                                                                                                                                                  |
| **`virtual`**       | Provide `true` to disable field in the database, or provide a string path to [link the field with a relationship](/docs/v4/fields/relationship.md#linking-virtual-fields-with-relationships). See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) |

_\* An asterisk denotes that a property is required._

> **Important:**
>
> Option values should be strings that do not contain hyphens or special characters due to GraphQL
> enumeration naming constraints. Underscores are allowed. If you determine you need your option
> values to be non-strings or contain special characters, they will be formatted accordingly before
> being used as a GraphQL enum.

## Admin Options

To customize the appearance and behavior of the Radio Field in the [Admin Panel](/docs/v4/admin/overview.md), you can use the `admin` option:

```ts
import type { Field } from 'payload'

export const MyRadioField: Field = {
  // ...
  admin: {
    // highlight-line
    // ...
  },
}
```

The Radio Field inherits all of the default admin options from the base [Field Admin Config](/docs/v4/fields/overview.md#admin-options), plus the following additional options:

| Property     | Description                                                                                                                  |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------- |
| **`layout`** | Allows for the radio group to be styled as a horizontally or vertically distributed list. The default value is `horizontal`. |

## Example

```ts
import type { CollectionConfig } from 'payload'

export const ExampleCollection: CollectionConfig = {
  slug: 'example-collection',
  fields: [
    {
      name: 'color', // required
      type: 'radio', // required
      options: [
        // required
        {
          label: 'Mint',
          value: 'mint',
        },
        {
          label: 'Dark Gray',
          value: 'dark_gray',
        },
      ],
      defaultValue: 'mint', // The first value in options.
      admin: {
        layout: 'horizontal',
      },
    },
  ],
}
```

## Custom Components

### Field

#### Server Component

```tsx
import type React from 'react'
import { RadioGroupField } from '@payloadcms/ui'
import type { RadioFieldServerProps } from 'payload'

export const CustomRadioFieldServer: React.FC<RadioFieldServerProps> = ({
  clientField,
  path,
  schemaPath,
  permissions,
}) => {
  return (
    <RadioGroupField
      field={clientField}
      path={path}
      schemaPath={schemaPath}
      permissions={permissions}
    />
  )
}
```

#### Client Component

```tsx
'use client'
import React from 'react'
import { RadioGroupField } from '@payloadcms/ui'
import type { RadioFieldClientProps } from 'payload'

export const CustomRadioFieldClient: React.FC<RadioFieldClientProps> = (
  props,
) => {
  return <RadioGroupField {...props} />
}
```

### Label

#### Server Component

```tsx
import React from 'react'
import { FieldLabel } from '@payloadcms/ui'
import type { RadioFieldLabelServerProps } from 'payload'

export const CustomRadioFieldLabelServer: React.FC<
  RadioFieldLabelServerProps
> = ({ clientField, path, required }) => {
  return (
    <FieldLabel
      label={clientField?.label || clientField?.name}
      path={path}
      required={clientField?.required}
    />
  )
}
```

#### Client Component

```tsx
'use client'
import React from 'react'
import { FieldLabel } from '@payloadcms/ui'
import type { RadioFieldLabelClientProps } from 'payload'

export const CustomRadioFieldLabelClient: React.FC<
  RadioFieldLabelClientProps
> = ({ field, path }) => {
  return (
    <FieldLabel
      label={field?.label || field?.name}
      path={path}
      required={field?.required}
    />
  )
}
```