Files
HealthLog/src/components/charts/chart-overlay-controls.tsx
T
Marc-André Bombeck 7b6b9161c3 style(charts): grey out comparison-overlay toggle when no prior-period data exists
Marc directive 2026-05-14 — when a chart has a comparisonBaseline
selected but the prior period (lastMonth / lastYear) carries zero
overlay-able rows, the chart settings cog now shows the comparison
buttons in a visibly disabled state (opacity-50, aria-disabled, native
title tooltip, and a sub-label hint) instead of silently rendering
nothing. The 'none' button always stays enabled — it's the escape
hatch.

Plumbing:
- chart-overlay-controls.tsx: new `hasComparisonData` prop (defaults
  to true so legacy callers keep their behaviour). The popover body is
  extracted as `<ChartOverlayControlsBody>` so unit tests can render
  it without Radix's portalled popover stripping it out of the SSR
  output.
- health-chart.tsx + mood-chart.tsx: thread the already-computed
  `hasComparisonData` memo (line 768 / 457) into the controls.
- medication-compliance-chart.tsx: passes `hasComparisonData={false}`
  unconditionally because the compliance heatmap never paints a
  prior-period overlay (already documented in the existing N/A
  caption block).

Tests: 5 new cases under chart-overlay-controls.test.tsx cover the
normal / greyed / none-baseline / locale / default-prop branches.
The pre-W3f assertion suite (3 tests) keeps passing unchanged.

i18n: appended chart.overlay.controls.comparisonUnavailable to both
locales — no key restructure.
2026-05-14 13:53:42 +02:00

276 lines
9.7 KiB
TypeScript

"use client";
import { useId, type ReactElement } from "react";
import { Settings2 } from "lucide-react";
import {
DropdownMenu,
DropdownMenuContent,
DropdownMenuLabel,
DropdownMenuSeparator,
DropdownMenuTrigger,
} from "@/components/ui/dropdown-menu";
import { Switch } from "@/components/ui/switch";
import { Label } from "@/components/ui/label";
import { Button } from "@/components/ui/button";
import { useTranslations } from "@/lib/i18n/context";
import {
COMPARISON_BASELINES,
type ChartOverlayPrefs,
type ComparisonBaseline,
} from "@/lib/dashboard-layout";
/**
* v1.4.18 — per-chart overlay-controls popover.
*
* the maintainer rolled back B1a's always-on chart overlays (gradient fills,
* personal-baseline reference line, target-zone shading) and asked for
* a per-chart switch surface instead. Each dashboard chart card mounts
* one of these in its top-right corner (a settings-cog dropdown) so the
* user can flip the three overlays on or off for that chart only,
* without affecting any other chart.
*
* Three toggles, each independent:
* - showTrendIndicator — the "7-day trend" overlay (moving average +
* numeric Δ chip in the header)
* - showTrendArrow — the trend regression line + arrow direction
* hint + personal-baseline reference line. the maintainer's rule: the mean
* line only paints when a trend is being displayed, so we fold
* the baseline into this toggle.
* - showTargetRange — the target-zone shading + reference lines
* (BP healthy band, BMI healthy band, medication 80 % / 100 %
* thresholds, etc.).
*
* Default state for every toggle is OFF — clean line is the new
* default and overlays are user-opt-in.
*
* The component is controlled — the parent owns the state, a render
* happens on every change. Persistence (TanStack Query → user-pref API
* → User.dashboardWidgetsJson.chartOverlayPrefs) is wired up by the
* chart wrapper that mounts this; the controls component itself is
* pure UI.
*/
/**
* Re-export the canonical type+default from `@/lib/dashboard-layout`
* so chart-side callers can keep importing them from this module.
* Single source of truth lives in dashboard-layout (the persistence
* layer); this module is just the UI.
*/
export {
DEFAULT_CHART_OVERLAY_PREFS,
type ChartOverlayPrefs,
} from "@/lib/dashboard-layout";
export interface ChartOverlayControlsProps {
prefs: ChartOverlayPrefs;
onChange: (next: ChartOverlayPrefs) => void;
/**
* Optional CSS class for the trigger button — letting the chart
* wrapper align the cog with its title row.
*/
triggerClassName?: string;
/**
* v1.4.25 W3f — when the parent chart already knows the prior period
* carries no overlay-able rows, it threads `hasComparisonData=false`
* here so the comparison-baseline buttons render in a visibly
* disabled state (reduced opacity + `aria-disabled` + tooltip)
* instead of letting the user pick a value that paints nothing on
* the chart.
*
* Default `true` (i.e. enabled) so charts that never compute the
* flag (or compute it asynchronously) keep their existing behaviour.
*/
hasComparisonData?: boolean;
}
export function ChartOverlayControls({
prefs,
onChange,
triggerClassName,
hasComparisonData = true,
}: ChartOverlayControlsProps): ReactElement {
const { t } = useTranslations();
return (
<DropdownMenu>
<DropdownMenuTrigger asChild>
<Button
type="button"
variant="ghost"
size="sm"
className={`text-muted-foreground hover:text-foreground min-h-11 min-w-11 px-0 ${triggerClassName ?? ""}`.trim()}
aria-label={t("chart.overlay.controls.tooltip.openSettings")}
data-slot="chart-overlay-controls-trigger"
>
<Settings2 className="h-3.5 w-3.5" aria-hidden="true" />
</Button>
</DropdownMenuTrigger>
<DropdownMenuContent
align="end"
sideOffset={4}
className="w-[240px] p-3"
data-slot="chart-overlay-controls-content"
>
<ChartOverlayControlsBody
prefs={prefs}
onChange={onChange}
hasComparisonData={hasComparisonData}
/>
</DropdownMenuContent>
</DropdownMenu>
);
}
/**
* v1.4.25 W3f — the dropdown body is extracted so unit tests can render
* it without spinning up Radix's portalled popover (which is invisible
* to `renderToStaticMarkup`). Production callers always go through
* `<ChartOverlayControls>` above; the body export is purely a test
* affordance + a future hook for in-line (non-popover) renders.
*/
export interface ChartOverlayControlsBodyProps {
prefs: ChartOverlayPrefs;
onChange: (next: ChartOverlayPrefs) => void;
hasComparisonData?: boolean;
}
export function ChartOverlayControlsBody({
prefs,
onChange,
hasComparisonData = true,
}: ChartOverlayControlsBodyProps): ReactElement {
const { t } = useTranslations();
const trendIndicatorId = useId();
const trendArrowId = useId();
const targetRangeId = useId();
// v1.4.25 W3f — when the underlying prior-period series is empty for
// BOTH lastMonth and lastYear (we only know about the currently
// selected baseline), grey out the non-"none" buttons. We can only
// verify the active baseline truthfully, so the disabled state is
// gated on `comparisonBaseline !== "none" && !hasComparisonData`:
// the user has already opted in to comparing and we discovered the
// prior period is empty. From the "none" baseline we keep all
// buttons enabled so the user can still toggle in for the chart to
// re-evaluate.
const comparisonGreyOut =
prefs.comparisonBaseline !== "none" && !hasComparisonData;
const disabledTooltip = t("chart.overlay.controls.comparisonUnavailable");
const setToggle = (
key: "showTrendIndicator" | "showTrendArrow" | "showTargetRange",
value: boolean,
): void => {
onChange({ ...prefs, [key]: value });
};
const setComparisonBaseline = (value: ComparisonBaseline): void => {
onChange({ ...prefs, comparisonBaseline: value });
};
return (
<>
<DropdownMenuLabel className="text-xs font-medium tracking-wide uppercase">
{t("chart.overlay.controls.title")}
</DropdownMenuLabel>
<DropdownMenuSeparator />
<div className="flex flex-col gap-2.5 pt-1">
<div className="flex items-center justify-between gap-3">
<Label
htmlFor={trendIndicatorId}
className="cursor-pointer text-xs font-normal"
>
{t("chart.overlay.controls.trendIndicator")}
</Label>
<Switch
id={trendIndicatorId}
checked={prefs.showTrendIndicator}
onCheckedChange={(value) =>
setToggle("showTrendIndicator", Boolean(value))
}
data-slot="chart-overlay-toggle-trend-indicator"
/>
</div>
<div className="flex items-center justify-between gap-3">
<Label
htmlFor={trendArrowId}
className="cursor-pointer text-xs font-normal"
>
{t("chart.overlay.controls.trendArrow")}
</Label>
<Switch
id={trendArrowId}
checked={prefs.showTrendArrow}
onCheckedChange={(value) =>
setToggle("showTrendArrow", Boolean(value))
}
data-slot="chart-overlay-toggle-trend-arrow"
/>
</div>
<div className="flex items-center justify-between gap-3">
<Label
htmlFor={targetRangeId}
className="cursor-pointer text-xs font-normal"
>
{t("chart.overlay.controls.targetRange")}
</Label>
<Switch
id={targetRangeId}
checked={prefs.showTargetRange}
onCheckedChange={(value) =>
setToggle("showTargetRange", Boolean(value))
}
data-slot="chart-overlay-toggle-target-range"
/>
</div>
</div>
<DropdownMenuSeparator />
<div className="flex flex-col gap-1.5 pt-1">
<Label className="text-muted-foreground text-xs font-medium">
{t("chart.overlay.controls.comparisonBaseline")}
</Label>
<div
className="grid grid-cols-3 gap-1"
data-slot="chart-overlay-comparison-baseline"
data-comparison-disabled={comparisonGreyOut ? "true" : undefined}
>
{COMPARISON_BASELINES.map((value) => {
// The "none" choice never greys out — it's the safe
// escape hatch when prior data is missing.
const isNoneOption = value === "none";
const isGreyed = comparisonGreyOut && !isNoneOption;
return (
<Button
key={value}
type="button"
variant={
prefs.comparisonBaseline === value ? "default" : "outline"
}
size="sm"
className={`h-9 px-1 text-[11px] ${isGreyed ? "opacity-50" : ""}`.trim()}
onClick={() => setComparisonBaseline(value)}
aria-pressed={prefs.comparisonBaseline === value}
aria-disabled={isGreyed || undefined}
title={isGreyed ? disabledTooltip : undefined}
data-slot={`chart-overlay-comparison-${value}`}
data-comparison-greyed={isGreyed ? "true" : undefined}
>
{t(`comparison.baseline.${value}`)}
</Button>
);
})}
</div>
{comparisonGreyOut && (
<p
className="text-muted-foreground text-[10px] leading-snug"
data-slot="chart-overlay-comparison-unavailable-hint"
>
{disabledTooltip}
</p>
)}
</div>
</>
);
}