Simplify your stack and build anything. Or everything.
Build tomorrow’s web with a modern solution you truly own.
Code-based nature means you can build on top of it to power anything.
It’s time to take back your content infrastructure.
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.
Admin Panel screenshot of a Radio field
To add a Radio Field, set the type to radio in your Field Config:
1
import type { Field } from 'payload/types'
2
3
export 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 |
* 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:
1
import type { Field } from 'payload/types'
2
3
export 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 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