Sidebar
NavigationProvides a collapsible navigation rail with grouped destinations, active states, and a footer area.
Try it
Add to your project
npx shadcn@latest add https://luv-jeri.github.io/cojeev-ui/r/sidebar.jsonThe command includes the component’s shared dependencies. Your project keeps editable source files.
Include the complete example
This example also composes icon, typography. Install its parts together:
npx shadcn@latest add https://luv-jeri.github.io/cojeev-ui/r/sidebar.json https://luv-jeri.github.io/cojeev-ui/r/icon.json https://luv-jeri.github.io/cojeev-ui/r/typography.jsonUsing sidebar
Compose SidebarHeader, SidebarContent, menu buttons, and SidebarFooter around your destination links.
Use SidebarProvider for shared open state and choose container or viewport layout for its placement.
API
Compose the exported parts below. The prop types are read from the React source during the registry build.
Native element or underlying primitive props are inherited where declared, including accessible labels, event handlers and refs.
SidebarProviderProps
| Prop | Type | Required |
|---|---|---|
children | React.ReactNode | Yes |
open | boolean | No |
defaultOpen | boolean | No |
onOpenChange | (open: boolean) => void | No |
SidebarProps
| Prop | Type | Required |
|---|---|---|
open | boolean | No |
defaultOpen | boolean | No |
onOpenChange | (open: boolean) => void | No |
layoutContainer layout fills its parent; viewport layout follows the authored standalone rail. | "container" | "viewport" | No |
SidebarHeaderProps
Accepts the native or primitive props declared by its exported TypeScript type.
SidebarTriggerProps
Accepts the native or primitive props declared by its exported TypeScript type.
SidebarContentProps
Accepts the native or primitive props declared by its exported TypeScript type.
SidebarGroupLabelProps
Accepts the native or primitive props declared by its exported TypeScript type.
SidebarMenuButtonProps
| Prop | Type | Required |
|---|---|---|
asChild | boolean | No |
isActive | boolean | No |
label | string | No |
SidebarMenuLabelProps
Accepts the native or primitive props declared by its exported TypeScript type.
SidebarFooterProps
Accepts the native or primitive props declared by its exported TypeScript type.
SidebarMenuBadgeProps
Accepts the native or primitive props declared by its exported TypeScript type.
Accessibility
Provide a label for icon-only destinations and set isActive on the current link.
Preserve the trigger’s expanded state and the navigation label when composing custom content.
States and appearance
For conditional content, keep a MotionPresence boundary around keyed MotionSurface children. The shared entrance and exit states work with native primitives and respect your motion preference.
Try pointer and keyboard interaction, and switch the appearance control in the navigation to compare light and dark mode. Motion respects reduced motion preferences.