0574155e59
### What? I noticed a spelling error in the banner of the beta docs and decided I could save everyone some time by *running the entirety of the beta docs* through a spellchecker. ### Why? To fix many spelling and formatting mistakes at once. ### How? By enabling `edit mode` in my browser and letting the built-in spellchecker perform its magic (and changing _only_ where it made sense). ~~Ironically, the original spelling mistake that inspired me to do this remains unchanged as that is a part of the website repo. [PR for that is here](https://github.com/payloadcms/website/pull/388).~~
120 lines
6.8 KiB
Plaintext
120 lines
6.8 KiB
Plaintext
---
|
|
title: Radio Group Field
|
|
label: Radio Group
|
|
order: 120
|
|
desc: 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.
|
|
keywords: radio, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
|
|
---
|
|
|
|
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/overview).
|
|
|
|
<LightDarkImage
|
|
srcLight="https://payloadcms.com/images/docs/fields/radio.png"
|
|
srcDark="https://payloadcms.com/images/docs/fields/radio-dark.png"
|
|
alt="Shows a Radio field in the Payload Admin Panel"
|
|
caption="Admin Panel screenshot of a Radio field"
|
|
/>
|
|
|
|
To add a Radio Field, set the `type` to `radio` in your [Field Config](./overview):
|
|
|
|
```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](/docs/fields/overview#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 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](/docs/fields/overview#validation) |
|
|
| **`index`** | Build an [index](/docs/database/overview) 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/authentication/overview), include its data in the user JWT. |
|
|
| **`hooks`** | Provide Field Hooks to control logic for this field. [More details](../hooks/fields). |
|
|
| **`access`** | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields). |
|
|
| **`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](/docs/fields/overview#default-values) |
|
|
| **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) 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/database/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](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) |
|
|
|
|
_\* An asterisk denotes that a property is required._
|
|
|
|
<Banner type="warning">
|
|
<strong>Important:</strong>
|
|
<br />
|
|
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.
|
|
</Banner>
|
|
|
|
## Admin Options
|
|
|
|
The customize the appearance and behavior of the Radio Field in the [Admin Panel](../admin/overview), 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 options from the base [Field Admin Config](../admin/fields#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
|
|
|
|
`collections/ExampleCollection.ts`
|
|
|
|
```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',
|
|
},
|
|
},
|
|
],
|
|
}
|
|
```
|