@next-bricks/nav 1.16.1 → 1.17.0

package/dist/types.json

@@ -1,9 +1,4 @@
 {
-  "nav.easyops-navbar-alerts": {
-    "properties": [],
-    "events": [],
-    "methods": []
-  },
   "eo-app-bar-wrapper": {
     "properties": [
       {
@@ -233,6 +228,11 @@
     "events": [],
     "methods": []
   },
+  "nav.easyops-navbar-alerts": {
+    "properties": [],
+    "events": [],
+    "methods": []
+  },
   "eo-sidebar-sub-menu": {
     "properties": [
       {
@@ -564,18 +564,381 @@
     "events": [],
     "methods": []
   },
-  "eo-search-launchpad": {
-    "properties": [
+  "nav.get-menu-config-tree": {
+    "type": "provider",
+    "params": [
       {
-        "name": "readonly",
+        "name": "menuList",
         "annotation": {
-          "type": "keyword",
-          "value": "boolean"
+          "type": "array",
+          "elementType": {
+            "type": "reference",
+            "typeName": {
+              "type": "identifier",
+              "name": "MenuRawData"
+            }
+          }
         }
       }
     ],
-    "events": [],
-    "methods": []
+    "returns": {
+      "annotation": {
+        "type": "reference",
+        "typeName": {
+          "type": "identifier",
+          "name": "Promise"
+        },
+        "typeParameters": {
+          "type": "typeParameterInstantiation",
+          "params": [
+            {
+              "type": "array",
+              "elementType": {
+                "type": "reference",
+                "typeName": {
+                  "type": "identifier",
+                  "name": "TreeNode"
+                }
+              }
+            }
+          ]
+        }
+      }
+    },
+    "types": [
+      {
+        "type": "interface",
+        "name": "MenuRawData",
+        "body": [
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "menuId"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "string"
+            },
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "title"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "string"
+            },
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "icon"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "unknown"
+            },
+            "optional": true,
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "type"
+            },
+            "annotation": {
+              "type": "union",
+              "types": [
+                {
+                  "type": "jsLiteral",
+                  "value": "main"
+                },
+                {
+                  "type": "jsLiteral",
+                  "value": "inject"
+                }
+              ]
+            },
+            "optional": true,
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "injectMenuGroupId"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "string"
+            },
+            "optional": true,
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "dynamicItems"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "boolean"
+            },
+            "optional": true,
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "itemsResolve"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "unknown"
+            },
+            "optional": true,
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "items"
+            },
+            "annotation": {
+              "type": "array",
+              "elementType": {
+                "type": "reference",
+                "typeName": {
+                  "type": "identifier",
+                  "name": "MenuItemRawData"
+                }
+              }
+            },
+            "optional": true,
+            "computed": false
+          }
+        ]
+      },
+      {
+        "type": "interface",
+        "name": "MenuItemRawData",
+        "body": [
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "text"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "string"
+            },
+            "computed": false,
+            "description": "菜单项文本。"
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "icon"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "unknown"
+            },
+            "optional": true,
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "sort"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "number"
+            },
+            "optional": true,
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "groupId"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "string"
+            },
+            "optional": true,
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "hidden"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "boolean"
+            },
+            "optional": true,
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "children"
+            },
+            "annotation": {
+              "type": "array",
+              "elementType": {
+                "type": "reference",
+                "typeName": {
+                  "type": "identifier",
+                  "name": "MenuItemRawData"
+                }
+              }
+            },
+            "optional": true,
+            "computed": false
+          }
+        ]
+      },
+      {
+        "type": "interface",
+        "name": "TreeNode",
+        "body": [
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "key"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "string"
+            },
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "title"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "string"
+            },
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "icon"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "unknown"
+            },
+            "optional": true,
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "faded"
+            },
+            "annotation": {
+              "type": "keyword",
+              "value": "unknown"
+            },
+            "optional": true,
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "children"
+            },
+            "annotation": {
+              "type": "array",
+              "elementType": {
+                "type": "reference",
+                "typeName": {
+                  "type": "identifier",
+                  "name": "TreeNode"
+                }
+              }
+            },
+            "optional": true,
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "data"
+            },
+            "annotation": {
+              "type": "union",
+              "types": [
+                {
+                  "type": "reference",
+                  "typeName": {
+                    "type": "identifier",
+                    "name": "MenuRawData"
+                  }
+                },
+                {
+                  "type": "reference",
+                  "typeName": {
+                    "type": "identifier",
+                    "name": "MenuItemRawData"
+                  }
+                }
+              ]
+            },
+            "computed": false
+          },
+          {
+            "type": "propertySignature",
+            "key": {
+              "type": "identifier",
+              "name": "__keys"
+            },
+            "annotation": {
+              "type": "array",
+              "elementType": {
+                "type": "keyword",
+                "value": "string"
+              }
+            },
+            "optional": true,
+            "computed": false,
+            "description": "第一个节点额外返回 __keys，包含所有节点的 key"
+          }
+        ]
+      }
+    ]
   },
   "eo-launchpad-recent-visits": {
     "properties": [
@@ -593,6 +956,19 @@
     "events": [],
     "methods": []
   },
+  "eo-search-launchpad": {
+    "properties": [
+      {
+        "name": "readonly",
+        "annotation": {
+          "type": "keyword",
+          "value": "boolean"
+        }
+      }
+    ],
+    "events": [],
+    "methods": []
+  },
   "eo-sidebar-menu-submenu": {
     "properties": [
       {
@@ -992,29 +1368,6 @@
       }
     ]
   },
-  "eo-launchpad-quick-access": {
-    "properties": [
-      {
-        "name": "readonly",
-        "annotation": {
-          "type": "keyword",
-          "value": "boolean"
-        }
-      },
-      {
-        "name": "target",
-        "annotation": {
-          "type": "reference",
-          "typeName": {
-            "type": "identifier",
-            "name": "Target"
-          }
-        }
-      }
-    ],
-    "events": [],
-    "methods": []
-  },
   "eo-directory-tree": {
     "properties": [
       {
@@ -1448,6 +1801,13 @@
           "type": "keyword",
           "value": "string"
         }
+      },
+      {
+        "name": "customUrlTemplate",
+        "annotation": {
+          "type": "keyword",
+          "value": "string"
+        }
       }
     ],
     "events": [
@@ -2021,6 +2381,29 @@
     "events": [],
     "methods": []
   },
+  "eo-launchpad-quick-access": {
+    "properties": [
+      {
+        "name": "readonly",
+        "annotation": {
+          "type": "keyword",
+          "value": "boolean"
+        }
+      },
+      {
+        "name": "target",
+        "annotation": {
+          "type": "reference",
+          "typeName": {
+            "type": "identifier",
+            "name": "Target"
+          }
+        }
+      }
+    ],
+    "events": [],
+    "methods": []
+  },
   "eo-launchpad-button-v2": {
     "properties": [],
     "events": [],

package/dist-types/bootstrap.d.ts

@@ -20,3 +20,4 @@ import "./directory-tree/directory-tree-leaf/index.js";
 import "./directory-tree/directory-tree-internal-node/index.js";
 import "./nav-logo/index.js";
 import "./poll-announce/index.js";
+import "./data-providers/get-menu-config-tree.js";

package/dist-types/data-providers/get-menu-config-tree.d.ts

@@ -0,0 +1,40 @@
+/** 原始菜单数据。 */
+export interface MenuRawData {
+    menuId: string;
+    title: string;
+    icon?: unknown;
+    type?: "main" | "inject";
+    injectMenuGroupId?: string;
+    dynamicItems?: boolean;
+    itemsResolve?: unknown;
+    items?: MenuItemRawData[];
+}
+/** 原始菜单项数据。 */
+export type MenuItemRawData = {
+    /** 菜单项文本。 */
+    text: string;
+    icon?: unknown;
+    sort?: number;
+    groupId?: string;
+    hidden?: boolean;
+    children?: MenuItemRawData[];
+};
+export interface TitleDataSource {
+    objectId: string;
+    instanceId: string;
+    attributeId?: string;
+}
+export interface TreeNode {
+    key: string;
+    title: string;
+    icon?: unknown;
+    faded?: unknown;
+    children?: TreeNode[];
+    data: MenuRawData | MenuItemRawData;
+    /** 第一个节点额外返回 __keys，包含所有节点的 key */
+    __keys?: string[];
+}
+/**
+ * 构造用于菜单自定义的树形结构数据。
+ */
+export declare function getMenuConfigTree(menuList: MenuRawData[]): Promise<TreeNode[]>;

package/dist-types/data-providers/get-menu-config-tree.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist-types/launchpad-config/MenuGroup.d.ts

@@ -5,21 +5,24 @@ export interface MenuGroupProps {
     actions?: MenuAction[];
     variant?: "launchpad-config" | "menu-config";
     urlTemplate?: string;
+    customUrlTemplate?: string;
     onActionClick?: (detail: MenuActionEventDetail) => void;
 }
-export declare function MenuGroup({ data, actions, variant, urlTemplate, onActionClick, }: MenuGroupProps): React.JSX.Element;
+export declare function MenuGroup({ data, actions, variant, urlTemplate, customUrlTemplate, onActionClick, }: MenuGroupProps): React.JSX.Element;
 export interface MenuItemProps {
     data: ConfigMenuItemNormal;
     actions?: MenuAction[];
     variant?: "launchpad-config" | "menu-config";
     urlTemplate?: string;
+    customUrlTemplate?: string;
     onActionClick?: (detail: MenuActionEventDetail) => void;
 }
-export declare function MenuItem({ data, actions, variant, urlTemplate, onActionClick, }: MenuItemProps): React.JSX.Element;
+export declare function MenuItem({ data, actions, variant, urlTemplate, customUrlTemplate, onActionClick, }: MenuItemProps): React.JSX.Element;
 export interface MenuItemFolderProps {
     data: ConfigMenuItemDir;
     actions?: MenuAction[];
     variant?: "launchpad-config" | "menu-config";
     urlTemplate?: string;
+    customUrlTemplate?: string;
     onActionClick?: (detail: MenuActionEventDetail) => void;
 }

package/dist-types/launchpad-config/index.d.ts

@@ -18,11 +18,19 @@ export declare class LaunchpadConfig extends ReactNextElement implements Launchp
      */
     accessor variant: "launchpad-config" | "menu-config" | undefined;
     /**
-     * 菜单项链接模板，例如可配置为 `/app/{{ id }}`。
+     * 菜单项 APP 类型的链接模板，例如可配置为 `/app/{{ id }}`。
      *
      * 注：仅用于 variant: "menu-config"。
      */
     accessor urlTemplate: string | undefined;
+    /**
+     * 菜单项自定义类型的链接模板，例如可配置为 `/custom?url={{ __pathname }}`。
+     *
+     * 注：仅用于 variant: "menu-config"。
+     *    外链菜单链接会设置为禁用。
+     *    `__pathname` 是运行时变量，表示 url 解析后的 pathname。
+     */
+    accessor customUrlTemplate: string | undefined;
     render(): React.JSX.Element;
 }
 export interface LaunchpadConfigProps {
@@ -30,6 +38,7 @@ export interface LaunchpadConfigProps {
     actions?: MenuAction[];
     variant?: "launchpad-config" | "menu-config";
     urlTemplate?: string;
+    customUrlTemplate?: string;
     onActionClick?: (detail: MenuActionEventDetail) => void;
 }
-export declare function LaunchpadConfigComponent({ menuGroups, actions, variant, urlTemplate, onActionClick, }: LaunchpadConfigProps): React.JSX.Element;
+export declare function LaunchpadConfigComponent({ menuGroups, actions, variant, urlTemplate, customUrlTemplate, onActionClick, }: LaunchpadConfigProps): React.JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-bricks/nav",
-  "version": "1.16.1",
+  "version": "1.17.0",
   "homepage": "https://github.com/easyops-cn/next-bricks/tree/master/bricks/nav",
   "repository": {
     "type": "git",
@@ -43,5 +43,5 @@
     "@next-bricks/form": "*",
     "@next-bricks/icons": "*"
   },
-  "gitHead": "9f899805a630d67747061540862bb53d386168af"
+  "gitHead": "b15ad3ff681344213818a78def4c643a1ad8124f"
 }