Sidebar
The app sidebar: collapsible to icons, a sheet on phones, with groups, menus, actions and badges.
A page-level item: the sidebar is fixed to the viewport and SidebarProvider is as tall as the page. To place one inside a box, as here, give the provider the class contents, then either use collapsible="none" or give the box contain-layout and the sidebar max-h-full. SidebarInset is a main element, so a page takes only one.
Collapsing to icons
import { FolderIcon, HomeIcon, InboxIcon, SettingsIcon } from "@keyline-icons/react"
import {
Sidebar,
SidebarContent,
SidebarFooter,
SidebarGroup,
SidebarGroupContent,
SidebarGroupLabel,
SidebarMenu,
SidebarMenuButton,
SidebarMenuItem,
SidebarProvider,
SidebarRail,
SidebarTrigger,
} from "@/components/ui/sidebar"
const rows = [
{ title: "Home", icon: HomeIcon },
{ title: "Inbox", icon: InboxIcon },
{ title: "Projects", icon: FolderIcon, current: true },
]
export default function SidebarCollapsingToIcons() {
return (
<div className="flex h-80 w-full overflow-hidden rounded-lg border contain-layout">
<SidebarProvider className="contents">
<Sidebar collapsible="icon" className="max-h-full">
<SidebarContent>
<SidebarGroup>
<SidebarGroupLabel>Workspace</SidebarGroupLabel>
<SidebarGroupContent>
<SidebarMenu>
{rows.map(({ title, icon: Icon, current }) => (
<SidebarMenuItem key={title}>
<SidebarMenuButton tooltip={title} isActive={current} aria-current={current ? "page" : undefined}>
<Icon />
<span>{title}</span>
</SidebarMenuButton>
</SidebarMenuItem>
))}
</SidebarMenu>
</SidebarGroupContent>
</SidebarGroup>
</SidebarContent>
<SidebarFooter>
<SidebarMenu>
<SidebarMenuItem>
<SidebarMenuButton tooltip="Settings">
<SettingsIcon />
<span>Settings</span>
</SidebarMenuButton>
</SidebarMenuItem>
</SidebarMenu>
</SidebarFooter>
<SidebarRail />
</Sidebar>
<div className="flex min-w-0 flex-1 flex-col gap-3 p-3 text-sm">
<SidebarTrigger />
<p className="px-1 text-muted-foreground">
The button above collapses the sidebar to its icons. On a phone it opens the sidebar as a sheet.
</p>
</div>
</SidebarProvider>
</div>
)
}
Navigation
import { FolderIcon, HomeIcon, InboxIcon, ReceiptIcon, RocketIcon, SettingsIcon } from "@keyline-icons/react"
import {
Sidebar,
SidebarContent,
SidebarFooter,
SidebarGroup,
SidebarGroupContent,
SidebarGroupLabel,
SidebarHeader,
SidebarMenu,
SidebarMenuBadge,
SidebarMenuButton,
SidebarMenuItem,
SidebarProvider,
} from "@/components/ui/sidebar"
const groups = [
{
label: "Workspace",
rows: [
{ title: "Home", icon: HomeIcon, count: 0, current: false },
{ title: "Inbox", icon: InboxIcon, count: 4, current: false },
{ title: "Projects", icon: FolderIcon, count: 0, current: true },
],
},
{
label: "Money",
rows: [
{ title: "Invoices", icon: ReceiptIcon, count: 3, current: false },
{ title: "Releases", icon: RocketIcon, count: 0, current: false },
],
},
]
export default function SidebarNavigation() {
return (
<div className="flex h-96 w-full overflow-hidden rounded-lg border">
<SidebarProvider className="contents">
<Sidebar collapsible="none" className="w-full border-r sm:w-(--sidebar-width)">
<SidebarHeader>
<span className="px-2 py-1 text-base font-medium">Harbour studio</span>
</SidebarHeader>
<SidebarContent>
{groups.map(({ label, rows }) => (
<SidebarGroup key={label}>
<SidebarGroupLabel>{label}</SidebarGroupLabel>
<SidebarGroupContent>
<SidebarMenu>
{rows.map(({ title, icon: Icon, count, current }) => (
<SidebarMenuItem key={title}>
<SidebarMenuButton isActive={current} aria-current={current ? "page" : undefined}>
<Icon />
<span>{title}</span>
</SidebarMenuButton>
{count ? <SidebarMenuBadge>{count}</SidebarMenuBadge> : null}
</SidebarMenuItem>
))}
</SidebarMenu>
</SidebarGroupContent>
</SidebarGroup>
))}
</SidebarContent>
<SidebarFooter>
<SidebarMenu>
<SidebarMenuItem>
<SidebarMenuButton>
<SettingsIcon />
<span>Settings</span>
</SidebarMenuButton>
</SidebarMenuItem>
</SidebarMenu>
</SidebarFooter>
</Sidebar>
<div className="hidden flex-1 flex-col gap-1 p-4 text-sm sm:flex">
<span className="font-medium">Projects</span>
<span className="text-muted-foreground">Three projects are active.</span>
</div>
</SidebarProvider>
</div>
)
}
Submenus and row actions
import { FolderIcon, MoreHorizontalIcon, PlusIcon } from "@keyline-icons/react"
import {
Sidebar,
SidebarContent,
SidebarGroup,
SidebarGroupAction,
SidebarGroupContent,
SidebarGroupLabel,
SidebarMenu,
SidebarMenuAction,
SidebarMenuButton,
SidebarMenuItem,
SidebarMenuSub,
SidebarMenuSubButton,
SidebarMenuSubItem,
SidebarProvider,
SidebarSeparator,
} from "@/components/ui/sidebar"
const projects = [
{ title: "Website refresh", pages: ["Tasks", "Invoices", "Releases"], current: "Invoices" },
{ title: "Mobile app", pages: ["Tasks", "Releases"] },
]
export default function SidebarSubmenusAndRowActions() {
return (
<div className="flex h-96 w-full max-w-64 overflow-hidden rounded-lg border">
<SidebarProvider className="contents">
<Sidebar collapsible="none" className="w-full">
<SidebarContent>
<SidebarGroup>
<SidebarGroupLabel>Projects</SidebarGroupLabel>
<SidebarGroupAction aria-label="New project">
<PlusIcon />
</SidebarGroupAction>
<SidebarGroupContent>
<SidebarMenu>
{projects.map(({ title, pages, current }) => (
<SidebarMenuItem key={title}>
<SidebarMenuButton>
<FolderIcon />
<span>{title}</span>
</SidebarMenuButton>
<SidebarMenuAction showOnHover aria-label={`Actions for ${title}`}>
<MoreHorizontalIcon />
</SidebarMenuAction>
<SidebarMenuSub>
{pages.map((page) => (
<SidebarMenuSubItem key={page}>
<SidebarMenuSubButton
href={`#${page.toLowerCase()}`}
isActive={page === current}
aria-current={page === current ? "page" : undefined}
>
<span>{page}</span>
</SidebarMenuSubButton>
</SidebarMenuSubItem>
))}
</SidebarMenuSub>
</SidebarMenuItem>
))}
</SidebarMenu>
</SidebarGroupContent>
</SidebarGroup>
<SidebarSeparator />
<SidebarGroup>
<SidebarGroupLabel>Archive</SidebarGroupLabel>
<SidebarGroupContent>
<SidebarMenu>
<SidebarMenuItem>
<SidebarMenuButton disabled>
<FolderIcon />
<span>Brand guidelines</span>
</SidebarMenuButton>
</SidebarMenuItem>
</SidebarMenu>
</SidebarGroupContent>
</SidebarGroup>
</SidebarContent>
</Sidebar>
</SidebarProvider>
</div>
)
}
Loading
import {
Sidebar,
SidebarContent,
SidebarGroup,
SidebarGroupContent,
SidebarGroupLabel,
SidebarMenu,
SidebarMenuItem,
SidebarMenuSkeleton,
SidebarProvider,
} from "@/components/ui/sidebar"
export default function SidebarLoading() {
return (
<div className="flex w-full max-w-64 overflow-hidden rounded-lg border">
<SidebarProvider className="contents">
<Sidebar collapsible="none" className="w-full">
<SidebarContent>
<SidebarGroup>
<SidebarGroupLabel>Projects</SidebarGroupLabel>
<SidebarGroupContent>
<SidebarMenu aria-busy="true" aria-label="Loading projects">
{Array.from({ length: 4 }, (_, index) => (
<SidebarMenuItem key={index}>
<SidebarMenuSkeleton showIcon />
</SidebarMenuItem>
))}
</SidebarMenu>
</SidebarGroupContent>
</SidebarGroup>
</SidebarContent>
</Sidebar>
</SidebarProvider>
</div>
)
}
Installation
npx shadcn@latest add @khaeli/sidebarbunx --bun shadcn@latest add @khaeli/sidebarInstall @khaeli/foundation first: this item's styling lives in its tokens and [data-slot] rules.
Installs with
- Registry items
- npm packages
- @base-ui/react ^1.7.0
- @keyline-icons/react ^2.2.0
- class-variance-authority ^0.7.1
- motion ^12.23.12
Keyboard
Tab- Moves through the rows, their actions and the submenu links, in order. A disabled row is skipped.
SidebarRailis not in the tab order. EnterSpace- Activate the focused row or
SidebarTrigger. ⌘ BCtrl + B- Collapses or expands the sidebar at once, with no animation. With several providers on a page, only the first one answers.
Escape- Closes the sheet the sidebar opens in on a phone and returns focus to the trigger. When focus is on a row that has a
tooltip, the first press only dismisses the tooltip.
Accessible name
SidebarTriggernames itself "Hide sidebar" or "Show sidebar". The phone sheet is a dialog titled "Sidebar".- A row is named by its text. Keep the text in a
spanso it stays the name when the sidebar is collapsed to icons;tooltipshows it to sighted users then. isActiveis only a look. Mark the current page witharia-current="page"as well.SidebarGroupActionandSidebarMenuActionare icon buttons: give each anaria-labelthat names its row or group.
Registry JSON
The item as the shadcn CLI reads it, with every file it ships: https://ui.khaeli.com/r/sidebar.json