Code Field

Shows a Code field in the Payload admin panel
Admin panel screenshot of a Code field

This field uses the monaco-react editor syntax highlighting.

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.
uniqueEnforce that each entry in the Collection has a unique value for this field.
indexBuild a MongoDB 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.
minLengthUsed by the default validation function to ensure values are of a minimum character length.
maxLengthUsed by the default validation function to ensure values are of a maximum character length.
validateProvide a custom validation function that will be executed on both the Admin panel and the backend. More
saveToJWTIf this field is top-level and nested in a config supporting Authentication, include its data in the user JWT.
hooksProvide field-based hooks to control logic for this field. More
accessProvide field-based access control to denote what users can see and do with this field's data. More
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. 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)

* An asterisk denotes that a property is required.

Admin Config

In addition to the default field admin config, you can adjust the following properties:

OptionDescription
languageThis property can be set to any language listed here.
editorOptionsOptions that can be passed to the monaco editor, view the full list.

Example

`collections/ExampleCollection.ts

import { CollectionConfig } from 'payload/types';
export const ExampleCollection: CollectionConfig = {
slug: 'example-collection',
fields: [
{
name: 'trackingCode', // required
type: 'code', // required
required: true,
admin: {
language: 'javascript'
}
}
]
};
Next

JSON Field