Checkbox Field

Checkbox field with text field in Payload Admin Panel
Admin Panel screenshot of Checkbox field with Text field below

Config

OptionDescription
name *To be used as the property name when stored and retrieved from the database. More
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, will default to false if field is also required. 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 the default field admin config for more details.
customExtension point for adding custom data (e.g. for plugins)
typescriptSchemaOverride field type generation with providing a JSON schema

* An asterisk denotes that a property is required.

Example

collections/ExampleCollection.ts

1
import { CollectionConfig } from 'payload'
2
3
export const ExampleCollection: CollectionConfig = {
4
slug: 'example-collection',
5
fields: [
6
{
7
name: 'enableCoolStuff', // required
8
type: 'checkbox', // required
9
label: 'Click me to see fanciness',
10
defaultValue: false,
11
},
12
],
13
}
Next

Code Field