Link Field

Illustrated drawing of Amadeus Maxmimilian StadlerIllustrated drawing of Amadeus Maxmimilian Stadler

Amadeus Stadler

Last updated August 28, 2021

The Link field allows adding a link to an external or internal document.

Editing UI Widget

This field is displayed as a text input or a button depending on whether an internal or external link is to be added. Both are labelled with the field’s label in the Content Editor. If both internal and external links are allowed, the input will be preceded by a segmented selector allowing to switch between the two types.

Output Format

The Link field outputs the URL as a string.


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

  "type": "both",
  "byFilePath": false,
  "urlSuffix": "/",
  "urlTemplate": ""
  • type: what type of link is allowed. May be “both”, “internal” or “external”

  • byFilePath: use the path of the selected file without the extension for internal links instead of the template defined in the Collection or urlTemplate

  • urlSuffix: the value to append to the end of the URL if byFilePath is true

  • urlTemplate: the template to use for generating the URL of an internal link instead of the one defined in the Collection


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

  "required": false


You may want to use Link fields over regular Unformatted Text fields since they make adding links to internal documents much easier and also help with validating external URLs.

Version History

  • Version at launch: 1