Sidebar.
Compound sidebar with groups, links, and logo-only collapse.
Toggle the sidebar
When collapsed, only the icon remains.
The preview uses the actual shared component, including your current theme, rounding, border and motion preferences.
Props & API reference
Parameters available in the shared component, including value types, requirements and accepted options.
| Parameter | Type | Required | Default | Possible values | Description |
|---|---|---|---|---|---|
children | ReactNode | Yes | — | — | Sidebar sections, groups and links. |
className | string | No | — | — | Additional sidebar styling. |
SidebarBrand.icon | ReactNode | Yes | — | — | Brand mark displayed in expanded and compact views. |
SidebarGroup.label | string | No | — | — | Optional heading for a link group. |
SidebarLink.active | boolean | No | false | true · false | Highlights a current destination. |
SidebarLink.icon | IconName | No | "" | See the Icons gallery | Lucide icon beside the label. |
SidebarLink.href | string | No | — | — | Native anchor destination. |