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.

If the material is missing, confirm the registry-installed shared and component CSS files are imported once.
If interaction differs, preserve this contract: Tab follows native controls and links; trigger toggles the panel.
If assistive output differs, preserve this semantic foundation: Aside, labelled nav lists, current-page links, and primary inset.
If dark, RTL, or reduced-motion behavior is missing, verify the nearest theme, direction, and media-query boundaries rather than adding page-local overrides.

Implementation decisions

When to use Sidebar

Use a sidebar for stable workspace navigation or complementary content that remains useful beside the main task. Keep DOM order logical when the layout collapses, identify the current destination, and provide a labelled small-screen alternative. Collapsed icons need accessible names and discoverable meaning. Test long labels, nested groups, restricted links, zoom, RTL, focus return, and browser history without duplicating interactive controls.

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

Load the real component preview when you are ready to interact with its responsive, theme, and direction controls.

Editable source

Read before you install

Canonical Base UI or native source

The registry payload stays off the initial page request.