Browse components

SidebarShell

The chrome of a sidebar with the regions left open: width, surface, collapse behaviour and a scrolling middle. Compose the sidebar molecules into it.

organisms

Live example

Default usage you can copy and adapt.

Composed sidebar

Each region is a snippet handed { collapsed, insetX }, so it matches the shell without re-deriving them.

Props

The props you are most likely to need, with types and defaults.

Props / API
NameTypeRequiredDefaultDescription
mode'expanded' | 'collapsed'NoexpandedSidebar display mode; passed to every region as collapsed
layout'rail' | 'card'NorailRail attaches to the viewport edge; card is a rounded floating panel
ariaLabelstringNoSidebar navigationAccessible name for the nav landmark
headerSnippet<[{ collapsed, insetX }]>No—Brand row, search — anything above the scrolling nav area
childrenSnippet<[{ collapsed, insetX }]>No—The scrolling middle
footerSnippet<[{ collapsed, insetX }]>No—Account row, logout, theme toggle — outside the scroll container
classstringNo—Extra classes, merged last so they win