Content Reference Field

Illustrated drawing of Amadeus Maxmimilian StadlerIllustrated drawing of Amadeus Maxmimilian Stadler

Amadeus Stadler

Last updated August 31, 2021

The Content Reference field allows referencing a value from another content item. This can be used to link content items together, or for referencing other types of content by their ID.

Editing UI Widget

This field is displayed as a button labelled with the field’s label in the Content Editor. Clicking the button will allow selecting another content item and cause the specified value to appear in the button.

Output Format

The Content Reference field outputs the referenced value in its original type.

Options

The following options are available for this field (default values shown):

{
  "collections": [],
  "field": "",
  "removable": false
}
  • collections: an array of Collections to limit the selection of content items to. By default, the selection is limited to all Collections that are marked as linkable, if you would like to reference content from an unlinkable Collection, add it here

  • field: the key-path of the field to reference, e.g. id or group.other-key

  • removable: whether or not the referenced value may be removed after having been picked, resetting the value of the field back to null

Validation

The following validation options are available for this field (default values shown):

{
  "required": false
}

Notes

Since the field only stores the value of the field in the selected content item at the moment it is picked, you may have to pick that content item again if it changes. For the same reason the value displayed may be a bit cryptic to users, for example if it’s a UUID.

If you simply want to link to another content item, you may be looking for the Link field instead.

Version History

  • Version at launch: 2