Tree

ファイルや入れ子のナビゲーション向けの展開できる階層です。

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

インポート

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

例

上のプレビューはこのファイルを描画したものです。src/components/ にコピーして使い始めてください。

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 ファイルで組み立て、そのファイルをインポートしてください。

---
title: Example
---

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

<TreeExample client:load />

client:load はページの読み込み時にアイランドをハイドレートします。ページの下の方にあるコンテンツには client:visible を使ってください。

Markdoc で使う

Markdoc のタグは Astro コンポーネントを描画しますが、このコンポーネントにはクライアントの状態が必要です。例をハイドレートする .astro ファイルで包み、そのファイルをタグとして登録してください。

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

<TreeExample client:load />

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,
    },
  },
});

{% 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 で使うを参照してください。