Tree

• src
  • overrides
    • Header.astro
    • Footer.astro
• package.json

导入

import {
  Tree,
  TreeItem,
  TreeItemTrigger,
  TreeItemContent,
} from "@pelagornis/page/components";

示例

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

src/components/TreeExample.tsx

import { Tree, TreeItem, TreeItemContent, TreeItemTrigger } from "@pelagornis/page/components";

export default function TreeDemo() {
  return (
    <Tree defaultExpanded={["src", "overrides"]} defaultSelected="header" aria-label="Files" className="w-full max-w-xs">
      <TreeItem value="src">
        <TreeItemTrigger>src</TreeItemTrigger>
        <TreeItemContent>
          <TreeItem value="overrides">
            <TreeItemTrigger>overrides</TreeItemTrigger>
            <TreeItemContent>
              <TreeItem value="header">
                <TreeItemTrigger>Header.astro</TreeItemTrigger>
              </TreeItem>
              <TreeItem value="footer">
                <TreeItemTrigger>Footer.astro</TreeItemTrigger>
              </TreeItem>
            </TreeItemContent>
          </TreeItem>
        </TreeItemContent>
      </TreeItem>
      <TreeItem value="package">
        <TreeItemTrigger>package.json</TreeItemTrigger>
      </TreeItem>
    </Tree>
  );
}

在 MDX 中使用

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

src/content/docs/example.mdx

---
title: Example
---

import TreeExample from "../../components/TreeExample";

<TreeExample client:load />

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

在 Markdoc 中使用

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

src/components/markdoc/TreeExample.astro

---
import TreeExample from "../TreeExample";
---

<TreeExample 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: {
    "tree-example": {
      render: component("./src/components/markdoc/TreeExample.astro"),
      selfClosing: true,
    },
  },
});

src/content/docs/example.mdoc

{% tree-example /%}

变体

每个 variant prop 可接受的取值。

Prop	取值
size	sm md lg

结构

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

部件	角色
root	tree
item	tree-item
item_chevron	tree-item-chevron
item_content	tree-item-content
item_main	tree-item-main
item_panel	tree-item-panel
item_trigger	tree-item-trigger

状态

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

类型	状态
伪类	focus-visible

键盘

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

按键	动作
ArrowDown	next-trigger
ArrowUp	previous-trigger
Home	first-trigger
End	last-trigger
Enter	activate
Space	activate

参考

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