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