Accordion

How do I install the theme?󰯓

Run bun add @pelagornis/page and register the plugin in Starlight.

Do I import any CSS?󰯓

No. The plugin injects the RefineUI stylesheets.

Where do components come from?󰯓

@pelagornis/page/components re-exports @refineui/react.

导入

import {
  Accordion,
  AccordionItem,
  AccordionTrigger,
  AccordionContent,
} from "@pelagornis/page/components";

示例

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

src/components/AccordionExample.tsx

import { Accordion, AccordionContent, AccordionItem, AccordionTrigger } from "@pelagornis/page/components";

export default function AccordionDemo() {
  return (
    <Accordion type="single" collapsible defaultValue="install" className="w-full">
      <AccordionItem value="install">
        <AccordionTrigger>How do I install the theme?</AccordionTrigger>
        <AccordionContent>Run bun add @pelagornis/page and register the plugin in Starlight.</AccordionContent>
      </AccordionItem>
      <AccordionItem value="css">
        <AccordionTrigger>Do I import any CSS?</AccordionTrigger>
        <AccordionContent>No. The plugin injects the RefineUI stylesheets.</AccordionContent>
      </AccordionItem>
      <AccordionItem value="components">
        <AccordionTrigger>Where do components come from?</AccordionTrigger>
        <AccordionContent>@pelagornis/page/components re-exports @refineui/react.</AccordionContent>
      </AccordionItem>
    </Accordion>
  );
}

在 MDX 中使用

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

src/content/docs/example.mdx

---
title: Example
---

import AccordionExample from "../../components/AccordionExample";

<AccordionExample client:load />

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

在 Markdoc 中使用

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

src/components/markdoc/AccordionExample.astro

---
import AccordionExample from "../AccordionExample";
---

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

src/content/docs/example.mdoc

{% accordion-example /%}

变体

每个 variant prop 可接受的取值。

Prop	取值
size	sm md lg
type	single multiple

结构

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

部件	角色
root	accordion
item	accordion-item
trigger	accordion-trigger
panel	accordion-panel
content	accordion-content

状态

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

类型	状态
伪类	focus-visible
data-state	open closed

键盘

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

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

参考

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