Skip to main content

Workspace page

The workspacePage will add a menu entry in the workspace menu.

proxima_workspace_page

Manifest example

modules:
workspacePage:
- key: workspace-key
resource: main
title: Workspace Title
loadType: Micro
route: /workspace
- key: board-key
title: Workspace Board
type: board
parent: group-key
- key: group-key
title: Workspace Group
type: group
resources:
- key: main
path: ./dist/

Properties

nametyperequireddescription
keyStringYesA key for the module, which other modules can refer to. Must be unique within the manifest.
Regex: ^[a-zA-Z0-9_-]+$
resourceStringNoA reference to the static resources entry that your workspace page wants to display. See resources for more details.
titleStringYesThe title of the workspace page, which is displayed at the left navigation of workspace menu.
loadTypeMicroNoThe app's rendering method
routeStringfalseThe app route, default /
typeStringNoPanel type, board: panel, group: panel group
parentstringNoThe key of the parent, pointing to the key of the panel group
iqlstringNoiql
filterSourcestringNoinWorkspace: panels within the workspace, iql: cross-workspace panels