Sidebar
A composable, themeable sidebar component for application navigation.
Usage
<ui-sidebar-provider>
<ui-sidebar variant="inset" collapsible="icon">
<ui-sidebar-header>
<ui-sidebar-menu>
<ui-sidebar-menu-item>
<ui-sidebar-menu-button size="lg">
<span>Acme Inc</span>
</ui-sidebar-menu-button>
</ui-sidebar-menu-item>
</ui-sidebar-menu>
</ui-sidebar-header>
<ui-sidebar-content>
<ui-sidebar-group>
<ui-sidebar-group-label>Platform</ui-sidebar-group-label>
<ui-sidebar-group-content>
<ui-sidebar-menu>
<ui-sidebar-menu-item>
<ui-sidebar-menu-button is-active>Dashboard</ui-sidebar-menu-button>
</ui-sidebar-menu-item>
<ui-sidebar-menu-item>
<ui-sidebar-menu-button>Projects</ui-sidebar-menu-button>
</ui-sidebar-menu-item>
</ui-sidebar-menu>
</ui-sidebar-group-content>
</ui-sidebar-group>
</ui-sidebar-content>
<ui-sidebar-footer>...</ui-sidebar-footer>
</ui-sidebar>
<ui-sidebar-inset>reactolith
<header>
<ui-sidebar-trigger></ui-sidebar-trigger>
<ui-breadcrumb>...</ui-breadcrumb>
</header>
<main>Your page content</main>
</ui-sidebar-inset>
</ui-sidebar-provider>
Sub-components
<ui-sidebar-provider> <ui-sidebar> <ui-sidebar-header> <ui-sidebar-content> <ui-sidebar-footer> <ui-sidebar-group> <ui-sidebar-group-label> <ui-sidebar-group-action> <ui-sidebar-group-content> <ui-sidebar-menu> <ui-sidebar-menu-item> <ui-sidebar-menu-button> <ui-sidebar-menu-action> <ui-sidebar-menu-badge> <ui-sidebar-menu-skeleton> <ui-sidebar-menu-sub> <ui-sidebar-menu-sub-item> <ui-sidebar-menu-sub-button> <ui-sidebar-trigger> <ui-sidebar-rail> <ui-sidebar-inset> <ui-sidebar-input> <ui-sidebar-separator>
Props
<ui-sidebar-provider>
| Prop | Type | Default | Description |
|---|
defaultOpen | boolean | true | Default open state. |
<ui-sidebar>
| Prop | Type | Default | Description |
|---|
side | "left" | "right" | "left" | Which side. |
variant | "sidebar" | "floating" | "inset" | "sidebar" | Visual variant. |
collapsible | "offcanvas" | "icon" | "none" | "offcanvas" | Collapse behavior. |
<ui-sidebar-menu-button> Custom wrapper
| Prop | Type | Default | Description |
|---|
href | string | — | URL to navigate to. Renders as a link when set. (Custom prop) |
isActive | boolean | false | Whether active. |
All components also accept standard HTML attributes (class, id, style, data-*, aria-*, etc.) which are passed through to the underlying element.