Custom Pages in Advanced Menu

hidden

Populate the advanced menu with custom content.

ID	custom-pages
Version	1.0.0
Author	Jirka Horák
Categories	Content
Source	plugins/custom-pages

Keywords: pages · menu · content

Dependencies

• Page builder for Advanced Menu

Additional configuration keys

sanitizeConfig, target, tests

See include.json for details and defaults.

Documentation

Advanced Menu Pages

See the API of menu-pages module, this plugin only forwards its configuration to the module. Supports data property - the configuration sent to the module. It can be either an array of configurations or a single configuration (also an array).

Trust boundary

data can arrive from two places, and they are not equally trusted:

provenance	read from	policy applied
operator	include.json / ENV.plugins["custom-pages"].data	whatever sanitizeConfig says
session	POST_DATA, URL params, an imported peer session	the menu-pages default allowlist, always

sanitizeConfig and target are read via getStaticMeta only — deployment config, never the session (AGENTS.md §7). They used to be read via getOption, which let the same bundle that supplied the pages also decide how safely they were rendered.

The param accepts true, false or a sanitize-html config object; see the menu-pages module docs. Note false means "the module default allowlist", not "raw" — there is no raw mode, because a page config is not necessarily something the operator wrote.

Placement target

Pages can be mounted in two places. Set the plugin-level default via the target param (include.json or ENV.plugins["custom-pages"].target):

target	Where the pages appear
plugins	Fullscreen Plugins menu (default), under this plugin's entry.
viewer	Global per-viewer right-side menu (toggled by params.ui.globalMenu).
both	Both of the above.

Any individual page may override the default by setting its own target property:

{
  "target": "plugins",
  "data": [
    { "title": "Always in Plugins menu", "page": [ /* ... */ ] },
    { "title": "Also in the viewer dock", "target": "both", "page": [ /* ... */ ] },
    { "title": "Only in the viewer dock",  "target": "viewer", "page": [ /* ... */ ] }
  ]
}

Note: the legacy main page property is no longer used — pages render as sibling submenus under one entry. See the menu-pages module docs.

Example configurations (contents of data property):

[
  {
    "title": "My Main Page",
    "subtitle": "Contents 1",
    "page": [
      {
        "type": "header",
        "classes": "f1-light",
        "title": "Header 1"
      }, {
        "type": "text",
        "content": "This page is generated from the custom pages module."
      }, {
        "type": "columns",
        "children": [
          {
            "type": "text",
            "content": "Text in the first column. Cool, huh?"
          },
          {
            "type": "text",
            "content": "Text in the second column. Also pretty cool."
          }
        ]
      }
    ]
  },
  {
    "title": "Contents 2",
    "page": [
      {
        "type": "header",
        "classes": "f1-light",
        "title": "Header 2"
      }, {
        "type": "text",
        "content": "This page is hidden within 'My Main Page'."
      }
    ]
  },
  {
    "title": "Another Main Page",
    "main": true,
    "page": [
      {
        "type": "header",
        "classes": "f1-light",
        "title": "Vega"
      }, {
        "type": "text",
        "content": "This is page on the same level as the first page. Moreover, it contains a graph!"
      }, {
        "type": "vega",
        "vega": {
          ...
        }
      }
    ]
  }
]