Skip to main content

Sidebar

The Sidebar component renders a sticky navigation column grouped into sections, with automatic aria-current="page" highlighting for the active link. It’s used under the hood by SidebarLayout, but you can also use it directly inside any BaseLayout-wrapped page that needs a sidebar.

Usage

---
import BaseLayout from "astro-theme-university/layouts/BaseLayout.astro";
import Sidebar, {
  type SidebarSection,
} from "astro-theme-university/components/Sidebar.astro";

const sections: SidebarSection[] = [
  {
    title: "Getting started",
    items: [
      { label: "Installation", href: "/docs/installation/" },
      { label: "Configuration", href: "/docs/configuration/" },
    ],
  },
  {
    title: "Guides",
    items: [{ label: "Deploying", href: "/docs/guides/deploying/" }],
  },
];
---

<BaseLayout title="My docs site">
  <Sidebar sections={sections} currentPath={Astro.url.pathname} />
  <article class="at-sidebar-content">
    <h1>Installation</h1>
    <p>Page content.</p>
  </article>
</BaseLayout>

Props

Prop Type Default Description
sections * SidebarSection[] --- Grouped navigation items. Sections render in order.
currentPath * string --- Current page path, used for `aria-current="page"`.
label string "Page sections" Accessible label for the nav landmark.

SidebarSection and SidebarItem

interface SidebarItem {
  label: string;
  href: string;
}

interface SidebarSection {
  title: string;
  items: SidebarItem[];
}

Both interfaces are exported from astro-theme-university/components/Sidebar.astro, so consumers who wrap or extend the Sidebar can reuse the types.

The Sidebar sets aria-current="page" on any link whose href (after the site’s base path is prefixed) exactly matches the currentPath prop. CSS then styles that link with --at-accent text on an --at-accent-soft background. Pass Astro.url.pathname as currentPath in most cases — collection detail pages may need the path stripped or rewritten to match the sidebar entry.

Responsive behaviour

The Sidebar renders as a 16rem sticky column on viewports wider than 768px. Below that breakpoint the at-sidebar rules in styles/sidebar.css hide it entirely via display: none — there’s no built-in mobile equivalent. For a mobile navigation experience, render a <details>-based summary inside the main column, or reach for your own drawer component.

Notes

The sidebar and its accompanying styles in styles/sidebar.css are imported automatically by SidebarLayout. If you use Sidebar without SidebarLayout, import the sidebar stylesheet yourself:

---
import "astro-theme-university/styles/sidebar.css";
---