Sidebar

Docs

Start

Getting startedUse in MDX

Components

ButtonTabs

v2.0.0

インポート

import {
  Sidebar,
  SidebarHeader,
  SidebarBrand,
  SidebarContent,
  SidebarNav,
  SidebarGroup,
  SidebarGroupLabel,
  SidebarLink,
  SidebarFooter,
} from "@pelagornis/page/components";

例

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

src/components/SidebarExample.tsx

import {
  Box,
  Sidebar,
  SidebarBrand,
  SidebarContent,
  SidebarFooter,
  SidebarGroup,
  SidebarGroupLabel,
  SidebarHeader,
  SidebarLink,
  SidebarNav,
  Text,
} from "@pelagornis/page/components";

export default function SidebarDemo() {
  return (
    <Box border="strokeWidthThin" borderColor="borderDefault" radius="roundedLarge" className="h-80 w-64 overflow-hidden">
      <Sidebar className="h-full">
        <SidebarHeader>
          <SidebarBrand>Docs</SidebarBrand>
        </SidebarHeader>
        <SidebarContent>
          <SidebarNav>
            <SidebarGroup>
              <SidebarGroupLabel>Start</SidebarGroupLabel>
              <SidebarLink href="#" active>
                Getting started
              </SidebarLink>
              <SidebarLink href="#">Use in MDX</SidebarLink>
            </SidebarGroup>
            <SidebarGroup>
              <SidebarGroupLabel>Components</SidebarGroupLabel>
              <SidebarLink href="#">Button</SidebarLink>
              <SidebarLink href="#">Tabs</SidebarLink>
            </SidebarGroup>
          </SidebarNav>
        </SidebarContent>
        <SidebarFooter>
          <Text variant="captionMd">v2.0.0</Text>
        </SidebarFooter>
      </Sidebar>
    </Box>
  );
}

MDX で使う

Sidebar は React の状態を共有する複数のパーツで構成されます。MDX に書いた子要素はそれぞれ別のアイランドとして描画されるため、パーツ同士がつながりません。上の例のように .tsx ファイルで組み立て、そのファイルをインポートしてください。

src/content/docs/example.mdx

---
title: Example
---

import SidebarExample from "../../components/SidebarExample";

<SidebarExample client:load />

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

Markdoc で使う

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

src/components/markdoc/SidebarExample.astro

---
import SidebarExample from "../SidebarExample";
---

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

src/content/docs/example.mdoc

{% sidebar-example /%}

構造

コンポーネントを構成するパーツと、それぞれが描画する data-refineui のロールです。

パーツ	ロール
root	sidebar
brand	sidebar-brand
content	sidebar-content
footer	sidebar-footer
group	sidebar-group
group_label	sidebar-group-label
header	sidebar-header
link	sidebar-link
nav	sidebar-nav
peek	sidebar-peek
peek_edge	sidebar-peek-edge
peek_inset	sidebar-peek-inset
peek_panel	sidebar-peek-panel
peek_pin	sidebar-peek-pin
peek_surface	sidebar-peek-surface
provider	sidebar-provider
trigger	button

状態

コンポーネントがスタイルを当てる状態です。コンポーネントの状態は data 属性として公開されます。

種類	状態
疑似クラス	focus-visible

参考

• デザインのガイドとトークンの詳細は RefineUI · Sidebar を参照してください。
• 共通のルールは MDX で使う と Markdoc で使う を参照してください。