Sidebar

Vertical navigation with groups. The docs shell is built on it.

Import

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

Example

The preview above renders this file. Copy it into src/components/ to start from it.

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

Use in MDX

Sidebar is composed from parts that share React state. Children written in MDX are rendered as separate islands, so the parts can’t reach each other. Put the composition in a .tsx file, like the example above, and import that file instead.

---
title: Example
---

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

<SidebarExample client:load />

client:load hydrates the island on page load. Use client:visible for content far down the page.

Use in Markdoc

Markdoc tags render Astro components, and this one needs client state. Wrap the example in an .astro file that hydrates it, then register that file as a tag.

---
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 /%}

Anatomy

Parts of the component and the data-refineui role each one renders.

Part	Role
`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

States

States the component styles. Component states are exposed as data attributes.

Kind	States
Pseudo	`focus-visible`

Reference

RefineUI · Sidebar for design guidance and token detail.
Use in MDX and Use in Markdoc for the general rules.