Sidebar
An app-shell sidebar that collapses offcanvas or to icons and becomes a sheet on small screens.
When to use
- Use when
- The main navigation of an app, collapsible on desktop and a sheet on mobile.
- Avoid when
- A site with a few top-level pages; use Navigation Menu.
Installation
The source lands in src/components/ui/sidebar.tsx, along with any Shelf items it builds on, and .shelf/lock.json records what was installed. It's yours to edit.
Usage
Built on
- Packages
@base-ui/react,@stylexjs/stylex- Accessibility
- Focus, keyboard, and ARIA behavior come from Base UI.
- Figma
- Optional native Figma library. See Designers.
Verified
- Size
- 4.1 kB gzipped on its own, 59 kB with the Shelf items and packages it builds on. JS and CSS in a production build, without React.
- Accessibility
- Axe passes on 5 stories
- Behavior
- 5 interaction tests in Storybook
- Rendering
- Parent re-renders skip its consumers
- React Doctor
- React Doctor finds nothing