Group Field

The Group Field allows Fields to be nested under a common property name. It also groups fields together visually in the Admin Panel.

Admin Panel screenshot of a Group field

To add a Group Field, set the type to group in your Field Config:

1import type { Field } from 'payload'
2
3export const MyGroupField: Field = {
4  // ...
5  type: 'group',
6  fields: [
7    // ...
8  ],
9}

Config Options

Option	Description
`name` *	To be used as the property name when stored and retrieved from the database. More
`fields` *	Array of field types to nest within this Group.
`label`	Used as a heading in the Admin Panel and to name the generated GraphQL type.
`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 an object of 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. If enabled, a separate, localized set of all data within this Group will be kept, so there is no need to specify each nested field as `localized`.
`admin`	Admin-specific configuration. More details.
`custom`	Extension point for adding custom data (e.g. for plugins)
`interfaceName`	Create a top level, reusable Typescript interface & GraphQL type.
`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 Group Field in the Admin Panel, you can use the admin option:

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

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

Option	Description
`hideGutter`	Set this property to `true` to hide this field's gutter within the Admin Panel. The field gutter is rendered as a vertical line and padding, but often if this field is nested within a Group, Block, or Array, you may want to hide the gutter.

Example

collections/ExampleCollection.ts

1import type { CollectionConfig } from 'payload'
2
3export const ExampleCollection: CollectionConfig = {
slug: 'example-collection',
fields: [
  {
    name: 'pageMeta', // required
    type: 'group', // required
    interfaceName: 'Meta', // optional
    fields: [
      // required
      {
        name: 'title',
        type: 'text',
        required: true,
        minLength: 20,
        maxLength: 100,
      },
      {
        name: 'description',
        type: 'textarea',
        required: true,
        minLength: 40,
        maxLength: 160,
      },
    ],
  },
],
29}

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.

Group Field

Config Options

Admin Options

Example

Number Field