Tree

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

Import

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

Example

The preview above renders this file. Copy it into src/components/ to start from it.

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

Use in MDX

Tree is composed from parts that share React state. Children written in MDX are rendered as separate islands, so the parts can’t reach each other. Put the composition in a .tsx file, like the example above, and import that file instead.

src/content/docs/example.mdx

---
title: Example
---

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

<TreeExample client:load />

client:load hydrates the island on page load. Use client:visible for content far down the page.

Use in Markdoc

Markdoc tags render Astro components, and this one needs client state. Wrap the example in an .astro file that hydrates it, then register that file as a tag.

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 /%}

Variants

Values the component accepts for each variant prop.

Prop	Values
size	sm md lg

Anatomy

Parts of the component and the data-refineui role each one renders.

Part	Role
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

States

States the component styles. Component states are exposed as data attributes.

Kind	States
Pseudo	focus-visible

Keyboard

Keys the component handles when it has focus.

Key	Action
ArrowDown	next-trigger
ArrowUp	previous-trigger
Home	first-trigger
End	last-trigger
Enter	activate
Space	activate

Reference

• RefineUI · Tree for design guidance and token detail.
• Use in MDX and Use in Markdoc for the general rules.