Group Field

This is an advanced-use feature, and likely not something you'll need to configure. What you probably want is the content types reference!

The group field represents a group of values. This field is best used when there is a single group to be edited, typically with a single JSON object or nested frontmatter values. If there are multiple groups, checkout the group-list field.

Options

REQUIRED
component
'group'

The name of the plugin component. Always 'group'


REQUIRED
name
string

The path to some value in the data being edited.


REQUIRED
fields
Field[]

An array of Field values that will render as a sub-menu.


label
string

A human readable label for the field. Defaults to the name


description
string

Description that expands on the purpose of the field or prompts a specific action

All properties marked as REQUIRED must be specified for the field to work properly.

This interfaces only shows the keys unique to the group field. Visit the Field Config docs for a complete list of options.

Definition

If the source JSON for the example contact info looked like this:

Our form options would look like this: