Radio Group Field

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.

Shows a Radio field in the Payload Admin Panel

Admin Panel screenshot of a Radio field

To add a Radio Field, set the type to radio in your Field Config:

1import type { Field } from 'payload'
2
3export const MyRadioField: Field = {
4  // ...
5  type: 'radio',
6  options: [
7    // ...
8  ]
9}

Config Options

Option	Description
`name` *	To be used as the property name when stored and retrieved from the database. More
`options` *	Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing an `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
`index`	Build an index 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, include its data in the user JWT.
`hooks`	Provide Field Hooks to control logic for this field. More details.
`access`	Provide Field Access Control to denote what users can see and do with this field's data. More details.
`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
`localized`	Enable localization for this field. Requires localization to be enabled in the Base config.
`required`	Require this field to have a value.
`admin`	Admin-specific configuration. More details.
`custom`	Extension point for adding custom data (e.g. for plugins)
`enumName`	Custom enum name for this field when using SQL Database Adapter (Postgres). Auto-generated from name if not defined.
`typescriptSchema`	Override field type generation with providing a JSON schema
`virtual`	Provide `true` to disable field in the database. See Virtual Fields

* An asterisk denotes that a property is required.

Admin Options

The customize the appearance and behavior of the Radio Field in the Admin Panel, you can use the admin option:

1import type { Field } from 'payload'
2
3export const MyRadioField: Field = {
4  // ...
5  admin: { 
6    // ...
7  },
8}

The Radio Field inherits all of the default options from the base Field Admin Config, 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

collections/ExampleCollection.ts

1import type { CollectionConfig } from 'payload'
2
3export 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',
    },
  },
],
26}

Custom Components

Field

Server Component

1import type React from 'react'
2import { RadioGroupField } from '@payloadcms/ui'
3import type { RadioFieldServerComponent } from 'payload'
4
5export const CustomRadioFieldServer: RadioFieldServerComponent = ({
6  clientField,
7  path,
8  schemaPath,
9  permissions,
10}) => {
11  return (
12    <RadioGroupField
13      field={clientField}
14      path={path}
15      schemaPath={schemaPath}
16      permissions={permissions}
17    />
18  )
19}

Client Component

1'use client'
2import React from 'react'
3import { RadioGroupField } from '@payloadcms/ui'
4import type { RadioFieldClientComponent } from 'payload'
5
6export const CustomRadioFieldClient: RadioFieldClientComponent = (props) => {
7  return <RadioGroupField {...props} />
8}

Label

Server Component

1import React from 'react'
2import { FieldLabel } from '@payloadcms/ui'
3import type { RadioFieldLabelServerComponent } from 'payload'
4
5export const CustomRadioFieldLabelServer: RadioFieldLabelServerComponent = ({
6  clientField,
7  path,
8  required,
9}) => {
10  return (
11    <FieldLabel
12      label={clientField?.label || clientField?.name}
13      path={path}
14      required={clientField?.required}
15    />
16  )
17}

Client Component

1'use client'
2import React from 'react'
3import { FieldLabel } from '@payloadcms/ui'
4import type { RadioFieldLabelClientComponent } from 'payload'
5
6export const CustomRadioFieldLabelClient: RadioFieldLabelClientComponent = ({
7  field,
8  path,
9}) => {
10  return (
11    <FieldLabel
12      label={field?.label || field?.name}
13      path={path}
14      required={field?.required}
15    />
16  )
17}

See what others are building with Payload.

"Payload has transformed the way our clients manage content. It's an indispensable tool for any modern agency."

Deploy your entire stack in one place with Payload Cloud.

Microsoft chose Payload to tell the world about AI.

Radio Group Field

Config Options

Admin Options

Example

Custom Components

Field

Server Component

Client Component

Label

Server Component

Client Component

Relationship Field