Radio Group Field

Shows a Radio field in the Payload Admin Panel
Admin Panel screenshot of a Radio field

Config

OptionDescription
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.
labelText used as a field label in the Admin Panel or an object with keys for each language.
validateProvide a custom validation function that will be executed on both the Admin Panel and the backend. More
indexBuild 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.
saveToJWTIf this field is top-level and nested in a config supporting Authentication, include its data in the user JWT.
hooksProvide Field Hooks to control logic for this field. More details.
accessProvide Field Access Control to denote what users can see and do with this field's data. More details.
hiddenRestrict 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.
defaultValueProvide data to be used for this field's default value. The default value must exist within provided values in options. More
localizedEnable localization for this field. Requires localization to be enabled in the Base config.
requiredRequire this field to have a value.
adminAdmin-specific configuration. See below for more detail.
customExtension point for adding custom data (e.g. for plugins)
enumNameCustom enum name for this field when using SQL Database Adapter (Postgres). Auto-generated from name if not defined.
typescriptSchemaOverride field type generation with providing a JSON schema

* An asterisk denotes that a property is required.

Admin config

In addition to the default field admin config, the Radio Group field type allows for the specification of the following admin properties:

layout

The layout property allows for the radio group to be styled as a horizonally or vertically distributed list. The default value is horizontal.

Example

collections/ExampleCollection.ts

1
import { CollectionConfig } from 'payload'
2
3
export const ExampleCollection: CollectionConfig = {
4
slug: 'example-collection',
5
fields: [
6
{
7
name: 'color', // required
8
type: 'radio', // required
9
options: [
10
// required
11
{
12
label: 'Mint',
13
value: 'mint',
14
},
15
{
16
label: 'Dark Gray',
17
value: 'dark_gray',
18
},
19
],
20
defaultValue: 'mint', // The first value in options.
21
admin: {
22
layout: 'horizontal',
23
},
24
},
25
],
26
}
Next

Relationship Field