Files
HealthLog/src/components/layout/sidebar-nav.tsx
T
Marc-André Bombeck 2e150e97cf fix(nav): stop the sidebar flashing scrollbars while it expands
The rail animates its width from w-16 to w-64, and the labels laid out
against the growing width: every row overran the nav and multi-word
labels wrapped, so the nav's overflow-y-auto painted a vertical and a
horizontal scrollbar for the length of the transition.

Lay the expanded column out at its final width from the first frame and
let the rail clip it. The final layout is unchanged; the column fills
the expanded rail exactly. A unit test pins the structure and an e2e
spec samples the nav on every frame of a real expand and collapse.
2026-10-04 15:08:42 +02:00

702 lines
26 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"use client";
import { useMemo, useState } from "react";
import {
Bell,
LogOut,
Monitor,
Moon,
MoreVertical,
PanelLeftClose,
PanelLeftOpen,
Settings,
Shield,
Sun,
} from "lucide-react";
import Link from "next/link";
import { usePathname } from "next/navigation";
import { useQueryClient } from "@tanstack/react-query";
import { AccountSwitcherMenuItems } from "@/components/layout/account-switcher-menu";
import { medicationsPrefetchIntentProps } from "@/lib/queries/prefetch-medications";
import {
isNavDestinationActive,
isSettingsUtilityDestination,
visibleNavDestinations,
visibleUtilityDestinations,
} from "@/components/layout/nav-model";
import { SHELL_HEADER_BAND } from "@/components/layout/shell-metrics";
import { cn } from "@/lib/utils";
import { Logo } from "@/components/ui/logo";
import { useAuth, useLogout } from "@/hooks/use-auth";
import { useIsMobile } from "@/hooks/use-is-mobile";
import { useNavModules } from "@/hooks/use-nav-modules";
import { useMounted } from "@/hooks/use-mounted";
import { useRecordCapabilities } from "@/hooks/use-record-capabilities";
import { useTheme } from "@/components/providers";
import { useTranslations } from "@/lib/i18n/context";
import { Avatar, AvatarFallback, AvatarImage } from "@/components/ui/avatar";
import {
Tooltip,
TooltipContent,
TooltipProvider,
TooltipTrigger,
} from "@/components/ui/tooltip";
import {
DropdownMenu,
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuSeparator,
DropdownMenuSub,
DropdownMenuSubContent,
DropdownMenuSubTrigger,
DropdownMenuTrigger,
} from "@/components/ui/dropdown-menu";
const SIDEBAR_COLLAPSED_STORAGE_KEY = "healthlog-sidebar-collapsed";
/**
* The expanded sidebar's content width: `w-64` minus the rail's 1 px
* `border-r`, so the column fills the expanded rail exactly. Applied as a
* floor while expanded, it keeps the content at its final layout during the
* width transition (see the `sidebar-column` comment in the render).
*/
export const SIDEBAR_EXPANDED_CONTENT_WIDTH = "min-w-[calc(16rem-1px)]";
/**
* The stored collapse choice: `true` / `false`, or `null` when this browser
* has none (or storage is unavailable), which lets the viewport default decide.
*/
export function readSidebarCollapsedPref(): boolean | null {
if (typeof window === "undefined") return null;
try {
const stored = localStorage.getItem(SIDEBAR_COLLAPSED_STORAGE_KEY);
return stored === null ? null : stored === "true";
} catch {
return null;
}
}
export function writeSidebarCollapsedPref(collapsed: boolean): void {
try {
localStorage.setItem(SIDEBAR_COLLAPSED_STORAGE_KEY, String(collapsed));
} catch {
// Private mode or blocked storage: the choice lasts for this page only.
}
}
function getInitials(name: string): string {
return name
.split(/[\s._-]+/)
.slice(0, 2)
.map((s) => s[0]?.toUpperCase() ?? "")
.join("");
}
/**
* The sidebar footer's name-and-avatar block.
*
* A link into the account settings normally, and a plain block while this
* browser is acting on somebody else's record. The block names the person at
* the keyboard, and `/settings/account` inside a record is either refused (an
* adult share) or the RECORD's profile card (a managed profile) — a door on
* one's own name into somebody else's settings would mislabel both. A record
* that has Settings pages reaches them through the footer Settings entry,
* which is labelled as Settings and lands where the shell opens.
*/
function FooterIdentity({
sharedRecord,
label,
children,
}: {
sharedRecord: boolean;
label: string;
children: React.ReactNode;
}) {
const className =
"flex min-w-0 flex-1 items-center gap-3 rounded-md transition-colors";
if (sharedRecord) {
return <div className={className}>{children}</div>;
}
return (
<Link
href="/settings/account"
aria-label={label}
className={`hover:bg-accent ${className}`}
>
{children}
</Link>
);
}
function SidebarUserSection({ collapsed }: { collapsed: boolean }) {
const { user } = useAuth();
const logout = useLogout();
const { theme, setTheme } = useTheme();
const { t } = useTranslations();
const avatarUrl = user?.avatarUrl ?? null;
// v1.36.0 — while this browser is acting on somebody else's record the
// account surfaces are unreachable, so the avatar stops being a door into
// them. It still names the person at the keyboard, which is exactly what a
// switched session needs it to do.
const sharedRecord = user?.accountAccess?.active != null;
if (!user) return null;
const themeIcon =
theme === "system" ? (
<Monitor className="h-4 w-4" />
) : theme === "dark" ? (
<Moon className="h-4 w-4" />
) : (
<Sun className="h-4 w-4" />
);
const identityBlock = (
<>
<Avatar className="h-9 w-9 shrink-0">
{avatarUrl && <AvatarImage src={avatarUrl} alt={user.username} />}
<AvatarFallback className="bg-primary/15 text-primary text-xs font-medium">
{getInitials(user.username)}
</AvatarFallback>
</Avatar>
<div className="min-w-0 flex-1">
<p className="truncate text-sm font-semibold">{user.username}</p>
{user.email && (
<p className="text-muted-foreground truncate text-xs">{user.email}</p>
)}
</div>
</>
);
const dropdownContent = (
<DropdownMenuContent
side="right"
align="end"
className="w-60"
sideOffset={8}
>
{/* R20 — the user header is the direct route into the account
settings. Clicking the avatar / name jumps straight to
`/settings/account` rather than making the user hunt for a
separate "Settings" entry. */}
{sharedRecord ? (
<div className="flex items-center gap-3 px-2 py-2">{identityBlock}</div>
) : (
<DropdownMenuItem asChild>
<Link
href="/settings/account"
className="flex cursor-pointer items-center gap-3 px-2 py-2"
>
{identityBlock}
</Link>
</DropdownMenuItem>
)}
<DropdownMenuSeparator />
{!sharedRecord && (
<DropdownMenuItem asChild>
<Link href="/notifications" className="cursor-pointer">
<Bell className="mr-2 h-4 w-4" />
{t("nav.notifications")}
</Link>
</DropdownMenuItem>
)}
{/* The about section lives at the end of the settings shell nav;
the avatar menu stays focused on account-level actions. */}
<DropdownMenuSub>
<DropdownMenuSubTrigger>
{themeIcon}
<span className="ml-2">{t("nav.theme")}</span>
</DropdownMenuSubTrigger>
<DropdownMenuSubContent>
<DropdownMenuItem onClick={() => setTheme("system")}>
<Monitor className="mr-2 h-4 w-4" />
{t("nav.themeSystem")}
{theme === "system" && (
<span className="text-primary ml-auto text-xs">&#10003;</span>
)}
</DropdownMenuItem>
<DropdownMenuItem onClick={() => setTheme("dark")}>
<Moon className="mr-2 h-4 w-4" />
{t("nav.themeDark")}
{theme === "dark" && (
<span className="text-primary ml-auto text-xs">&#10003;</span>
)}
</DropdownMenuItem>
<DropdownMenuItem onClick={() => setTheme("light")}>
<Sun className="mr-2 h-4 w-4" />
{t("nav.themeLight")}
{theme === "light" && (
<span className="text-primary ml-auto text-xs">&#10003;</span>
)}
</DropdownMenuItem>
</DropdownMenuSubContent>
</DropdownMenuSub>
{/* v1.36.0 — the records this account may open. Renders nothing when
nobody has shared one, so the menu is unchanged for every account
that does not use sharing. */}
<AccountSwitcherMenuItems />
<DropdownMenuSeparator />
<DropdownMenuItem
onClick={() => logout.mutate()}
className="text-destructive focus:text-destructive focus:bg-destructive/10 cursor-pointer"
>
<LogOut className="mr-2 h-4 w-4" />
{t("nav.logout")}
</DropdownMenuItem>
</DropdownMenuContent>
);
if (collapsed) {
return (
<div className="border-sidebar-border border-t p-3">
<div className="flex items-center justify-center">
<DropdownMenu>
<DropdownMenuTrigger
aria-label={t("nav.userMenu")}
className="hover:bg-accent focus-visible:ring-ring/50 shrink-0 rounded-md p-1.5 transition-colors focus:outline-none focus-visible:ring-[3px]"
>
<Avatar className="h-8 w-8">
{avatarUrl && (
<AvatarImage src={avatarUrl} alt={user.username} />
)}
<AvatarFallback className="bg-primary/15 text-primary text-xs font-medium">
{getInitials(user.username)}
</AvatarFallback>
</Avatar>
</DropdownMenuTrigger>
{dropdownContent}
</DropdownMenu>
</div>
</div>
);
}
return (
<div className="border-sidebar-border border-t p-3">
<div className="flex items-center gap-3 px-2 py-1">
{/* R20 — the avatar + name in the expanded footer routes straight
into the account settings; the kebab to the right still opens
the rest of the user menu. */}
<FooterIdentity
sharedRecord={sharedRecord}
label={t("nav.accountSettings")}
>
<Avatar className="h-8 w-8 shrink-0">
{avatarUrl && <AvatarImage src={avatarUrl} alt={user.username} />}
<AvatarFallback className="bg-primary/15 text-primary text-xs font-medium">
{getInitials(user.username)}
</AvatarFallback>
</Avatar>
<div className="min-w-0 flex-1">
<p className="truncate text-sm font-medium">{user.username}</p>
{user.email && (
<p className="text-muted-foreground truncate text-xs">
{user.email}
</p>
)}
</div>
</FooterIdentity>
<DropdownMenu>
<DropdownMenuTrigger
aria-label={t("nav.userMenu")}
className="text-muted-foreground hover:text-foreground hover:bg-accent focus-visible:ring-ring/50 shrink-0 rounded-md p-1.5 transition-colors focus:outline-none focus-visible:ring-[3px]"
>
<MoreVertical className="h-4 w-4" />
</DropdownMenuTrigger>
{dropdownContent}
</DropdownMenu>
</div>
</div>
);
}
/**
* The sidebar's collapse / expand control, drawn as a footer nav row.
*
* It sits at the bottom of the sidebar, directly above the footer entries
* (Admin, then Settings), where the pointer already is when someone reaches
* for the account utilities. Expanded, the row shows its label beside the
* icon; collapsed, the label stays in the accessibility tree only and the
* rail tooltip names the action, like every other icon in the rail. The
* `aria-label` always names what a press does next.
*/
export function SidebarCollapseToggle({
collapsed,
onToggle,
}: {
collapsed: boolean;
onToggle: () => void;
}) {
const { t } = useTranslations();
const Icon = collapsed ? PanelLeftOpen : PanelLeftClose;
const actionLabel = t(
collapsed ? "nav.expandSidebarLabel" : "nav.collapseSidebarLabel",
);
const button = (
<button
type="button"
onClick={onToggle}
aria-label={actionLabel}
aria-expanded={!collapsed}
data-slot="sidebar-collapse-toggle"
className={cn(
"text-muted-foreground hover:text-foreground hover:bg-accent focus-visible:ring-ring/50 flex w-full items-center rounded-lg text-sm font-medium transition-colors outline-none focus-visible:ring-[3px]",
collapsed ? "justify-center p-2.5" : "gap-3 px-3 py-2.5",
)}
>
<Icon aria-hidden="true" className="size-4 shrink-0" />
<span className={collapsed ? "sr-only" : undefined}>
{t(collapsed ? "nav.expandSidebar" : "nav.collapseSidebar")}
</span>
</button>
);
if (!collapsed) return button;
return (
<Tooltip>
<TooltipTrigger asChild>{button}</TooltipTrigger>
<TooltipContent side="right" sideOffset={8}>
{actionLabel}
</TooltipContent>
</Tooltip>
);
}
export function SidebarNav() {
const pathname = usePathname();
const { t } = useTranslations();
const { user } = useAuth();
const queryClient = useQueryClient();
// v1.16.7 — hover / focus intent on the medications link starts the
// list request before the navigation commits, so the due-time cells
// hydrate from a warm cache instead of serialising behind the chunk.
const medsIntent = medicationsPrefetchIntentProps(queryClient);
const isAdmin = user?.role === "ADMIN";
// Match `/admin` exactly or any `/admin/...` sub-route for active-link
// styling. Plain `startsWith("/admin")` would also flip for a
// hypothetical future `/administrative` page, which is not the same
// semantic surface. The Admin entry mirrors Settings: a single link
// with no sub-item expansion in the global sidebar — `<AdminShell>`
// renders its own per-section nav inside the page itself.
const onAdminPage = pathname === "/admin" || pathname.startsWith("/admin/");
// v1.17.1 (F-1) — the sidebar renders the one shared destination model
// (`nav-model.ts`), the same ordered list the mobile bottom-nav derives
// its "More" hub from. v1.18.0 — entries are filtered by the account's
// resolved module map (mood, cycle, labs, coach, achievements …); cycle +
// coach are delegated server-side and already reflected in that map.
// The module map rides the client-only `/api/auth/me` query, so it is not
// settled on SSR or the first client paint. Gating the filter behind
// `useMounted()` keeps SSR and first paint identical (core destinations
// only) and stops a disabled module's entry from flickering in for one
// frame before the query resolves; once mounted the real map applies.
const mounted = useMounted();
// v1.36.0 — while this browser is acting on somebody else's record, the nav
// shows only what sharing covers. The server refuses the rest regardless;
// dropping the entries spares a delegate a click that ends in a 403.
const {
inSharedRecord: sharedRecord,
sections,
recordKind,
level,
} = useRecordCapabilities();
// The sections the grant may manage, bound from the server-resolved entry.
// The Settings entry needs them: a record-content page is offered only when
// the grant manages the section its forms write.
const manageableDomains = user?.accountAccess?.active?.manageableDomains;
// The Coach entry follows the `coach` AI capability, like every other
// Coach entry point; the rest of the map is `modules` unchanged.
const navModules = useNavModules();
const visibleNavItems = useMemo(
() => visibleNavDestinations(navModules, mounted, sharedRecord, sections),
[navModules, mounted, sharedRecord, sections],
);
// Collapsed = the user's stored choice, or — with no stored choice — a
// viewport default: tablet widths (md–lg, e.g. an iPad held upright)
// fall back to the icon rail so the content column keeps its room; a
// 256 px sidebar squeezes a 768 px viewport down to a 512 px column.
// Everything is gated on `mounted` (same pattern as the module filter
// above): SSR and the hydration render both paint the expanded shell,
// the stored pref / viewport default applies on the first client render
// after hydration settles. Branching earlier — localStorage or
// matchMedia inside the initial render — is a React #418 hydration
// mismatch, because the sidebar is only CSS-hidden below `md` and still
// hydrates its DOM there.
const tabletOrBelow = useIsMobile("lg");
const [collapsedPref, setCollapsedPref] = useState<boolean | null>(
readSidebarCollapsedPref,
);
const collapsed = mounted ? (collapsedPref ?? tabletOrBelow) : false;
function toggleCollapsed() {
const next = !collapsed;
setCollapsedPref(next);
writeSidebarCollapsedPref(next);
}
// v1.17.1 (F-1 residue) — the sidebar footer utility links derive from
// the SAME shared list the mobile user menu consumes, so the two surfaces
// can no longer drift into two hand-curated utility lists. Notifications is
// surfaced in the avatar menu (not the footer), so the footer takes every
// utility entry except `/notifications`; Admin is the role-gated,
// sidebar-only surface and is inserted separately below.
//
// Under a switch the list answers for the record on screen: a Settings
// entry exactly when the Settings shell lists a section for it, pointing at
// the first one (see `visibleUtilityDestinations`).
const footerUtilityItems = useMemo(
() =>
visibleUtilityDestinations({
record: sharedRecord
? { recordKind, level, manageableDomains: manageableDomains ?? [] }
: null,
}).filter((d) => d.href !== "/notifications"),
[sharedRecord, recordKind, level, manageableDomains],
);
function isUtilityActive(href: string) {
// Settings matches the whole `/settings/*` shell; the rest match exact.
return isSettingsUtilityDestination({ href })
? pathname.startsWith("/settings")
: pathname === href;
}
function renderUtilityLink(item: {
href: string;
tKey: string;
icon: typeof Settings;
}) {
const Icon = item.icon;
const isActive = isUtilityActive(item.href);
const isSettings = isSettingsUtilityDestination(item);
const tourId = isSettingsUtilityDestination(item)
? "nav-settings"
: undefined;
if (collapsed) {
return (
<Tooltip key={item.href}>
<TooltipTrigger asChild>
<Link
href={item.href}
aria-current={isActive ? "page" : undefined}
data-tour-id={tourId}
data-slot={isSettings ? "nav-settings-link" : undefined}
className={cn(
"flex items-center justify-center rounded-lg p-2.5 transition-colors",
isActive
? "bg-primary/10 text-primary"
: "text-foreground hover:bg-accent",
)}
>
<Icon className="h-4 w-4" />
</Link>
</TooltipTrigger>
<TooltipContent side="right" sideOffset={8}>
{t(item.tKey)}
</TooltipContent>
</Tooltip>
);
}
return (
<Link
key={item.href}
href={item.href}
aria-current={isActive ? "page" : undefined}
data-tour-id={tourId}
data-slot={isSettings ? "nav-settings-link" : undefined}
className={cn(
"flex items-center gap-3 rounded-lg px-3 py-2.5 text-sm font-medium transition-colors",
isActive
? "bg-primary/10 text-primary"
: "text-foreground hover:bg-accent",
)}
>
<Icon className="h-4 w-4" />
{t(item.tKey)}
</Link>
);
}
function renderAdminLink() {
if (!isAdmin) return null;
if (collapsed) {
return (
<Tooltip>
<TooltipTrigger asChild>
<Link
href="/admin"
aria-current={onAdminPage ? "page" : undefined}
className={cn(
"flex items-center justify-center rounded-lg p-2.5 transition-colors",
onAdminPage
? "bg-primary/10 text-primary"
: "text-foreground hover:bg-accent",
)}
>
<Shield className="h-4 w-4" />
</Link>
</TooltipTrigger>
<TooltipContent side="right" sideOffset={8}>
{t("nav.admin")}
</TooltipContent>
</Tooltip>
);
}
return (
<Link
href="/admin"
aria-current={onAdminPage ? "page" : undefined}
className={cn(
"flex items-center gap-3 rounded-lg px-3 py-2.5 text-sm font-medium transition-colors",
onAdminPage
? "bg-primary/10 text-primary"
: "text-foreground hover:bg-accent",
)}
>
<Shield className="h-4 w-4" />
{t("nav.admin")}
</Link>
);
}
return (
<TooltipProvider delayDuration={0}>
<aside
aria-label={t("nav.sidebar")}
className={cn(
"bg-sidebar border-sidebar-border relative hidden h-full flex-shrink-0 overflow-hidden border-r transition-[width] duration-200 motion-reduce:transition-none md:flex md:flex-col",
collapsed ? "w-16" : "w-64",
)}
>
{/* The rail animates its width; the content does not. Expanded, this
column lays out at the final width from the first frame
(`SIDEBAR_EXPANDED_CONTENT_WIDTH`) and the rail's
`overflow-hidden` reveals it as the width grows. Laying the
labels out against the growing width instead wrapped every
multi-word label, pushed the list past the nav's height and its
rows past its width, and the nav's `overflow-y-auto` painted both
scrollbars for the length of the transition. Collapsing needs no
floor: the icon rows already fit the narrowing rail. */}
<div
data-slot="sidebar-column"
className={cn(
"flex h-full w-full flex-col",
!collapsed && SIDEBAR_EXPANDED_CONTENT_WIDTH,
)}
>
{/* Logo band. Height + bottom border come from `SHELL_HEADER_BAND`,
which the top bar reads too, so the two borders draw one
continuous line. The band owns the 4rem; the link inside
stretches with `h-full` and never restates a height. */}
<div
data-slot="sidebar-header"
className={cn(
"border-sidebar-border",
SHELL_HEADER_BAND,
collapsed ? "px-3" : "px-6",
)}
>
<Link
href="/"
className={cn(
"flex h-full items-center",
collapsed ? "justify-center px-0" : "gap-2",
)}
>
<Logo className="text-primary shrink-0" size={24} />
{!collapsed && (
<span className="text-lg font-bold tracking-tight">
HealthLog
</span>
)}
</Link>
</div>
<nav
aria-label={t("nav.mainNavigation")}
className={cn(
"flex-1 overflow-y-auto",
collapsed ? "p-1.5" : "p-3",
)}
>
<div className="space-y-1">
{visibleNavItems.map((item) => {
const isActive = isNavDestinationActive(
item.href,
pathname,
visibleNavItems,
);
const label = t(item.tKey);
if (collapsed) {
return (
<Tooltip key={item.href}>
<TooltipTrigger asChild>
<Link
href={item.href}
aria-current={isActive ? "page" : undefined}
data-tour-id={item.tourId}
{...(item.href === "/medications" ? medsIntent : {})}
className={cn(
"flex items-center justify-center rounded-lg p-2.5 transition-colors",
isActive
? "bg-primary/10 text-primary"
: "text-foreground hover:bg-accent",
)}
>
<item.icon className="h-4 w-4" />
</Link>
</TooltipTrigger>
<TooltipContent side="right" sideOffset={8}>
{label}
</TooltipContent>
</Tooltip>
);
}
return (
<Link
key={item.href}
href={item.href}
aria-current={isActive ? "page" : undefined}
data-tour-id={item.tourId}
{...(item.href === "/medications" ? medsIntent : {})}
className={cn(
"flex items-center gap-3 rounded-lg px-3 py-2.5 text-sm font-medium transition-colors",
isActive
? "bg-primary/10 text-primary"
: "text-foreground hover:bg-accent",
)}
>
<item.icon className="h-4 w-4" />
{label}
</Link>
);
})}
</div>
</nav>
{/* Bottom utility links — the shared utility tail (minus
Notifications, which lives in the avatar menu) with the
role-gated Admin entry inserted before Settings. The collapse
control heads the group, so it sits directly above Admin for an
administrator and directly above Settings for everyone else. */}
<div className={cn("space-y-1 pb-1", collapsed ? "px-1.5" : "px-3")}>
<SidebarCollapseToggle
collapsed={collapsed}
onToggle={toggleCollapsed}
/>
{footerUtilityItems
.filter((item) => !isSettingsUtilityDestination(item))
.map((item) => renderUtilityLink(item))}
{renderAdminLink()}
{footerUtilityItems
.filter((item) => isSettingsUtilityDestination(item))
.map((item) => renderUtilityLink(item))}
</div>
<SidebarUserSection collapsed={collapsed} />
</div>
</aside>
</TooltipProvider>
);
}