obsidian/raw/_processed/fields__radio.md

title	label	order	desc	keywords	source
Radio Group Field	Radio Group	120	The Radio field type allows for the selection of one value from a predefined set of possible values. Learn how to use Radio fields, see examples and options.	radio, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs	https://payloadcms.com/docs/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.

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

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.
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.
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 details.
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.
interfaceName	Create a top level, reusable Typescript interface & GraphQL type.
typescriptSchema	Override field type generation with providing a JSON schema
virtual	Provide true to disable field in the database, or provide a string path to link the field with a relationship. See Virtual Fields

* 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, you can use the admin option:

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, 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

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

import type React from 'react'
import { RadioGroupField } from '@payloadcms/ui'
import type { RadioFieldServerComponent } from 'payload'

export const CustomRadioFieldServer: RadioFieldServerComponent = ({
  clientField,
  path,
  schemaPath,
  permissions,
}) => {
  return (
    <RadioGroupField
      field={clientField}
      path={path}
      schemaPath={schemaPath}
      permissions={permissions}
    />
  )
}

Client Component

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

export const CustomRadioFieldClient: RadioFieldClientComponent = (props) => {
  return <RadioGroupField {...props} />
}

Label

Server Component

import React from 'react'
import { FieldLabel } from '@payloadcms/ui'
import type { RadioFieldLabelServerComponent } from 'payload'

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

Client Component

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

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