app.offprint.publication Documentation (EN)

main record

No description available.

Record Key tid Timestamp-based ID

Properties

navigation array of ref #navItem Optional

Ordered top-level navigation items. Omitted when the publication uses the default navigation.

publication string at-uri Required

Required AT-URI to a `site.standard.publication` compatible record.

View raw schema

{
  "key": "tid",
  "record": {
    "properties": {
      "navigation": {
        "description": "Ordered top-level navigation items. Omitted when the publication uses the default navigation.",
        "items": {
          "ref": "#navItem",
          "type": "ref"
        },
        "type": "array"
      },
      "publication": {
        "description": "Required AT-URI to a `site.standard.publication` compatible record.",
        "format": "at-uri",
        "type": "string"
      }
    },
    "required": [
      "publication"
    ],
    "type": "object"
  },
  "type": "record"
}

navItem object

No description available.

Properties

children array of ref#navItem Optional

Nested items that render as a dropdown. Up to two levels deep.

external boolean Optional

Whether the link opens an external site.

href string Optional

Resolved destination: a root-relative path or an absolute URL. Omitted for a dropdown-only label.

label string Required

Display label for the navigation item.

maxGraphemes: 200 graphemes

View raw schema

{
  "properties": {
    "children": {
      "description": "Nested items that render as a dropdown. Up to two levels deep.",
      "items": {
        "ref": "#navItem",
        "type": "ref"
      },
      "type": "array"
    },
    "external": {
      "default": false,
      "description": "Whether the link opens an external site.",
      "type": "boolean"
    },
    "href": {
      "description": "Resolved destination: a root-relative path or an absolute URL. Omitted for a dropdown-only label.",
      "type": "string"
    },
    "label": {
      "description": "Display label for the navigation item.",
      "maxGraphemes": 200,
      "type": "string"
    }
  },
  "required": [
    "label"
  ],
  "type": "object"
}