Checkbox Field

The Checkbox Field saves a boolean in the database.

Admin Panel screenshot of Checkbox field with Text field below

To add a Checkbox Field, set the type to checkbox in your Field Config:

1import type { Field } from 'payload'
2
3export const MyCheckboxField: Field = {
4  // ...
5  type: 'checkbox', 
6}

Config Options

Option	Description
`name` *	To be used as the property name when stored and retrieved from the database. More
`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, will default to false if field is also `required`. 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)
`typescriptSchema`	Override field type generation with providing a JSON schema
`virtual`	Provide `true` to disable field in the database. See Virtual Fields

* An asterisk denotes that a property is required.

Example

Here is an example of a Checkbox Field in a Collection:

1import type { CollectionConfig } from 'payload'
2
3export 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}

See what others are building with Payload.

"Payload has transformed the way our clients manage content. It's an indispensable tool for any modern agency."

Deploy your entire stack in one place with Payload Cloud.

Microsoft chose Payload to tell the world about AI.

Checkbox Field

Config Options

Example

JSON Field