Menu Items

Where it lives

JSON Pointer: /menus JSONPath: $.menus Parent: Root of the metadata file

Overview

Menu metadata defines the admin navigation structure generated by SolidX.

Each menu record binds a user-facing label to an action, assigns ordering, and optionally places the item under a parent menu or behind role-based access rules.

For admin-side authoring workflows, refer to the Menu System Overview.

Menu schema example

{
  ..., // Other metadata  
  "menus": [ // Array of menu item metadata
    {
      "displayName": "Home",
      "name": "fees-portal-home-menu",
      "sequenceNumber": 1,
      "actionUserKey": "fees-portal-home-action",
      "moduleUserKey": "fees-portal",
      "parentMenuItemUserKey": "",
      "roles": [],
      "iconName": "home"
    },
    {
      "displayName": "Institute",
      "name": "institute-menu-item",
      "sequenceNumber": 2,
      "actionUserKey": "institute-list-view",
      "moduleUserKey": "fees-portal",
      "parentMenuItemUserKey": "",
      "roles": [
        "Institute Admin",
        "App Admin"
      ],
      "iconName": "school"
    },
    {
      "displayName": "Initiate Payments",
      "name": "paymentCollection-menu-item",
      "sequenceNumber": 3,
      "actionUserKey": "paymentCollection-list-view",
      "moduleUserKey": "fees-portal",
      "parentMenuItemUserKey": "",
      "roles": [
        "Institute Admin",
        "App Admin"
      ],
      "iconName": "payments"
    },
    {
      "displayName": "Created Payments",
      "name": "paymentCollectionItem-menu-item",
      "sequenceNumber": 1,
      "actionUserKey": "paymentCollectionItem-list-view",
      "moduleUserKey": "fees-portal",
      "parentMenuItemUserKey": "paymentCollection-menu-item",
      "roles": [
        "Institute Admin",
        "App Admin"
      ],
      "iconName": "receipt"
    },
  ],
}

`name` (string, required, unique)

Name of the menu item (column/property).
Default: N/A

`displayName` (string, required)

Display name of the menu item (shown in the UI).
Default: N/A

`moduleUserKey` (string, required)

User key of the module this menu item belongs to.
Default: N/A

`parentMenuItemUserKey` (string, optional)

User key of the parent menu item (for nested menus).
If empty or not provided, the menu item is a top-level item.
Default: "" (empty string)

`actionUserKey` (string, optional)

User key of the action this menu item links to.
If empty or not provided, the menu item will not link to any action.
Default: "" (empty string)

`roles` (array of Role Metadata, optional)

Array of roles that can access this menu item.
If empty or not provided, the menu item is accessible only to the Admin role.
Refer to Role Metadata for details.

`sequenceNumber` (number, optional)

Sequence number for ordering menu items.
Lower numbers appear first. If empty or not provided, menu items are shown in the order in which they are inserted. Default: N/A

`iconName` (string, optional)

Name of the icon to display alongside the menu item. Refer to the Material Icons for available icons.
Default: N/A