For the complete documentation index, see llms.txt. Markdown variants are available by appending .md to any URL or sending an Accept: text/markdown header. An agent skill is available at /.well-known/agent-skills/site-skill.md.
Shadcn Labs/

Collapsible Sidebar

A sidebar that collapses to an icon rail: the surface resizes, labels fade and the active pill glides between items. A React component built on View Transitions, installed with the shadcn CLI.

Home

Installation

$ pnpm dlx shadcn@latest add @transition-kit/collapsible-sidebar

Usage

import {
  CollapsibleSidebar,
  CollapsibleSidebarInset,
  CollapsibleSidebarItem,
  CollapsibleSidebarProvider,
  CollapsibleSidebarTrigger,
} from "@/components/transitions/collapsible-sidebar";
<CollapsibleSidebarProvider defaultValue="home">
  <CollapsibleSidebar aria-label="Main">
    <CollapsibleSidebarTrigger />
    <CollapsibleSidebarItem value="home" icon={<HouseIcon />}>
      Home
    </CollapsibleSidebarItem>
    <CollapsibleSidebarItem value="inbox" icon={<InboxIcon />}>
      Inbox
    </CollapsibleSidebarItem>
  </CollapsibleSidebar>
  <CollapsibleSidebarInset>{/* page content */}</CollapsibleSidebarInset>
</CollapsibleSidebarProvider>

useCollapsibleSidebar() returns { collapsed, setCollapsed, value, select } inside the provider.

API Reference

CollapsibleSidebarProvider

PropTypeDefaultDescription
collapsedboolean-Controlled collapsed state.
defaultCollapsedbooleanfalseInitial collapsed state when uncontrolled.
onCollapsedChange(collapsed: boolean) => void-Called when the sidebar collapses or expands.
valuestring-Controlled active item.
defaultValuestring""Initial active item when uncontrolled.
onValueChange(value: string) => void-Called when another item is chosen.

CollapsibleSidebarItem

PropTypeDefaultDescription
valuestring-Identifies the item.
iconReactNode-Shown in both states.

Change the corner radius with :root { --tk-ui-collapsible-sidebar-radius: 1rem; }.