Navigation and disclosure · stable · MIT

Sidebar

A controlled workspace shell with responsive navigation panel and inset.

Install editable source

Add Sidebar

Base UI / canonicalnpx shadcn@latest add https://gummyui.dev/r/gummy-sidebar.json

No package dependency beyond React. Shared Gummy material is resolved automatically.

Behavior contract

Semantics before surface

Semantics

Aside, labelled nav lists, current-page links, and primary inset.

Keyboard

Tab follows native controls and links; trigger toggles the panel.

System support

Light and dark themes, logical RTL layout, reduced motion, responsive content, and forwarded public refs.

Source-derived reference

Anatomy and public API

Exported anatomy

These public React parts are read directly from the canonical source during the documentation build.

  • GummySidebar
  • GummySidebarContent
  • GummySidebarFooter
  • GummySidebarGroup
  • GummySidebarGroupLabel
  • GummySidebarHeader
  • GummySidebarInset
  • GummySidebarMenu
  • GummySidebarMenuItem
  • GummySidebarMenuLink
  • GummySidebarPanel
  • GummySidebarTrigger

Prop contracts

GummySidebarProps

Composes React.HTMLAttributes<HTMLDivElement> & { open?: boolean; defaultOpen?: boolean; onOpenChange?: (open: boolean) => void; }

Troubleshooting

Check behavior before surface.

Live product source

Inspect the canonical states

The Component Lab exercises real source across default, focus, disabled, responsive, dark, reduced-motion, and RTL contexts.

Open the live Component Lab

Interactive inspection

Try Sidebar in context

Resize the canvas, switch its theme, or reverse its reading direction without changing the rest of the page.

Width
Theme
Direction
Project canvas

Primary content stays distinct from navigation.

Sidebar preview: fluid width, light theme, left to right.

Editable source

Read before you install

Canonical Base UI or native source

Loading editable source…