Sidebar

그룹이 있는 세로 내비게이션입니다. 문서 셸이 이 컴포넌트로 만들어져 있습니다.

가져오기

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

예제

위 미리보기는 이 파일을 렌더링한 것입니다. src/components/에 복사해서 시작하세요.

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 파일에서 조합한 뒤 그 파일을 가져오세요.

---
title: Example
---

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

<SidebarExample client:load />

client:load는 페이지를 불러올 때 아일랜드를 하이드레이션합니다. 페이지 아래쪽에 있는 콘텐츠에는 client:visible을 쓰세요.

Markdoc에서 사용

Markdoc 태그는 Astro 컴포넌트를 렌더링하는데, 이 컴포넌트는 클라이언트 상태가 필요합니다. 예제를 하이드레이션하는 .astro 파일로 감싼 뒤, 그 파일을 태그로 등록하세요.

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

<SidebarExample client:load />

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,
    },
  },
});

{% 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에서 사용을 참고하세요.