Menu

File

导入

import {
  Menu,
  MenuTrigger,
  MenuPopover,
  MenuList,
  MenuItem,
  MenuLabel,
  MenuDivider,
} from "@pelagornis/page/components";

示例

上方预览渲染的就是这个文件。把它复制到 src/components/ 即可开始使用。

src/components/MenuExample.tsx

import {
  Button,
  Menu,
  MenuDivider,
  MenuItem,
  MenuLabel,
  MenuList,
  MenuPopover,
  MenuTrigger,
} from "@pelagornis/page/components";

export default function MenuDemo() {
  return (
    <Menu>
      <MenuTrigger>
        <Button variant="outline">File</Button>
      </MenuTrigger>
      <MenuPopover>
        <MenuList>
          <MenuLabel>File</MenuLabel>
          <MenuItem shortcut="⌘N">New file</MenuItem>
          <MenuItem shortcut="⌘O" description="Open from disk">
            Open
          </MenuItem>
          <MenuDivider />
          <MenuItem state="disabled">Save</MenuItem>
        </MenuList>
      </MenuPopover>
    </Menu>
  );
}

在 MDX 中使用

Menu 由共享 React 状态的多个部件组成。写在 MDX 中的子元素会各自渲染成独立的岛，部件之间无法互通。请像上面的示例一样在 .tsx 文件中组合，再导入该文件。

src/content/docs/example.mdx

---
title: Example
---

import MenuExample from "../../components/MenuExample";

<MenuExample client:load />

client:load 会在页面加载时水合该岛。位于页面靠下位置的内容请使用 client:visible。

在 Markdoc 中使用

Markdoc 标签渲染的是 Astro 组件，而这个组件需要客户端状态。请把示例包进一个负责水合的 .astro 文件，再把该文件注册为标签。

src/components/markdoc/MenuExample.astro

---
import MenuExample from "../MenuExample";
---

<MenuExample client:load />

markdoc.config.mjs

import { component, defineMarkdocConfig } from "@astrojs/markdoc/config";
import starlightMarkdoc from "@astrojs/starlight-markdoc";
import pageMarkdoc from "@pelagornis/page/markdoc";

export default defineMarkdocConfig({
  extends: [starlightMarkdoc(), pageMarkdoc()],
  tags: {
    "menu-example": {
      render: component("./src/components/markdoc/MenuExample.astro"),
      selfClosing: true,
    },
  },
});

src/content/docs/example.mdoc

{% menu-example /%}

结构

组件的组成部分，以及每个部分渲染的 data-refineui 角色。

部件	角色
root	menu-root
divider	menu-divider
item	menu-item
popover	menu-popover
label	menu-label

状态

组件会设置样式的状态。组件状态通过 data 属性暴露。

类型	状态
伪类	focus-visible
data-state	open closed default hover pressed active disabled

键盘

组件获得焦点时处理的按键。

按键	动作
Escape	close
Enter	activate
Space	activate

参考

• 设计指南和令牌细节见 RefineUI · Menu。
• 通用规则见在 MDX 中使用和在 Markdoc 中使用。