导航菜单 | EmDash CMS Everything

EmDash 菜单是您通过管理界面管理的有序链接列表。菜单支持下拉列表的嵌套，可以链接到页面、文章、分类术语或外部 URL。

查询菜单

使用 getMenu() 通过唯一名称获取菜单：

---
import { getMenu } from "emdash";

const primaryMenu = await getMenu("primary");
---

{primaryMenu && (
  <nav>
    <ul>
      {primaryMenu.items.map(item => (
        <li>
          <a href={item.url}>{item.label}</a>
        </li>
      ))}
    </ul>
  </nav>
)}

如果不存在该名称的菜单，函数将返回 null。

菜单结构

菜单包含元数据和项目数组：

interface Menu {
	id: string;
	name: string; // 唯一标识符（"primary"、"footer"）
	label: string; // 显示名称（"Primary Navigation"）
	items: MenuItem[];
}

interface MenuItem {
	id: string;
	label: string;
	url: string; // 解析后的 URL
	target?: string; // 新窗口使用 "_blank"
	titleAttr?: string; // HTML title 属性
	cssClasses?: string; // 自定义 CSS 类
	children: MenuItem[]; // 用于下拉列表的嵌套项目
}

URL 根据项目类型自动解析：

页面/文章项目解析为 /{collection}/{slug}
分类项目解析为 /{taxonomy}/{slug}
集合项目解析为 /{collection}/
自定义链接按原样使用 URL

渲染嵌套菜单

菜单项可以具有用于下拉导航的子项。通过递归渲染 children 数组来处理嵌套：

---
import { getMenu } from "emdash";
import type { MenuItem } from "emdash";

interface Props {
  name: string;
}

const menu = await getMenu(Astro.props.name);
---

{menu && (
  <nav class="nav">
    <ul class="nav-list">
      {menu.items.map(item => (
        <li class:list={["nav-item", item.cssClasses]}>
          <a
            href={item.url}
            target={item.target}
            title={item.titleAttr}
            aria-current={Astro.url.pathname === item.url ? "page" : undefined}
          >
            {item.label}
          </a>
          {item.children.length > 0 && (
            <ul class="submenu">
              {item.children.map(child => (
                <li>
                  <a href={child.url} target={child.target}>
                    {child.label}
                  </a>
                </li>
              ))}
            </ul>
          )}
        </li>
      ))}
    </ul>
  </nav>
)}

菜单项类型

管理面板支持五种类型的菜单项：

类型	描述	URL 解析
`page`	链接到页面	`/{collection}/{slug}`
`post`	链接到文章	`/{collection}/{slug}`
`taxonomy`	链接到分类或标签	`/{taxonomy}/{slug}`
`collection`	链接到集合存档	`/{collection}/`
`custom`	外部或自定义 URL	按原样使用

列出所有菜单

使用 getMenus() 检索所有菜单定义（不含项目）：

import { getMenus } from "emdash";

const menus = await getMenus();
// 返回：[{ id, name, label, locale }, ...]

这主要用于管理界面或调试。

创建菜单

通过 /_emdash/admin/menus 的管理界面创建菜单，或使用管理 API：

POST /_emdash/api/menus
Content-Type: application/json

{
  "name": "footer",
  "label": "Footer Navigation"
}

向菜单添加项目：

POST /_emdash/api/menus/footer/items
Content-Type: application/json

{
  "type": "page",
  "referenceCollection": "pages",
  "referenceId": "page_privacy",
  "label": "Privacy Policy"
}

添加自定义外部链接：

POST /_emdash/api/menus/footer/items
Content-Type: application/json

{
  "type": "custom",
  "customUrl": "https://github.com/example",
  "label": "GitHub",
  "target": "_blank"
}

重新排序和嵌套

使用重新排序端点更新项目顺序和父子关系：

POST /_emdash/api/menus/primary/reorder
Content-Type: application/json

{
  "items": [
    { "id": "item_1", "parentId": null, "sortOrder": 0 },
    { "id": "item_2", "parentId": null, "sortOrder": 1 },
    { "id": "item_3", "parentId": "item_2", "sortOrder": 0 }
  ]
}

这使 item_3 成为 item_2 的子项，创建下拉列表。

完整示例

以下示例显示了带有主导航的响应式页眉：

---
import { getMenu, getSiteSettings } from "emdash";

const settings = await getSiteSettings();
const primaryMenu = await getMenu("primary");
---

<html lang="en">
  <head>
    <title>{settings.title}</title>
  </head>
  <body>
    <header class="header">
      <a href="/" class="logo">
        {settings.logo ? (
          <img src={settings.logo.url} alt={settings.logo.alt || settings.title} />
        ) : (
          settings.title
        )}
      </a>

      {primaryMenu && (
        <nav class="main-nav" aria-label="Main navigation">
          <ul>
            {primaryMenu.items.map(item => (
              <li class:list={[item.cssClasses, { "has-children": item.children.length > 0 }]}>
                <a
                  href={item.url}
                  target={item.target}
                  aria-current={Astro.url.pathname === item.url ? "page" : undefined}
                >
                  {item.label}
                </a>
                {item.children.length > 0 && (
                  <ul class="dropdown">
                    {item.children.map(child => (
                      <li>
                        <a href={child.url} target={child.target}>{child.label}</a>
                      </li>
                    ))}
                  </ul>
                )}
              </li>
            ))}
          </ul>
        </nav>
      )}
    </header>

    <main>
      <slot />
    </main>
  </body>
</html>

API 参考

`getMenu(name)`

通过名称获取包含所有项目和已解析 URL 的菜单。

参数：

name — 菜单的唯一标识符（字符串）

返回： Promise<Menu | null>

`getMenus()`

列出所有菜单定义（不含项目）。

返回： Promise<Array<{ id: string; name: string; label: string; locale: string }>>