Collapsible

Release notes

The shell now uses RefineUI for the header, sidebar, search, and footer.

导入

import { Collapsible, CollapsibleTrigger, CollapsibleContent } from "@pelagornis/page/components";

示例

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

src/components/CollapsibleExample.tsx

import { Collapsible, CollapsibleContent, CollapsibleTrigger, Text } from "@pelagornis/page/components";

export default function CollapsibleDemo() {
  return (
    <Collapsible defaultOpen className="w-full">
      <CollapsibleTrigger>Release notes</CollapsibleTrigger>
      <CollapsibleContent>
        <Text variant="bodyMd">The shell now uses RefineUI for the header, sidebar, search, and footer.</Text>
      </CollapsibleContent>
    </Collapsible>
  );
}

在 MDX 中使用

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

src/content/docs/example.mdx

---
title: Example
---

import CollapsibleExample from "../../components/CollapsibleExample";

<CollapsibleExample client:load />

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

在 Markdoc 中使用

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

src/components/markdoc/CollapsibleExample.astro

---
import CollapsibleExample from "../CollapsibleExample";
---

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

src/content/docs/example.mdoc

{% collapsible-example /%}

参考

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