GitHub

Sidebar

Collapsible sidebar navigation

Basic Usage

Loading...

Installation

pnpm add @corew500/ui

Usage

import { Sidebar } from "@corew500/ui/sidebar"

<Sidebar>Content</Sidebar>

Variants

sidebarMenuButtonVariants

AxisValuesDefault
variant
defaulthighlight
default
size
defaultsmlg
default

Variants

Loading...

CMS Integration

CMSPayload CMS Integration
This component supports CMS-driven content via @corew500/cms-payload.
Loading...

API Reference

Props

PropTypeDefaultDescription
sideenumleftWhich side of the viewport the sidebar appears on.
variantenumsidebarVisual style variant of the sidebar. - `sidebar`: Standard sidebar with border separator - `floating`: Rounded corners, shadow, slight inset - `inset`: Background extends under sidebar area
collapsibleenumnoneControls how the sidebar collapses: - `none` (default): Sidebar is always visible, never collapses - `icon`: Sidebar collapses to icon-only width, content shifts - `offcanvas`: Sidebar slides over content (like a drawer), use for mobile-style overlays

Accessibility

Keyboard Navigation

  • - Keyboard shortcut: Cmd/Ctrl+B toggles sidebar

Focus Management

  • Focus management handled by child components
  • Mobile overlay uses Sheet with proper focus trap

Localization

Translatable Content

  • - No internal strings; pass translated content to child components
  • Menu labels, headers, and content accept pre-resolved strings