导航菜单

除 getByNames(names) 自 Halo 2.27.0 起可用外，本页其他 API 自 Halo 2.0.0 起可用。

从 Halo 2.26.0 开始，菜单项通过 MenuItem.spec.menuName 归属菜单，并通过 MenuItem.spec.parent 记录父级。menuFinder 返回的 menu.menuItems 已按该关系组成树；请通过每个节点的 children 渲染子菜单，不要读取已弃用的 Menu.spec.menuItems 或 MenuItem.spec.children。

getByName(name)

menuFinder.getByName(name);

描述

根据 metadata.name 获取菜单。

参数

name:string - 菜单的唯一标识 metadata.name。

返回值

#MenuVo

示例

<div th:with="menu = ${menuFinder.getByName('menu-foo')}">
  <ul th:with="menuItems = ${menu.menuItems}">
    <li th:each="menuItem : ${menuItems}">
      <a
        th:href="@{${menuItem.status.href}}"
        th:text="${menuItem.status.displayName}"
        th:target="${menuItem.spec.target?.value}"
      >
      </a>
    </li>
  </ul>
</div>

getByNames(names)

自 Halo 2.27.0 起可用。

menuFinder.getByNames(names);

描述

根据一组 metadata.name 批量获取菜单及其菜单项树，适用于需要同时展示多个菜单的场景。

按传入集合的迭代顺序返回菜单，重复标识只保留第一次出现的位置。
不存在的菜单会被跳过，不会因此报错。
传入空集合或 null 时返回空列表。
每个菜单的 menuItems 包含根菜单项，子菜单通过节点的 children 获取。

参数

names:Collection<string> - 菜单的唯一标识 metadata.name 的集合。

返回值

List<#MenuVo>

示例

以下示例按顺序获取两个菜单，并复用下方 getPrimary() 示例中的 /templates/modules/menu-tree.html 片段渲染完整菜单树。请将示例标识替换为实际菜单的 metadata.name。

<div th:with="menus = ${menuFinder.getByNames({'menu-foo', 'menu-bar'})}">
  <nav th:each="menu : ${menus}">
    <h2 th:text="${menu.spec.displayName}"></h2>
    <th:block
      th:replace="~{modules/menu-tree :: tree(menuItems=${menu.menuItems})}"
    ></th:block>
  </nav>
</div>

getPrimary()

menuFinder.getPrimary();

描述

获取主菜单。

参数

无

返回值

#MenuVo

示例

<nav th:with="menu = ${menuFinder.getPrimary()}">
  <th:block
    th:replace="~{modules/menu-tree :: tree(menuItems=${menu.menuItems})}"
  ></th:block>
</nav>

/templates/modules/menu-tree.html

<ul th:fragment="tree (menuItems)">
  <li th:each="menuItem : ${menuItems}">
    <a
      th:href="@{${menuItem.status.href}}"
      th:text="${menuItem.status.displayName}"
      th:target="${menuItem.spec.target?.value}"
    ></a>
    <th:block th:if="${not #lists.isEmpty(menuItem.children)}">
      <th:block
        th:replace="~{modules/menu-tree :: tree(menuItems=${menuItem.children})}"
      ></th:block>
    </th:block>
  </li>
</ul>

类型定义

MenuVo

{
  "metadata": {
    "name": "string", // 唯一标识
    "labels": {
      "additionalProp1": "string",
    },
    "annotations": {
      "additionalProp1": "string",
    },
    "creationTimestamp": "2022-11-20T14:44:58.984Z", // 创建时间
  },
  "spec": {
    "displayName": "string", // 显示名称
    "menuItems": [
      // 自 Halo 2.26.0 起已弃用，请使用 MenuItem.spec.menuName 和 MenuItem.spec.parent
      "string",
    ],
  },
  "menuItems": "List<#MenuItemVo>", // menuFinder 根据当前层级关系构建的根菜单项集合
}

MenuItemVo

{
  "metadata": {
    "name": "string", // 唯一标识
    "labels": {
      "additionalProp1": "string",
    },
    "annotations": {
      "additionalProp1": "string",
    },
    "creationTimestamp": "2022-11-20T14:44:58.984Z", // 创建时间
  },
  "spec": {
    "displayName": "string", // 显示名称，但是不要直接使用这个字段进行显示，最终字段为 status.displayName
    "href": "string", // 链接，同样不要直接使用这个字段，最终字段为 status.href
    "priority": 0, // 排序字段
    "menuName": "string", // 所属菜单的 metadata.name，自 Halo 2.26.0 起作为菜单归属依据
    "parent": "string", // 父菜单项的 metadata.name，根菜单项为空
    "children": [
      // 自 Halo 2.26.0 起已弃用，请使用 spec.parent 表示层级
      "string",
    ],
    "target": "#Target", // 菜单页面打开方式，枚举类型
    "targetRef": {
      // 与其他资源比如文章的关联，一般无需直接使用
      "group": "string",
      "version": "string",
      "kind": "string",
      "name": "string",
    },
  },
  "status": {
    "displayName": "string", // 显示名称
    "href": "string", // 链接
  },
  "children": "List<#MenuItemVo>", // menuFinder 根据 spec.parent 构建的直接子菜单项
  "parentName": "string", // spec.parent 的值
}

Target

enum Target {
    BLANK("_blank"),                                     // 在新窗口打开
    SELF("_self"),                                       // 在当前窗口打开
    PARENT("_parent"),                                   // 在父窗口打开
    TOP("_top");                                         // 在顶级窗口打开
}

导航菜单#

#getByName(name)

#描述

#参数

#返回值

#示例

#getByNames(names)

#描述

#参数

#返回值

#示例

#getPrimary()

#描述

#参数

#返回值

#示例

#类型定义

#MenuVo

#MenuItemVo

导航菜单

getByName(name)

描述

参数

返回值

示例

getByNames(names)

描述

参数

返回值

示例

getPrimary()

描述

参数

返回值

示例

类型定义

MenuVo

MenuItemVo