Simplify your stack and build anything. Or everything.
Schedule a Demo
USE CASES
Headless CMSEnterprise App BuilderHeadless E-CommerceDigital Asset Management
FEATURES
Multi-TenancyWhite LabelLocalizationAccess ControlAuth
CASE STUDIES

See what others are building with Payload.

Browse Case Studies
Build tomorrow’s web with a modern solution you truly own.
PAYLOAD IS FOR
DevelopersMarketing teamsEnterprise companiesAgencies & Consultancies
COMPARE PAYLOAD
Payload vs WordPressPayload vs ContentfulPayload vs SanityPayload vs StrapiPayload vs Directus
AGENCY TESTIMONIAL

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

Become a PartnerFind a Partner
Code-based nature means you can build on top of it to power anything.
Resources
DocumentationExamplesTemplatesGitHubReleasesBlog
Community
RoadmapDiscordCommunity Help
Payload Cloud

Deploy your entire stack in one place with Payload Cloud.

LoginCloud Pricing
It’s time to take back your content infrastructure.
Schedule a Demo
Enterprise Features
SSOAI Auto-EmbeddingPublishing WorkflowsVisual EditorStatic A/B testingAI features
Customer Stories
MicrosoftASICSBlue OriginHello BelloTekton
Featured Customer Story

Microsoft chose Payload to tell the world about AI.

Read the case studyBrowse all
LoginGet Started

Code Field

The Code Field saves a string in the database, but provides the Admin Panel with a code editor styled interface.

Shows a Code field in the Payload Admin Panel
This field is using the `monaco-react` editor syntax highlighting.

To add a Code Field, set the type to code in your Field Config:

1
import type { Field } from 'payload'
2
3
export const MyBlocksField: Field = {
4
// ...
5
type: 'code',
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.

unique

Enforce that each entry in the Collection has a unique value for this field.

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.

minLength

Used by the default validation function to ensure values are of a minimum character length.

maxLength

Used by the default validation function to ensure values are of a maximum character length.

validate

Provide a custom validation function that will be executed on both the Admin Panel and the backend. More

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. 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. See below for more detail.

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.

Admin Options

The customize the appearance and behavior of the Code Field in the Admin Panel, you can use the admin option:

1
import type { Field } from 'payload'
2
3
export const MyCodeField: Field = {
4
// ...
5
admin: {
6
// ...
7
},
8
}

The Code Field inherits all of the default options from the base Field Admin Config, plus the following additional options:

Option

Description

language

This property can be set to any language listed here.

editorOptions

Options that can be passed to the monaco editor, view the full list.

Example

`collections/ExampleCollection.ts

1
import type { CollectionConfig } from 'payload'
2
3
export const ExampleCollection: CollectionConfig = {
4
slug: 'example-collection',
5
fields: [
6
{
7
name: 'trackingCode', // required
8
type: 'code', // required
9
required: true,
10
admin: {
11
language: 'javascript',
12
},
13
},
14
],
15
}

Custom Components

Field

Server Component

1
import type React from 'react'
2
import { CodeField } from '@payloadcms/ui'
3
import type { CodeFieldServerComponent } from 'payload'
4
5
export const CustomCodeFieldServer: CodeFieldServerComponent = ({
6
clientField,
7
path,
8
schemaPath,
9
permissions,
10
}) => {
11
return (
12
<CodeField field={clientField} path={path} schemaPath={schemaPath} permissions={permissions} />
13
)
14
}

Client Component

1
'use client'
2
import React from 'react'
3
import { CodeField } from '@payloadcms/ui'
4
import type { CodeFieldClientComponent } from 'payload'
5
6
export const CustomCodeFieldClient: CodeFieldClientComponent = (props) => {
7
return <CodeField {...props} />
8
}

Label

Server Component

1
import React from 'react'
2
import { FieldLabel } from '@payloadcms/ui'
3
import type { CodeFieldLabelServerComponent } from 'payload'
4
5
export const CustomCodeFieldLabelServer: CodeFieldLabelServerComponent = ({
6
clientField,
7
path,
8
}) => {
9
return (
10
<FieldLabel
11
label={clientField?.label || clientField?.name}
12
path={path}
13
required={clientField?.required}
14
/>
15
)
16
}

Client Component

1
'use client'
2
import React from 'react'
3
import { FieldLabel } from '@payloadcms/ui'
4
import type { CodeFieldLabelClientComponent } from 'payload'
5
6
export const CustomCodeFieldLabelClient: CodeFieldLabelClientComponent = ({
7
field,
8
path,
9
}) => {
10
return (
11
<FieldLabel
12
label={field?.label || field?.name}
13
path={path}
14
required={field?.required}
15
/>
16
)
17
}
Next

Collapsible Field