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 中使用。