@etus/ui 0.1.0

package/src/components/navigation/Sidebar/Sidebar.tsx

@@ -0,0 +1,761 @@
+"use client"
+
+import type {
+  SidebarContentProps,
+  SidebarContextProps,
+  SidebarFooterProps,
+  SidebarGroupActionProps,
+  SidebarGroupContentProps,
+  SidebarGroupLabelProps,
+  SidebarGroupProps,
+  SidebarHeaderProps,
+  SidebarInputProps,
+  SidebarInsetProps,
+  SidebarMenuActionProps,
+  SidebarMenuBadgeProps,
+  SidebarMenuButtonProps,
+  SidebarMenuItemProps,
+  SidebarMenuProps,
+  SidebarMenuSkeletonProps,
+  SidebarMenuSubButtonProps,
+  SidebarMenuSubItemProps,
+  SidebarMenuSubProps,
+  SidebarProps,
+  SidebarProviderProps,
+  SidebarRailProps,
+  SidebarSeparatorProps,
+  SidebarTriggerProps,
+} from "./Sidebar.types"
+
+import { Slot } from "@radix-ui/react-slot"
+import { PanelLeftIcon } from "lucide-react"
+import * as React from "react"
+
+import { useIsMobile } from "../../../hooks/use-mobile"
+import { cn } from "../../../lib/utils"
+import {
+  Tooltip,
+  TooltipContent,
+  TooltipProvider,
+  TooltipTrigger,
+} from "../../feedback/Tooltip"
+import { TextInput } from "../../forms/TextInput"
+import {
+  Sheet,
+  SheetContent,
+  SheetDescription,
+  SheetHeader,
+  SheetTitle,
+} from "../../layout/Sheet"
+import { Button } from "../../primitives/Button"
+import { Divider } from "../../primitives/Divider"
+import { SkeletonLoader } from "../../primitives/SkeletonLoader"
+import {
+  sidebarContainerVariants,
+  sidebarContentVariants,
+  sidebarDesktopVariants,
+  sidebarFooterVariants,
+  sidebarGapVariants,
+  sidebarGroupActionVariants,
+  sidebarGroupContentVariants,
+  sidebarGroupLabelVariants,
+  sidebarGroupVariants,
+  sidebarHeaderVariants,
+  sidebarInnerVariants,
+  sidebarInputVariants,
+  sidebarInsetVariants,
+  sidebarMenuActionShowOnHoverVariants,
+  sidebarMenuActionVariants,
+  sidebarMenuBadgeVariants,
+  sidebarMenuButtonVariants,
+  sidebarMenuItemVariants,
+  sidebarMenuSkeletonVariants,
+  sidebarMenuSubButtonVariants,
+  sidebarMenuSubItemVariants,
+  sidebarMenuSubVariants,
+  sidebarMenuVariants,
+  sidebarMobileVariants,
+  sidebarNonCollapsibleVariants,
+  sidebarProviderVariants,
+  sidebarRailVariants,
+  sidebarSeparatorVariants,
+  sidebarTriggerVariants,
+} from "./Sidebar.variants"
+
+const SIDEBAR_COOKIE_NAME = "sidebar_state"
+const SIDEBAR_COOKIE_MAX_AGE = 60 * 60 * 24 * 7
+const SIDEBAR_WIDTH = "16rem"
+const SIDEBAR_WIDTH_MOBILE = "18rem"
+const SIDEBAR_WIDTH_ICON = "3rem"
+const SIDEBAR_KEYBOARD_SHORTCUT = "b"
+
+const SidebarContext = React.createContext<null | SidebarContextProps>(null)
+
+/**
+ * useSidebar - Hook to access sidebar context.
+ *
+ * Must be used within a SidebarProvider.
+ */
+function useSidebar() {
+  const context = React.use(SidebarContext)
+  if (!context) {
+    throw new Error("useSidebar must be used within a SidebarProvider.")
+  }
+
+  return context
+}
+
+/**
+ * SidebarProvider - Context provider for sidebar state management.
+ *
+ * Provides state for expanded/collapsed, mobile/desktop, and keyboard shortcuts.
+ *
+ * @example
+ * <SidebarProvider>
+ *   <Sidebar>...</Sidebar>
+ *   <SidebarInset>...</SidebarInset>
+ * </SidebarProvider>
+ */
+function SidebarProvider({
+  defaultOpen = true,
+  open: openProp,
+  onOpenChange: setOpenProp,
+  className,
+  style,
+  children,
+  ...props
+}: SidebarProviderProps) {
+  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 [internalOpen, setInternalOpen] = React.useState(defaultOpen)
+  const open = openProp ?? internalOpen
+  const setOpen = React.useCallback(
+    (value: ((value: boolean) => boolean) | boolean) => {
+      const openState = typeof value === "function" ? value(open) : value
+      if (setOpenProp) {
+        setOpenProp(openState)
+      } else {
+        setInternalOpen(openState)
+      }
+
+      // This sets the cookie to keep the sidebar state.
+      document.cookie = `${SIDEBAR_COOKIE_NAME}=${String(openState)}; path=/; max-age=${String(SIDEBAR_COOKIE_MAX_AGE)}`
+    },
+    [setOpenProp, open]
+  )
+
+  // Helper to toggle the sidebar.
+  const toggleSidebar = React.useCallback(() => {
+    if (isMobile) { setOpenMobile((open) => !open); } else { setOpen((open) => !open); }
+  }, [isMobile, setOpen, setOpenMobile])
+
+  // Adds a keyboard shortcut to toggle the sidebar.
+  React.useEffect(() => {
+    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])
+
+  // 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>(
+    () => ({
+      state,
+      open,
+      setOpen,
+      isMobile,
+      openMobile,
+      setOpenMobile,
+      toggleSidebar,
+    }),
+    [state, open, setOpen, isMobile, openMobile, setOpenMobile, toggleSidebar]
+  )
+
+  return (
+    <SidebarContext value={contextValue}>
+      <TooltipProvider delayDuration={0}>
+        <div
+          style={
+            {
+              "--sidebar-width": SIDEBAR_WIDTH,
+              "--sidebar-width-icon": SIDEBAR_WIDTH_ICON,
+              ...style,
+            } as React.CSSProperties
+          }
+          className={cn(sidebarProviderVariants(), className)}
+          data-slot="sidebar-wrapper"
+          {...props}
+        >
+          {children}
+        </div>
+      </TooltipProvider>
+    </SidebarContext>
+  )
+}
+
+/**
+ * Sidebar - The main sidebar component.
+ *
+ * Supports multiple variants and collapsible modes.
+ */
+function Sidebar({
+  side = "left",
+  variant = "sidebar",
+  collapsible = "offcanvas",
+  className,
+  children,
+  ...props
+}: SidebarProps) {
+  const { isMobile, state, openMobile, setOpenMobile } = useSidebar()
+
+  if (collapsible === "none") {
+    return (
+      <div
+        className={cn(sidebarNonCollapsibleVariants(), className)}
+        data-slot="sidebar"
+        {...props}
+      >
+        {children}
+      </div>
+    )
+  }
+
+  if (isMobile) {
+    return (
+      <Sheet open={openMobile} onOpenChange={setOpenMobile} {...props}>
+        <SheetContent
+          style={
+            {
+              "--sidebar-width": SIDEBAR_WIDTH_MOBILE,
+            } as React.CSSProperties
+          }
+          className={cn(sidebarMobileVariants())}
+          data-mobile="true"
+          data-sidebar="sidebar"
+          data-slot="sidebar"
+          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={cn(sidebarDesktopVariants())}
+      data-collapsible={state === "collapsed" ? collapsible : ""}
+      data-side={side}
+      data-slot="sidebar"
+      data-state={state}
+      data-variant={variant}
+    >
+      {/* This is what handles the sidebar gap on desktop */}
+      <div
+        className={cn(
+          sidebarGapVariants(),
+          variant === "floating" || variant === "inset"
+            ? "group-data-[collapsible=icon]:w-[calc(var(--sidebar-width-icon)+(--spacing(4)))]"
+            : "group-data-[collapsible=icon]:w-(--sidebar-width-icon)"
+        )}
+        data-slot="sidebar-gap"
+      />
+      <div
+        className={cn(
+          sidebarContainerVariants(),
+          side === "left"
+            ? "left-0 group-data-[collapsible=offcanvas]:left-[calc(var(--sidebar-width)*-1)]"
+            : "right-0 group-data-[collapsible=offcanvas]:right-[calc(var(--sidebar-width)*-1)]",
+          // 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
+        )}
+        data-slot="sidebar-container"
+        {...props}
+      >
+        <div
+          className={cn(sidebarInnerVariants())}
+          data-sidebar="sidebar"
+          data-slot="sidebar-inner"
+        >
+          {children}
+        </div>
+      </div>
+    </div>
+  )
+}
+
+/**
+ * SidebarTrigger - Button to toggle the sidebar.
+ */
+function SidebarTrigger({
+  className,
+  onClick,
+  ...props
+}: SidebarTriggerProps) {
+  const { toggleSidebar } = useSidebar()
+
+  return (
+    <Button
+      className={cn(sidebarTriggerVariants(), className)}
+      data-sidebar="trigger"
+      data-slot="sidebar-trigger"
+      size="icon"
+      variant="ghost"
+      onClick={(event, payload) => {
+        onClick?.(event, payload)
+        toggleSidebar()
+      }}
+      {...props}
+    >
+      <PanelLeftIcon />
+      <span className="sr-only">Toggle Sidebar</span>
+    </Button>
+  )
+}
+
+/**
+ * SidebarRail - Clickable edge to toggle sidebar.
+ */
+function SidebarRail({ className, ...props }: SidebarRailProps) {
+  const { toggleSidebar } = useSidebar()
+
+  return (
+    <button
+      aria-label="Toggle Sidebar"
+      className={cn(sidebarRailVariants(), className)}
+      data-sidebar="rail"
+      data-slot="sidebar-rail"
+      tabIndex={-1}
+      title="Toggle Sidebar"
+      onClick={toggleSidebar}
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarInset - Main content area adjacent to sidebar.
+ */
+function SidebarInset({ className, ...props }: SidebarInsetProps) {
+  return (
+    <main
+      className={cn(sidebarInsetVariants(), className)}
+      data-slot="sidebar-inset"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarInput - Input field styled for sidebar.
+ */
+function SidebarInput({
+  className,
+  ...props
+}: SidebarInputProps) {
+  return (
+    <TextInput
+      className={cn(sidebarInputVariants(), className)}
+      data-sidebar="input"
+      data-slot="sidebar-input"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarHeader - Header section of the sidebar.
+ */
+function SidebarHeader({ className, ...props }: SidebarHeaderProps) {
+  return (
+    <div
+      className={cn(sidebarHeaderVariants(), className)}
+      data-sidebar="header"
+      data-slot="sidebar-header"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarFooter - Footer section of the sidebar.
+ */
+function SidebarFooter({ className, ...props }: SidebarFooterProps) {
+  return (
+    <div
+      className={cn(sidebarFooterVariants(), className)}
+      data-sidebar="footer"
+      data-slot="sidebar-footer"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarSeparator - Divider for sidebar sections.
+ */
+function SidebarSeparator({
+  className,
+  ...props
+}: SidebarSeparatorProps) {
+  return (
+    <Divider
+      className={cn(sidebarSeparatorVariants(), className)}
+      data-sidebar="separator"
+      data-slot="sidebar-separator"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarContent - Main scrollable content area.
+ */
+function SidebarContent({ className, ...props }: SidebarContentProps) {
+  return (
+    <div
+      className={cn(sidebarContentVariants(), className)}
+      data-sidebar="content"
+      data-slot="sidebar-content"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarGroup - Group container for sidebar items.
+ */
+function SidebarGroup({ className, ...props }: SidebarGroupProps) {
+  return (
+    <div
+      className={cn(sidebarGroupVariants(), className)}
+      data-sidebar="group"
+      data-slot="sidebar-group"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarGroupLabel - Label for a sidebar group.
+ */
+function SidebarGroupLabel({
+  className,
+  asChild = false,
+  ...props
+}: SidebarGroupLabelProps) {
+  const Comp = asChild ? Slot : "div"
+
+  return (
+    <Comp
+      className={cn(sidebarGroupLabelVariants(), className)}
+      data-sidebar="group-label"
+      data-slot="sidebar-group-label"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarGroupAction - Action button for a sidebar group.
+ */
+function SidebarGroupAction({
+  className,
+  asChild = false,
+  ...props
+}: SidebarGroupActionProps) {
+  const Comp = asChild ? Slot : "button"
+
+  return (
+    <Comp
+      className={cn(sidebarGroupActionVariants(), className)}
+      data-sidebar="group-action"
+      data-slot="sidebar-group-action"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarGroupContent - Content container for a sidebar group.
+ */
+function SidebarGroupContent({
+  className,
+  ...props
+}: SidebarGroupContentProps) {
+  return (
+    <div
+      className={cn(sidebarGroupContentVariants(), className)}
+      data-sidebar="group-content"
+      data-slot="sidebar-group-content"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarMenu - Menu list container.
+ */
+function SidebarMenu({ className, ...props }: SidebarMenuProps) {
+  return (
+    <ul
+      className={cn(sidebarMenuVariants(), className)}
+      data-sidebar="menu"
+      data-slot="sidebar-menu"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarMenuItem - Individual menu item.
+ */
+function SidebarMenuItem({ className, ...props }: SidebarMenuItemProps) {
+  return (
+    <li
+      className={cn(sidebarMenuItemVariants(), className)}
+      data-sidebar="menu-item"
+      data-slot="sidebar-menu-item"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarMenuButton - Interactive menu button with variants.
+ */
+function SidebarMenuButton({
+  asChild = false,
+  isActive = false,
+  variant = "default",
+  size = "default",
+  tooltip,
+  className,
+  ...props
+}: SidebarMenuButtonProps) {
+  const Comp = asChild ? Slot : "button"
+  const { isMobile, state } = useSidebar()
+
+  const button = (
+    <Comp
+      className={cn(sidebarMenuButtonVariants({ variant, size }), className)}
+      data-active={isActive}
+      data-sidebar="menu-button"
+      data-size={size}
+      data-slot="sidebar-menu-button"
+      {...props}
+    />
+  )
+
+  if (!tooltip) {
+    return button
+  }
+
+  if (typeof tooltip === "string") {
+    tooltip = {
+      children: tooltip,
+    }
+  }
+
+  return (
+    <Tooltip>
+      <TooltipTrigger asChild>{button}</TooltipTrigger>
+      <TooltipContent
+        align="center"
+        hidden={state !== "collapsed" || isMobile}
+        side="right"
+        {...tooltip}
+      />
+    </Tooltip>
+  )
+}
+
+/**
+ * SidebarMenuAction - Action button within a menu item.
+ */
+function SidebarMenuAction({
+  className,
+  asChild = false,
+  showOnHover = false,
+  ...props
+}: SidebarMenuActionProps) {
+  const Comp = asChild ? Slot : "button"
+
+  return (
+    <Comp
+      className={cn(
+        sidebarMenuActionVariants(),
+        showOnHover && sidebarMenuActionShowOnHoverVariants(),
+        className
+      )}
+      data-sidebar="menu-action"
+      data-slot="sidebar-menu-action"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarMenuBadge - Badge displayed in a menu item.
+ */
+function SidebarMenuBadge({
+  className,
+  ...props
+}: SidebarMenuBadgeProps) {
+  return (
+    <div
+      className={cn(sidebarMenuBadgeVariants(), className)}
+      data-sidebar="menu-badge"
+      data-slot="sidebar-menu-badge"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarMenuSkeleton - Loading skeleton for menu items.
+ */
+function SidebarMenuSkeleton({
+  className,
+  showIcon = false,
+  ...props
+}: SidebarMenuSkeletonProps) {
+  const skeletonId = React.useId()
+  // Deterministic width between 50 to 90% based on component id.
+  const width = React.useMemo(() => {
+    let hash = 0
+    for (let i = 0; i < skeletonId.length; i += 1) {
+      hash = Math.trunc(hash * 31 + skeletonId.charCodeAt(i))
+    }
+    const normalized = Math.abs(hash) % 41 + 50
+    return `${String(normalized)}%`
+  }, [skeletonId])
+
+  return (
+    <div
+      className={cn(sidebarMenuSkeletonVariants(), className)}
+      data-sidebar="menu-skeleton"
+      data-slot="sidebar-menu-skeleton"
+      {...props}
+    >
+      {showIcon && (
+        <SkeletonLoader
+          className="size-4 rounded-md"
+          data-sidebar="menu-skeleton-icon"
+        />
+      )}
+      <SkeletonLoader
+        style={
+          {
+            "--skeleton-width": width,
+          } as React.CSSProperties
+        }
+        className="h-4 max-w-(--skeleton-width) flex-1"
+        data-sidebar="menu-skeleton-text"
+      />
+    </div>
+  )
+}
+
+/**
+ * SidebarMenuSub - Submenu container.
+ */
+function SidebarMenuSub({ className, ...props }: SidebarMenuSubProps) {
+  return (
+    <ul
+      className={cn(sidebarMenuSubVariants(), className)}
+      data-sidebar="menu-sub"
+      data-slot="sidebar-menu-sub"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarMenuSubItem - Individual submenu item.
+ */
+function SidebarMenuSubItem({
+  className,
+  ...props
+}: SidebarMenuSubItemProps) {
+  return (
+    <li
+      className={cn(sidebarMenuSubItemVariants(), className)}
+      data-sidebar="menu-sub-item"
+      data-slot="sidebar-menu-sub-item"
+      {...props}
+    />
+  )
+}
+
+/**
+ * SidebarMenuSubButton - Interactive button within a submenu.
+ */
+function SidebarMenuSubButton({
+  asChild = false,
+  size = "md",
+  isActive = false,
+  className,
+  ...props
+}: SidebarMenuSubButtonProps) {
+  const Comp = asChild ? Slot : "a"
+
+  return (
+    <Comp
+      className={cn(sidebarMenuSubButtonVariants({ size }), className)}
+      data-active={isActive}
+      data-sidebar="menu-sub-button"
+      data-size={size}
+      data-slot="sidebar-menu-sub-button"
+      {...props}
+    />
+  )
+}
+
+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,
+}