Localess
Schemas

Link

Stores either an external URL or an internal content reference, with optional target.

Stores either an external URL or an internal content reference, with optional target.

Value shape

{
  "kind": "LINK",
  "type": "url",
  "target": "_blank",
  "uri": "https://example.com"
}
{
  "kind": "LINK",
  "type": "content",
  "target": "_blank",
  "uri": "019df317-9ad5-7228-a070-afc8f94a07d2"
}

type is "url" for external links and "content" for an internal link, whose uri is the target document's ID. Resolve a link to a final href with findLink(links, link), which looks the ID up in the links map of a response fetched with resolveLink: true. It's exported by every SDK — see the Node reference.

Options

OptionDescription
NameUnique field name in the Schema. Appears in the generated model and in the API response.
Display NameLabel shown to editors in the Content Editor.
RequiredWhen set, editors cannot save the document without a value.
TranslatableWhen set, the field stores a separate value per locale.
DescriptionHelp text shown to editors under the field.
Default ValueStored with the field definition. It is not currently pre-filled into new documents.

On this page