Sidebar

Responsive collapsible application sidebar.

Overview

Copy the source into your project, then import the parts you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without wrapping or replacing a package.

Installation

Run bunx @yopem-ui/cli init from your project root first. The CLI configures StyleX and installs shared files and dependencies.

bunx @yopem-ui/cli init

bunx @yopem-ui/cli add sidebar

Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. Existing files are preserved. To refresh installed source, use update; locally edited files need an explicit --force to overwrite.

bunx @yopem-ui/cli update sidebar

Preview

Use the composition in Usage below to start with Sidebar.

Usage

Wrap Sidebar and the main content in SidebarProvider. Place SidebarTrigger where users can reach it and use SidebarInset for inset content.

Build navigation with SidebarGroup, SidebarMenu, SidebarMenuItem and SidebarMenuButton. Use render for links and isActive for the current location.

collapsible selects offcanvas, icon or none. Mobile uses a sheet. useSidebar exposes desktop and mobile state separately. Tooltip text helps identify icon-only items when collapsed.

Import from the local file installed by the CLI.

"use client"

import * as stylex from "@stylexjs/stylex"
import { HomeIcon, SettingsIcon } from "lucide-react"
import {
  Sidebar,
  SidebarContent,
  SidebarInset,
  SidebarMenu,
  SidebarMenuButton,
  SidebarMenuItem,
  SidebarMenuText,
  sidebarSlotStyles,
  SidebarProvider,
  SidebarTrigger,
} from "@/components/ui/sidebar"

export function Preview() {
  return (
    <SidebarProvider>
      <Sidebar>
        <SidebarContent>
          <nav aria-label="Main navigation">
            <SidebarMenu>
              <SidebarMenuItem>
                <SidebarMenuButton
                  isActive
                  render={<a href="/" aria-current="page" />}
                >
                  <HomeIcon {...stylex.props(sidebarSlotStyles.icon)} aria-hidden />
                  <SidebarMenuText>Home</SidebarMenuText>
                </SidebarMenuButton>
              </SidebarMenuItem>
              <SidebarMenuItem>
                <SidebarMenuButton render={<a href="/settings" />}>
                  <SettingsIcon {...stylex.props(sidebarSlotStyles.icon)} aria-hidden />
                  <SidebarMenuText>Settings</SidebarMenuText>
                </SidebarMenuButton>
              </SidebarMenuItem>
            </SidebarMenu>
          </nav>
        </SidebarContent>
      </Sidebar>
      <SidebarInset>
        <SidebarTrigger />
        <h1>Home</h1>
        <p>Your workspace.</p>
      </SidebarInset>
    </SidebarProvider>
  )
}

API reference

Generated from canonical TypeScript source. Only component and Base UI props appear below. Required marks a required property, not a required component.

View API reference