On this page
Sidebar
Provides a responsive application sidebar that collapses.
Overview
Copy the source into your project. Import the parts that you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without a wrapper or replacement package.
Preview
Start with the Sidebar example in Usage below.
Installation
Run the init command from your project root first. The CLI configures StyleX and installs shared files and dependencies.
Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. The CLI keeps existing files.
Usage
Wrap Sidebar and the main content in SidebarProvider. Place SidebarTrigger where users can reach it. Use SidebarInset for inset content.
Build navigation with SidebarGroup, SidebarMenu, SidebarMenuItem, and SidebarMenuButton. Use render for links. Use isActive for the current location.
collapsible selects offcanvas, icon, or none. Mobile layout uses a sheet. useSidebar provides desktop and mobile state separately. Tooltip text identifies icon-only items in the collapsed state.
Mobile Sidebar uses one flat sidebar-colored surface. Its inner surface inherits the outer background and corner radius.
Import from the local file installed by the CLI.
API reference
The generator reads the component TypeScript source. Only component and Base UI props appear below. The Required column shows whether you must supply a property. It does not mean you must use the component.