- Accordion
- Agent Thinking
- Alert
- Alert Dialog
- Announcement
- Aspect Ratio
- Attachment
- Avatar
- Badge
- Breadcrumb
- Bubble
- Button
- Button Group
- Calendar
- Card
- Carousel
- Checkbox
- Checkbox Card
- Code Block
- Collapsible
- Color Picker
- Combobox
- Command
- Composer
- Composer Loader
- Context Menu
- Data Grid
- Data Table
- Date Picker
- Dialog
- Direction
- Drawer
- Dropdown Menu
- Empty
- Field
- File Upload
- Hover Card
- Input
- Input Group
- Input Otp
- Item
- Kbd
- Label
- Marker
- Menubar
- Message
- Message Scroller
- Meter
- Native Select
- Navigation Menu
- Number Field
- Pagination
- Period Switcher
- Popover
- Progress
- Questionnaire
- Radio Card
- Radio Group
- Resizable
- Reveal
- Scroll Area
- Search Field
- Select
- Separator
- Sheet
- Sidebar
- Skeleton
- Slider
- Social Button
- Sonner
- Spinner
- Status Dot
- Switch
- Switch Card
- Table
- Tabs
- Tag Group
- Textarea
- Theme Toggle
- Time Field
- Toggle
- Toggle Group
- Tooltip
- Trace
- Tree View
- Agent Creator 01
- Agent Limits Card 01
- Agent Progress 01
- AI Chat 01
- AI Image Generation 01
- AI Profile 01
- Alerts Card 01
- Auth Card 01
- Calendar 01
- Composer 01
- Composer Attachments 01
- Composer Panel 01
- Finance Dashboard 01
- Home Dashboard 01
- Marketing Dashboard 01
- Medical Profile 01
- Meeting Scheduler 01
- Multi Agent Chat 01
- Notification Center 01
- Patient Info Card 01
- Project Board 01
- Questionnaire 01
- Settings Modal 01
- Sidebar 01
- Stat Cards 01
- Task List 01
- Web Search 01
- Activity Rings Card 01
- Area Chart Card 01
- Bar List Card 01
- Combo Chart Card 01
- Contributions Card 01
- Earnings Chart Card 01
- Funnel Chart Card 01
- Heatmap Chart Card 01
- Line Chart Card 01
- Most Active Days Card 01
- Orders Chart Card 01
- Radar Chart Card 01
- Radial Chart Card 01
- Revenue Chart Card 01
- Sankey Chart Card 01
- Scatter Chart Card 01
- Sleep Score Card 01
- Stage Bars Card 01
- Steps Card 01
Installation
$ pnpm dlx shadcn@latest add @cobalt/sidebar
Options
variant="floating"withcollapsible="none"is a fixed panel that does not collapse but still looks like a card: a 24px radius, the panel border and the sidebar shadow.SidebarProvidertakespersistStateandkeyboardShortcut, bothtrueby default. Set them tofalsefor a sidebar that never collapses, so it does not write thesidebar_statecookie or bind Cmd/Ctrl+B.SidebarMenuSub variant="tree"draws one continuous rail with a short branch into each row and a rounded elbow at the last row.variant="rail"is a plain list on a hairline with a bar beside the active row, for an "on this page" outline.SidebarGroupLabeluses the quietforeground-subtlecolour.
Source
"use client";
import { mergeProps } from "@base-ui/react/merge-props";
import { useRender } from "@base-ui/react/use-render";
import { RiSidebarFoldLine } from "@remixicon/react";
import { cva } from "class-variance-authority";
import type { VariantProps } from "class-variance-authority";
import { cn } from "cn";
import * as React from "react";
import { useIsMobile } from "@/components/hooks/use-mobile";
import { Button } from "@/components/ui/button";
import { Input } from "@/components/ui/input";
import { Separator } from "@/components/ui/separator";
import {
Sheet,
SheetContent,
SheetDescription,
SheetHeader,
SheetTitle,
} from "@/components/ui/sheet";
import { Skeleton } from "@/components/ui/skeleton";
import {
Tooltip,
TooltipContent,
TooltipTrigger,
} from "@/components/ui/tooltip";
const SIDEBAR_COOKIE_NAME = "sidebar_state";
const SIDEBAR_COOKIE_MAX_AGE = 60 * 60 * 24 * 7;
const SIDEBAR_WIDTH = "260px";
const SIDEBAR_WIDTH_MOBILE = "18rem";
const SIDEBAR_WIDTH_ICON = "60px";
const SIDEBAR_KEYBOARD_SHORTCUT = "b";
interface SidebarContextProps {
state: "expanded" | "collapsed";
open: boolean;
setOpen: (open: boolean) => void;
openMobile: boolean;
setOpenMobile: (open: boolean) => void;
isMobile: boolean;
toggleSidebar: () => void;
}
const SidebarContext = React.createContext<SidebarContextProps | null>(null);
function useSidebar() {
const context = React.useContext(SidebarContext);
if (!context) {
throw new Error("useSidebar must be used within a SidebarProvider.");
}
return context;
}
function SidebarProvider({
defaultOpen = true,
open: openProp,
onOpenChange: setOpenProp,
persistState = true,
keyboardShortcut = true,
className,
style,
children,
...props
}: React.ComponentProps<"div"> & {
defaultOpen?: boolean;
open?: boolean;
onOpenChange?: (open: boolean) => void;
/** Set false to skip writing the sidebar_state cookie. */
persistState?: boolean;
/** Set false to turn off the Cmd/Ctrl+B toggle, e.g. for a sidebar that never collapses. */
keyboardShortcut?: boolean;
}) {
const isMobile = useIsMobile();
const [openMobile, setOpenMobile] = React.useState(false);
// This is the internal state of the sidebar.
// We use openProp and setOpenProp for control from outside the component.
const [_open, _setOpen] = React.useState(defaultOpen);
const open = openProp ?? _open;
const setOpen = React.useCallback(
(value: boolean | ((value: boolean) => boolean)) => {
const openState = typeof value === "function" ? value(open) : value;
if (setOpenProp) {
setOpenProp(openState);
} else {
_setOpen(openState);
}
// This sets the cookie to keep the sidebar state.
if (persistState) {
document.cookie = `${SIDEBAR_COOKIE_NAME}=${openState}; path=/; max-age=${SIDEBAR_COOKIE_MAX_AGE}`;
}
},
[setOpenProp, open, persistState]
);
// Helper to toggle the sidebar.
const toggleSidebar = React.useCallback(
() =>
isMobile ? setOpenMobile((open) => !open) : setOpen((open) => !open),
[isMobile, setOpen, setOpenMobile]
);
// Adds a keyboard shortcut to toggle the sidebar.
React.useEffect(() => {
if (!keyboardShortcut) {
return;
}
const handleKeyDown = (event: KeyboardEvent) => {
if (
event.key === SIDEBAR_KEYBOARD_SHORTCUT &&
(event.metaKey || event.ctrlKey)
) {
event.preventDefault();
toggleSidebar();
}
};
window.addEventListener("keydown", handleKeyDown);
return () => window.removeEventListener("keydown", handleKeyDown);
}, [toggleSidebar, keyboardShortcut]);
// We add a state so that we can do data-state="expanded" or "collapsed".
// This makes it easier to style the sidebar with Tailwind classes.
const state = open ? "expanded" : "collapsed";
const contextValue = React.useMemo<SidebarContextProps>(
() => ({
isMobile,
open,
openMobile,
setOpen,
setOpenMobile,
state,
toggleSidebar,
}),
[state, open, setOpen, isMobile, openMobile, setOpenMobile, toggleSidebar]
);
return (
<SidebarContext.Provider value={contextValue}>
<div
data-slot="sidebar-wrapper"
style={
{
"--sidebar-width": SIDEBAR_WIDTH,
"--sidebar-width-icon": SIDEBAR_WIDTH_ICON,
...style,
} as React.CSSProperties
}
className={cn(
"group/sidebar-wrapper flex min-h-svh w-full has-[[data-slot=sidebar][data-variant=inset]]:bg-sidebar",
className
)}
{...props}
>
{children}
</div>
</SidebarContext.Provider>
);
}
// Light --sidebar is the same colour as --surface-hover, so a ghost button on
// the sidebar would show no hover at all. Inside the sidebar the hover fill
// steps to --sidebar-accent (dark already differs, so it is left alone).
const sidebarHover = "not-dark:[--surface-hover:var(--sidebar-accent)]";
function Sidebar({
side = "left",
variant = "sidebar",
collapsible = "offcanvas",
className,
children,
dir,
...props
}: React.ComponentProps<"div"> & {
side?: "left" | "right";
variant?: "sidebar" | "floating" | "inset";
collapsible?: "offcanvas" | "icon" | "none";
}) {
const { isMobile, state, openMobile, setOpenMobile } = useSidebar();
if (collapsible === "none") {
return (
<div
data-slot="sidebar"
data-variant={variant}
className={cn(
"flex h-full w-(--sidebar-width) flex-col bg-sidebar text-sidebar-foreground",
sidebarHover,
// A fixed panel that does not collapse can still be a floating card.
variant === "floating" &&
"overflow-hidden rounded-[24px] border border-[var(--sidebar-panel-border,var(--sidebar-border))] shadow-[shadow:var(--command-shadow,0_1px_0_0_rgb(0_0_0/0.0196),0_1px_12px_0_rgb(0_0_0/0.0588),0_0_1px_0_rgb(0_0_0/0.3216))]",
className
)}
{...props}
>
{children}
</div>
);
}
if (isMobile) {
return (
<Sheet open={openMobile} onOpenChange={setOpenMobile} {...props}>
<SheetContent
dir={dir}
data-sidebar="sidebar"
data-slot="sidebar"
data-mobile="true"
className={cn(
"w-(--sidebar-width) bg-sidebar p-0 text-sidebar-foreground [&>button]:hidden",
sidebarHover
)}
style={
{
"--sidebar-width": SIDEBAR_WIDTH_MOBILE,
} as React.CSSProperties
}
side={side}
>
<SheetHeader className="sr-only">
<SheetTitle>Sidebar</SheetTitle>
<SheetDescription>Displays the mobile sidebar.</SheetDescription>
</SheetHeader>
<div className="flex h-full w-full flex-col">{children}</div>
</SheetContent>
</Sheet>
);
}
return (
<div
className="group peer hidden text-sidebar-foreground md:block"
data-state={state}
data-collapsible={state === "collapsed" ? collapsible : ""}
data-variant={variant}
data-side={side}
data-slot="sidebar"
>
{/* This is what handles the sidebar gap on desktop */}
<div
data-slot="sidebar-gap"
className={cn(
"relative w-(--sidebar-width) bg-transparent transition-[width] duration-300 ease-in-out motion-reduce:transition-none",
"group-data-[collapsible=offcanvas]:w-0",
"group-data-[side=right]:rotate-180",
variant === "floating" || variant === "inset"
? "group-data-[collapsible=icon]:w-[calc(var(--sidebar-width-icon)+(--spacing(4)))]"
: "group-data-[collapsible=icon]:w-(--sidebar-width-icon)"
)}
/>
<div
data-slot="sidebar-container"
data-side={side}
className={cn(
"fixed inset-y-0 z-10 hidden h-svh w-(--sidebar-width) transition-[left,right,width] duration-300 ease-in-out motion-reduce:transition-none data-[side=left]:left-0 data-[side=left]:group-data-[collapsible=offcanvas]:left-[calc(var(--sidebar-width)*-1)] data-[side=right]:right-0 data-[side=right]:group-data-[collapsible=offcanvas]:right-[calc(var(--sidebar-width)*-1)] md:flex",
// Adjust the padding for floating and inset variants.
variant === "floating" || variant === "inset"
? "p-2 group-data-[collapsible=icon]:w-[calc(var(--sidebar-width-icon)+(--spacing(4))+2px)]"
: "group-data-[collapsible=icon]:w-(--sidebar-width-icon) group-data-[side=left]:border-r group-data-[side=right]:border-l",
className
)}
{...props}
>
<div
data-sidebar="sidebar"
data-slot="sidebar-inner"
className={cn(
"flex size-full flex-col bg-sidebar group-data-[variant=floating]:rounded-[24px] group-data-[variant=floating]:border group-data-[variant=floating]:border-[var(--sidebar-panel-border,var(--sidebar-border))] group-data-[variant=floating]:shadow-[shadow:var(--command-shadow,0_1px_0_0_rgb(0_0_0/0.0196),0_1px_12px_0_rgb(0_0_0/0.0588),0_0_1px_0_rgb(0_0_0/0.3216))]",
sidebarHover
)}
>
{children}
</div>
</div>
</div>
);
}
function SidebarTrigger({
className,
onClick,
...props
}: React.ComponentProps<typeof Button>) {
const { toggleSidebar } = useSidebar();
return (
<Button
data-sidebar="trigger"
data-slot="sidebar-trigger"
variant="ghost"
size="icon-sm"
className={cn(className)}
onClick={(event) => {
onClick?.(event);
toggleSidebar();
}}
{...props}
>
<RiSidebarFoldLine />
<span className="sr-only">Toggle Sidebar</span>
</Button>
);
}
function SidebarRail({ className, ...props }: React.ComponentProps<"button">) {
const { toggleSidebar } = useSidebar();
return (
<button
data-sidebar="rail"
data-slot="sidebar-rail"
aria-label="Toggle Sidebar"
tabIndex={-1}
onClick={toggleSidebar}
title="Toggle Sidebar"
className={cn(
"absolute inset-y-0 z-20 hidden w-4 transition-all ease-linear motion-reduce:transition-none group-data-[side=left]:-right-4 group-data-[side=right]:left-0 after:absolute after:inset-y-0 after:start-1/2 after:w-[2px] hover:after:bg-sidebar-border sm:flex ltr:-translate-x-1/2 rtl:-translate-x-1/2",
"in-data-[side=left]:cursor-w-resize in-data-[side=right]:cursor-e-resize",
"[[data-side=left][data-state=collapsed]_&]:cursor-e-resize [[data-side=right][data-state=collapsed]_&]:cursor-w-resize",
"group-data-[collapsible=offcanvas]:translate-x-0 group-data-[collapsible=offcanvas]:after:left-full hover:group-data-[collapsible=offcanvas]:bg-sidebar",
"[[data-side=left][data-collapsible=offcanvas]_&]:-right-2",
"[[data-side=right][data-collapsible=offcanvas]_&]:-left-2",
className
)}
{...props}
/>
);
}
function SidebarInset({ className, ...props }: React.ComponentProps<"main">) {
return (
<main
data-slot="sidebar-inset"
className={cn(
"relative flex w-full flex-1 flex-col bg-background md:peer-data-[variant=inset]:m-2 md:peer-data-[variant=inset]:ml-0 md:peer-data-[variant=inset]:rounded-[12px] md:peer-data-[variant=inset]:shadow-sm md:peer-data-[variant=inset]:peer-data-[state=collapsed]:ml-2",
className
)}
{...props}
/>
);
}
function SidebarInput({
className,
...props
}: React.ComponentProps<typeof Input>) {
return (
<Input
data-slot="sidebar-input"
data-sidebar="input"
className={cn("h-8 w-full bg-background shadow-none", className)}
{...props}
/>
);
}
function SidebarHeader({ className, ...props }: React.ComponentProps<"div">) {
return (
<div
data-slot="sidebar-header"
data-sidebar="header"
className={cn("flex flex-col gap-3 p-3", className)}
{...props}
/>
);
}
function SidebarFooter({ className, ...props }: React.ComponentProps<"div">) {
return (
<div
data-slot="sidebar-footer"
data-sidebar="footer"
className={cn("flex flex-col gap-3 p-3", className)}
{...props}
/>
);
}
function SidebarSeparator({
className,
...props
}: React.ComponentProps<typeof Separator>) {
return (
<Separator
data-slot="sidebar-separator"
data-sidebar="separator"
className={cn("mx-2 w-auto bg-sidebar-border", className)}
{...props}
/>
);
}
function SidebarContent({ className, ...props }: React.ComponentProps<"div">) {
return (
<div
data-slot="sidebar-content"
data-sidebar="content"
className={cn(
"no-scrollbar flex min-h-0 flex-1 flex-col gap-2 overflow-auto group-data-[collapsible=icon]:overflow-hidden",
className
)}
{...props}
/>
);
}
function SidebarGroup({ className, ...props }: React.ComponentProps<"div">) {
return (
<div
data-slot="sidebar-group"
data-sidebar="group"
className={cn("relative flex w-full min-w-0 flex-col p-3", className)}
{...props}
/>
);
}
function SidebarGroupLabel({
className,
render,
...props
}: useRender.ComponentProps<"div"> & React.ComponentProps<"div">) {
return useRender({
defaultTagName: "div",
props: mergeProps<"div">(
{
className: cn(
"flex h-8 shrink-0 items-center rounded-[10px] px-2 text-xs font-medium text-[color:var(--foreground-subtle,var(--muted-foreground))] ring-sidebar-ring outline-hidden transition-[margin,opacity] duration-300 ease-in-out motion-reduce:transition-none group-data-[collapsible=icon]:-mt-8 group-data-[collapsible=icon]:opacity-0 focus-visible:ring-2 [&>svg]:size-4 [&>svg]:shrink-0",
className
),
},
props
),
render,
state: {
sidebar: "group-label",
slot: "sidebar-group-label",
},
});
}
function SidebarGroupAction({
className,
render,
...props
}: useRender.ComponentProps<"button"> & React.ComponentProps<"button">) {
return useRender({
defaultTagName: "button",
props: mergeProps<"button">(
{
className: cn(
"absolute top-3.5 right-3 flex aspect-square w-5 items-center justify-center rounded-[10px] p-0 text-sidebar-foreground ring-sidebar-ring outline-hidden transition-transform motion-reduce:transition-none group-data-[collapsible=icon]:hidden after:absolute after:-inset-2 hover:bg-sidebar-accent hover:text-sidebar-accent-foreground focus-visible:ring-2 md:after:hidden [&>svg]:size-4 [&>svg]:shrink-0",
className
),
},
props
),
render,
state: {
sidebar: "group-action",
slot: "sidebar-group-action",
},
});
}
function SidebarGroupContent({
className,
...props
}: React.ComponentProps<"div">) {
return (
<div
data-slot="sidebar-group-content"
data-sidebar="group-content"
className={cn("w-full text-sm", className)}
{...props}
/>
);
}
function SidebarMenu({ className, ...props }: React.ComponentProps<"ul">) {
return (
<ul
data-slot="sidebar-menu"
data-sidebar="menu"
className={cn("flex w-full min-w-0 flex-col gap-1", className)}
{...props}
/>
);
}
function SidebarMenuItem({ className, ...props }: React.ComponentProps<"li">) {
return (
<li
data-slot="sidebar-menu-item"
data-sidebar="menu-item"
className={cn("group/menu-item relative", className)}
{...props}
/>
);
}
// A row clicked with the mouse keeps focus, and Chrome turns that into a
// `:focus-visible` ring as soon as any key is pressed afterwards (a
// screenshot shortcut, Shift). Mouse clicks (`detail > 0`) hand focus back;
// Enter and Space (`detail === 0`) keep it, so keyboard users keep the ring.
function releasePointerFocus(event: React.MouseEvent<HTMLElement>) {
if (event.detail > 0 && !event.currentTarget.hasAttribute("aria-haspopup")) {
event.currentTarget.blur();
}
}
const sidebarMenuButtonVariants = cva(
"peer/menu-button group/menu-button relative isolate flex w-full cursor-pointer items-center gap-2 overflow-hidden rounded-[10px] p-2 text-left text-sm font-medium text-muted-foreground ring-sidebar-ring outline-hidden transition-[width,height,padding,background-color] duration-300 ease-in-out motion-reduce:transition-none group-has-data-[sidebar=menu-action]/menu-item:pr-8 group-data-[collapsible=icon]:size-9! group-data-[collapsible=icon]:p-2! hover:bg-sidebar-accent focus-visible:ring-2 disabled:pointer-events-none disabled:opacity-50 aria-disabled:pointer-events-none aria-disabled:opacity-50 before:absolute before:inset-0 before:-z-10 before:rounded-[inherit] data-active:before:bg-primary data-active:before:bg-[image:var(--gradient-button-primary-default,linear-gradient(180deg,oklch(from_var(--primary)_calc(l_+_0.08)_c_h),var(--primary)))] data-active:text-primary-foreground data-active:[&_[data-slot=badge]]:bg-primary-foreground/20 data-active:[&_[data-slot=badge]]:text-primary-foreground data-active:before:shadow-[inset_0_1px_0_0_rgb(255_255_255/0.251)] data-active:shadow-[0_0_0_1px_var(--ring)] [&_svg]:size-5 [&_svg]:shrink-0 [&>span:last-child]:truncate",
{
defaultVariants: {
size: "default",
variant: "default",
},
variants: {
size: {
default: "h-9 text-sm",
lg: "h-12 text-sm group-data-[collapsible=icon]:p-0!",
sm: "h-7 text-xs",
},
variant: {
default: "",
outline:
"bg-background shadow-[0_0_0_1px_var(--sidebar-border)] hover:bg-sidebar-accent hover:text-sidebar-accent-foreground hover:shadow-[0_0_0_1px_var(--sidebar-accent)]",
},
},
}
);
function SidebarMenuButton({
render,
isActive = false,
variant = "default",
size = "default",
tooltip,
className,
...props
}: useRender.ComponentProps<"button"> &
React.ComponentProps<"button"> & {
isActive?: boolean;
tooltip?: string | React.ComponentProps<typeof TooltipContent>;
} & VariantProps<typeof sidebarMenuButtonVariants>) {
// Outside a SidebarProvider (a menu in a card) it behaves as expanded.
const { isMobile, state } = React.useContext(SidebarContext) ?? {
isMobile: false,
state: "expanded",
};
const comp = useRender({
defaultTagName: "button",
props: mergeProps<"button">(
{
className: cn(sidebarMenuButtonVariants({ size, variant }), className),
onClick: releasePointerFocus,
},
props
),
render: !tooltip ? render : <TooltipTrigger render={render} />,
state: {
active: isActive,
sidebar: "menu-button",
size,
slot: "sidebar-menu-button",
},
});
if (!tooltip) {
return comp;
}
if (typeof tooltip === "string") {
tooltip = {
children: tooltip,
};
}
return (
<Tooltip>
{comp}
<TooltipContent
side="right"
align="center"
hidden={state !== "collapsed" || isMobile}
{...tooltip}
/>
</Tooltip>
);
}
function SidebarMenuAction({
className,
render,
showOnHover = false,
...props
}: useRender.ComponentProps<"button"> &
React.ComponentProps<"button"> & {
showOnHover?: boolean;
}) {
return useRender({
defaultTagName: "button",
props: mergeProps<"button">(
{
className: cn(
"absolute top-1.5 right-1 flex aspect-square w-5 cursor-pointer items-center justify-center rounded-[10px] p-0 text-sidebar-foreground ring-sidebar-ring outline-hidden transition-transform motion-reduce:transition-none group-data-[collapsible=icon]:hidden peer-hover/menu-button:text-sidebar-accent-foreground peer-data-[size=default]/menu-button:top-1.5 peer-data-[size=lg]/menu-button:top-2.5 peer-data-[size=sm]/menu-button:top-1 after:absolute after:-inset-2 hover:bg-sidebar-accent hover:text-sidebar-accent-foreground focus-visible:ring-2 md:after:hidden [&>svg]:size-4 [&>svg]:shrink-0",
showOnHover &&
"group-focus-within/menu-item:opacity-100 group-hover/menu-item:opacity-100 peer-data-active/menu-button:text-sidebar-accent-foreground aria-expanded:opacity-100 md:opacity-0",
className
),
},
props
),
render,
state: {
sidebar: "menu-action",
slot: "sidebar-menu-action",
},
});
}
function SidebarMenuBadge({
className,
...props
}: React.ComponentProps<"div">) {
return (
<div
data-slot="sidebar-menu-badge"
data-sidebar="menu-badge"
className={cn(
"pointer-events-none absolute right-1 flex h-5 min-w-5 items-center justify-center rounded-[10px] px-1 text-xs font-medium text-sidebar-foreground tabular-nums select-none group-data-[collapsible=icon]:hidden peer-hover/menu-button:text-sidebar-accent-foreground peer-data-[size=default]/menu-button:top-1.5 peer-data-[size=lg]/menu-button:top-2.5 peer-data-[size=sm]/menu-button:top-1 peer-data-active/menu-button:text-sidebar-accent-foreground",
className
)}
{...props}
/>
);
}
function SidebarMenuSkeleton({
className,
showIcon = false,
...props
}: React.ComponentProps<"div"> & {
showIcon?: boolean;
}) {
// Width between 50 and 90%, derived from useId so server and client agree.
const id = React.useId();
let hash = 0;
for (let i = 0; i < id.length; i += 1) {
hash = (hash * 31 + (id.codePointAt(i) ?? 0)) % 997;
}
const width = `${(hash % 40) + 50}%`;
return (
<div
data-slot="sidebar-menu-skeleton"
data-sidebar="menu-skeleton"
className={cn(
"flex h-8 items-center gap-2 rounded-[10px] px-2",
className
)}
{...props}
>
{showIcon && (
<Skeleton
className="size-4 rounded-[10px]"
data-sidebar="menu-skeleton-icon"
/>
)}
<Skeleton
className="h-4 max-w-(--skeleton-width) flex-1"
data-sidebar="menu-skeleton-text"
style={
{
"--skeleton-width": width,
} as React.CSSProperties
}
/>
</div>
);
}
function SidebarMenuSub({
className,
variant = "default",
...props
}: React.ComponentProps<"ul"> & {
/**
* `tree` draws a hairline from the parent with a rounded connector into
* each row, mutes the rows, and sets the active row on a filled surface.
* `rail` is a plain list on a hairline with a bar beside the active row,
* for an "on this page" outline.
*/
variant?: "default" | "tree" | "rail";
}) {
return (
<ul
data-slot="sidebar-menu-sub"
data-sidebar="menu-sub"
data-variant={variant}
className={cn(
"group/menu-sub mx-3.5 flex min-w-0 translate-x-px flex-col gap-1 border-l border-sidebar-border px-2.5 py-0.5 group-data-[collapsible=icon]:hidden",
variant === "tree" &&
"mx-0 ml-[13px] translate-x-0 gap-0 border-l-0 py-0 pr-0 pl-3",
variant === "rail" &&
"mx-0 translate-x-0 gap-0 border-[var(--border-subtle,var(--sidebar-border))] p-0",
className
)}
{...props}
/>
);
}
function SidebarMenuSubItem({
className,
...props
}: React.ComponentProps<"li">) {
return (
<li
data-slot="sidebar-menu-sub-item"
data-sidebar="menu-sub-item"
className={cn(
"group/menu-sub-item relative",
// Tree rows keep a 2px gap between their fills (1px above and below
// each 32px row, a 34px pitch). The item owns the padding, so the
// rail drawn on the item still runs unbroken through the gap.
"group-data-[variant=tree]/menu-sub:py-px",
// The tree line: a rounded elbow into every row, and a vertical that
// runs on to the next row except after the last.
"group-data-[variant=tree]/menu-sub:before:pointer-events-none group-data-[variant=tree]/menu-sub:before:absolute group-data-[variant=tree]/menu-sub:before:top-[11px] group-data-[variant=tree]/menu-sub:before:z-10 group-data-[variant=tree]/menu-sub:before:-left-3 group-data-[variant=tree]/menu-sub:before:h-[6px] group-data-[variant=tree]/menu-sub:before:w-3 group-data-[variant=tree]/menu-sub:before:border-b group-data-[variant=tree]/menu-sub:before:border-[color:var(--border-hover,var(--sidebar-border))] group-data-[variant=tree]/menu-sub:dark:before:border-[color:var(--border,var(--sidebar-border))] group-data-[variant=tree]/menu-sub:before:content-[''] group-data-[variant=tree]/menu-sub:before:rounded-bl-[6px] group-data-[variant=tree]/menu-sub:before:border-l",
"group-data-[variant=tree]/menu-sub:after:pointer-events-none group-data-[variant=tree]/menu-sub:after:absolute group-data-[variant=tree]/menu-sub:after:top-0 group-data-[variant=tree]/menu-sub:after:z-10 group-data-[variant=tree]/menu-sub:after:bottom-0 group-data-[variant=tree]/menu-sub:after:-left-3 group-data-[variant=tree]/menu-sub:after:w-px group-data-[variant=tree]/menu-sub:after:bg-[color:var(--border-hover,var(--sidebar-border))] group-data-[variant=tree]/menu-sub:dark:after:bg-[color:var(--border,var(--sidebar-border))] group-data-[variant=tree]/menu-sub:after:content-[''] group-data-[variant=tree]/menu-sub:last:after:bottom-auto group-data-[variant=tree]/menu-sub:last:after:h-[12px]",
className
)}
{...props}
/>
);
}
function SidebarMenuSubButton({
render,
size = "md",
isActive = false,
className,
...props
}: useRender.ComponentProps<"a"> &
React.ComponentProps<"a"> & {
size?: "sm" | "md";
isActive?: boolean;
}) {
return useRender({
defaultTagName: "a",
props: mergeProps<"a">(
{
className: cn(
"relative isolate flex h-7 min-w-0 -translate-x-px cursor-pointer items-center gap-2 overflow-hidden rounded-[10px] px-2 text-sidebar-foreground ring-sidebar-ring outline-hidden transition-colors duration-100 ease-out group-data-[collapsible=icon]:hidden hover:bg-sidebar-accent hover:text-sidebar-accent-foreground focus-visible:ring-2 motion-reduce:transition-none active:bg-sidebar-accent active:text-sidebar-accent-foreground disabled:pointer-events-none disabled:opacity-50 aria-disabled:pointer-events-none aria-disabled:opacity-50 data-[size=md]:text-sm data-[size=sm]:text-xs after:absolute after:inset-0 after:-z-10 after:rounded-[inherit] data-active:after:bg-sidebar-accent data-active:text-sidebar-accent-foreground data-active:transition-none",
"group-data-[variant=tree]/menu-sub:h-8 group-data-[variant=tree]/menu-sub:rounded-[8px] group-data-[variant=tree]/menu-sub:-ml-[25px] group-data-[variant=tree]/menu-sub:w-[calc(100%+25px)] group-data-[variant=tree]/menu-sub:pr-14 group-data-[variant=tree]/menu-sub:pl-[33px] group-data-[variant=tree]/menu-sub:text-muted-foreground group-data-[variant=tree]/menu-sub:hover:text-muted-foreground group-data-[variant=tree]/menu-sub:active:text-muted-foreground group-data-[variant=tree]/menu-sub:data-active:text-muted-foreground group-data-[variant=rail]/menu-sub:relative group-data-[variant=rail]/menu-sub:overflow-visible group-data-[variant=rail]/menu-sub:h-8 group-data-[variant=rail]/menu-sub:translate-x-0 group-data-[variant=rail]/menu-sub:rounded-none group-data-[variant=rail]/menu-sub:pl-[17px] group-data-[variant=rail]/menu-sub:text-[color:var(--foreground-subtle,var(--muted-foreground))] group-data-[variant=rail]/menu-sub:before:absolute group-data-[variant=rail]/menu-sub:before:inset-y-0 group-data-[variant=rail]/menu-sub:before:-left-px group-data-[variant=rail]/menu-sub:before:w-0.5 group-data-[variant=rail]/menu-sub:before:bg-foreground group-data-[variant=rail]/menu-sub:before:opacity-0 group-data-[variant=rail]/menu-sub:hover:bg-transparent group-data-[variant=rail]/menu-sub:hover:text-foreground group-data-[variant=rail]/menu-sub:active:bg-transparent group-data-[variant=rail]/menu-sub:data-active:after:bg-transparent group-data-[variant=rail]/menu-sub:data-active:text-foreground group-data-[variant=rail]/menu-sub:data-active:before:opacity-100 [&>span:last-child]:truncate [&>svg]:size-4 [&>svg]:shrink-0 [&>svg]:text-sidebar-accent-foreground",
className
),
onClick: releasePointerFocus,
},
props
),
render,
state: {
active: isActive,
sidebar: "menu-sub-button",
size,
slot: "sidebar-menu-sub-button",
},
});
}
export {
Sidebar,
SidebarContent,
SidebarFooter,
SidebarGroup,
SidebarGroupAction,
SidebarGroupContent,
SidebarGroupLabel,
SidebarHeader,
SidebarInput,
SidebarInset,
SidebarMenu,
SidebarMenuAction,
SidebarMenuBadge,
SidebarMenuButton,
SidebarMenuItem,
SidebarMenuSkeleton,
SidebarMenuSub,
SidebarMenuSubButton,
SidebarMenuSubItem,
SidebarProvider,
SidebarRail,
SidebarSeparator,
SidebarTrigger,
useSidebar,
}; On this page