mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-15 03:51:22 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Its UI is the operator's daily surface: task lists, boards, budgets, agent status — all built on shadcn components and Tailwind > - Visual values (colors, spacing, type sizes, radii) were hardcoded at ~1,600 call sites: the same "small gray label" was 9/10/11px depending on the file, charts disagreed with chips about status colors, two toggle-switch implementations coexisted in two greens, and there was no visual regression coverage > - This made the UI drift-prone and made any restyle a hundreds-of-files project, which discourages design iteration > - This pull request extracts visual values into a single token layer in `ui/src/index.css`, adds a Storybook visual regression suite backed by external immutable baseline archives, and then applies a deliberate retune reviewed change-by-change on screenshot diffs > - The benefit is that Paperclip's look becomes a config surface: retheming is a token edit reviewed as a snapshot diff, drift is blocked by a token gate, and future UI PRs can prove exactly what changed visually without committing hundreds of PNGs ## Linked Issues or Issue Description No existing public issue covers this work (searched "design tokens", "visual regression", "design system" across issues and PRs). Related in spirit: Refs #8982 (theming a hardcoded panel — a one-off instance of the same problem class this PR addresses systematically). **Problem (feature-request form):** UI visual values are hardcoded per call site with no source of truth and no regression coverage; consistency depends on reviewer memory, and restyling requires mass file edits. **Proposed solution (this PR):** a single token layer + enforcement gate + externally stored visual snapshot suite, then an intentional restyle on top of that foundation. ## What Changed - **Token extraction (zero visual change, machine-verified during development):** committed codemods (`scripts/codemod-*.mjs`) moved ~1,600 hardcoded color/type/spacing/radius/shadow/misc values into named tokens in a non-inline `:root` block of `ui/src/index.css`. - **Visual regression suite:** `pnpm test:storybook-visual` covers 255 stories × light/dark = 510 Playwright screenshots at `maxDiffPixels: 0`, plus new primitive-coverage stories and deterministic-render fixes. - **External visual baselines:** committed PNG snapshots were removed. `tests/storybook-visual/baseline-manifest.json` pins an immutable archive URL/hash/size/count, and `scripts/storybook-visual-baseline.mjs` handles `download`, `verify`, `pack`, and trusted maintainer `upload` flows. - **Opt-in visual CI artifacts:** added a `Storybook Visual` workflow that runs on manual dispatch or PRs labeled `storybook-visual`, downloads/verifies the baseline, runs Playwright, and uploads Playwright report/test-result artifacts for review. Normal PR runs do not mutate baseline objects. - **Token gate:** `pnpm check:token-gates` — zero hex literals, zero arbitrary bracket values, zero raw font-sizes in `ui/src/components/**` and `ui/src/pages/**`, with a documented inline allowlist for legitimate opt-outs. - **Theme retune (intentional, snapshot-reviewed):** new base theme values; radius ladder derived from a single `--radius` knob; micro-type cluster collapsed to a named ladder (`--text-nano/micro/compact` + Tailwind `text-xs`/`text-sm`); letter-spacing collapsed to named steps. - **One status-color vocabulary:** charts, quota/budget bar fills, RUNNING/live chips, and liveness indicators all use the canonical `--status-*` hues. Light-mode legibility fixes for red alert surfaces that used dark-tuned text classes. - **One switch:** `ToggleSwitch` restyled to the registry capsule form, second hand-rolled implementation removed, and all call sites unified. - **Docs:** `DESIGN.md` is the design contract; `doc/design/` holds audit reports, decision logs, and updated guidance for external baseline review/update workflows. - Dead code removed (`agentStatusBadge` duplicate map), byte-identical contrast constants consolidated, semantic renames (`--project-seed`/`--project-none`, `--liveness-blue`). ## Verification - `pnpm check:token-gates` — 3/3 gates CLEAN during the design-system run - `pnpm typecheck` && `pnpm --filter @paperclipai/ui build` — green during the design-system run - `node --test scripts/__tests__/storybook-visual-baseline.test.mjs` — pass after external-baseline rework - `pnpm exec tsc --noEmit --pretty false --module NodeNext --moduleResolution NodeNext --target ES2022 --types node,@playwright/test tests/storybook-visual/playwright.config.ts tests/storybook-visual/storybook-visual.spec.ts` — pass after external-baseline rework - `git diff --check origin/pr/9134..HEAD` — pass after external-baseline rework - `find tests/storybook-visual -type f -name '*.png' -print | wc -l` — `0` - `node scripts/storybook-visual-baseline.mjs verify` — intentionally fails closed until the first trusted maintainer publishes the baseline archive and updates `baseline-manifest.json` ## Risks - **Large but shallow:** the PR still touches many UI files due to mechanical token extraction and retune work, but committed PNG snapshot churn has been removed from the branch. - **Baseline publication required before the visual suite can pass in clean clones:** the manifest currently has placeholder archive metadata. A trusted maintainer must publish the first immutable archive, then update `baseline-manifest.json`. - **Rendering platform variance:** the external baseline should be captured in the documented Linux/Chromium environment. Future CI runs verify against the pinned archive and fail closed on checksum/count mismatch. - **Visual CI is opt-in while stabilizing:** add the `storybook-visual` label or dispatch the workflow manually to produce downloadable Playwright report/test-result artifacts. - **Scheduled follow-ups, deliberately out of scope:** Tailwind palette classes map to semantic tokens in a dedicated pass; card/pill component consolidation; ESLint ratchet. Tracked in `doc/design/DECISION-SHEET.md`. ## Model Used Claude Fable 5 (Anthropic, `claude-fable-5`, Mythos-class tier) with extended thinking, running in Claude Code with tool use; mechanical phases delegated to Claude Sonnet subagents. Follow-up external-baseline rework assisted by OpenAI Codex (`gpt-5` coding agent with repository, terminal, and GitHub tool use). All bulk rewrites executed via deterministic, idempotent scripts committed in `scripts/`; intentional visual changes were human-reviewed on screenshot contact sheets. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run targeted local verification and documented the intentional baseline-publication failure above - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [ ] All Paperclip CI gates are green *(pending new CI run after this rework)* - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups *(pending review)* - [x] I will address all Greptile and reviewer comments before requesting merge 🤖 Generated with [Claude Code](https://claude.com/claude-code) and OpenAI Codex --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Co-authored-by: Dotta <bippadotta@protonmail.com> Co-authored-by: Paperclip <noreply@paperclip.ing>
183 lines
6.4 KiB
TypeScript
183 lines
6.4 KiB
TypeScript
import { useCallback, useEffect, useRef, useState } from "react";
|
|
import { Dialog as DialogPrimitive } from "radix-ui";
|
|
import { ChevronLeft, ChevronRight, Download, X } from "lucide-react";
|
|
import { attachmentDownloadPath, attachmentFilename } from "@/lib/issue-attachments";
|
|
import { isVideoLikeOutput } from "@/lib/issue-output";
|
|
|
|
export interface GalleryMediaItem {
|
|
id: string;
|
|
contentPath: string;
|
|
openPath?: string;
|
|
downloadPath?: string;
|
|
contentType: string;
|
|
originalFilename: string | null;
|
|
}
|
|
|
|
interface ImageGalleryModalProps {
|
|
items: GalleryMediaItem[];
|
|
initialIndex: number;
|
|
open: boolean;
|
|
onOpenChange: (open: boolean) => void;
|
|
}
|
|
|
|
export function ImageGalleryModal({
|
|
items,
|
|
initialIndex,
|
|
open,
|
|
onOpenChange,
|
|
}: ImageGalleryModalProps) {
|
|
const [currentIndex, setCurrentIndex] = useState(initialIndex);
|
|
const mediaRef = useRef<HTMLImageElement | HTMLVideoElement | null>(null);
|
|
const setMediaRef = useCallback((node: HTMLImageElement | HTMLVideoElement | null) => {
|
|
mediaRef.current = node;
|
|
}, []);
|
|
|
|
useEffect(() => {
|
|
if (open) setCurrentIndex(initialIndex);
|
|
}, [open, initialIndex]);
|
|
|
|
const goNext = useCallback(() => {
|
|
setCurrentIndex((i) => (i + 1) % items.length);
|
|
}, [items.length]);
|
|
|
|
const goPrev = useCallback(() => {
|
|
setCurrentIndex((i) => (i - 1 + items.length) % items.length);
|
|
}, [items.length]);
|
|
|
|
useEffect(() => {
|
|
if (currentIndex < items.length) return;
|
|
setCurrentIndex(0);
|
|
}, [currentIndex, items.length]);
|
|
|
|
useEffect(() => {
|
|
if (!open) return;
|
|
const handler = (e: KeyboardEvent) => {
|
|
if (e.key === "ArrowRight") goNext();
|
|
else if (e.key === "ArrowLeft") goPrev();
|
|
else if (e.key === "Escape") onOpenChange(false);
|
|
};
|
|
window.addEventListener("keydown", handler);
|
|
return () => window.removeEventListener("keydown", handler);
|
|
}, [open, goNext, goPrev, onOpenChange]);
|
|
|
|
/** Close when clicking empty curtain space (not interactive elements or the image) */
|
|
const handleBackdropClick = useCallback(
|
|
(e: React.MouseEvent) => {
|
|
const target = e.target as HTMLElement;
|
|
if (
|
|
target.closest("button") ||
|
|
target.closest("a") ||
|
|
target === mediaRef.current
|
|
)
|
|
return;
|
|
onOpenChange(false);
|
|
},
|
|
[onOpenChange],
|
|
);
|
|
|
|
if (items.length === 0) return null;
|
|
|
|
const current = items[currentIndex];
|
|
if (!current) return null;
|
|
const filename = attachmentFilename(current);
|
|
const isVideo = isVideoLikeOutput(current.contentType, current.originalFilename);
|
|
|
|
return (
|
|
<DialogPrimitive.Root open={open} onOpenChange={onOpenChange}>
|
|
<DialogPrimitive.Portal>
|
|
{/* Full-screen curtain */}
|
|
<DialogPrimitive.Overlay className="fixed inset-0 z-50 bg-black/90 data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 duration-200" />
|
|
<DialogPrimitive.Content
|
|
className="fixed inset-0 z-50 flex flex-col outline-none data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 duration-200"
|
|
onClick={handleBackdropClick}
|
|
>
|
|
{/* Top bar */}
|
|
<div className="flex items-center justify-between px-5 py-3 text-white/80 text-sm shrink-0">
|
|
<span className="truncate max-w-(--pct-50) font-medium" title={filename}>
|
|
{filename}
|
|
</span>
|
|
<div className="flex items-center gap-4">
|
|
<span className="text-white/40 tabular-nums text-xs">
|
|
{currentIndex + 1} / {items.length}
|
|
</span>
|
|
<a
|
|
href={attachmentDownloadPath(current)}
|
|
download={filename}
|
|
className="text-white/50 hover:text-white transition-colors"
|
|
title="Download"
|
|
aria-label={`Download ${filename}`}
|
|
onClick={(e) => e.stopPropagation()}
|
|
>
|
|
<Download className="h-4.5 w-4.5" />
|
|
</a>
|
|
<button
|
|
type="button"
|
|
onClick={() => onOpenChange(false)}
|
|
className="text-white/50 hover:text-white transition-colors"
|
|
title="Close"
|
|
>
|
|
<X className="h-5 w-5" />
|
|
</button>
|
|
</div>
|
|
</div>
|
|
|
|
{/* Main area: nav buttons outside image */}
|
|
<div className="flex-1 flex items-center min-h-0">
|
|
{/* Left nav zone */}
|
|
<div className="w-16 md:w-24 shrink-0 flex items-center justify-center h-full">
|
|
{items.length > 1 && (
|
|
<button
|
|
type="button"
|
|
onClick={goPrev}
|
|
className="rounded-full bg-white/10 p-3 text-white/60 hover:text-white hover:bg-white/20 transition-colors"
|
|
title="Previous"
|
|
>
|
|
<ChevronLeft className="h-7 w-7" />
|
|
</button>
|
|
)}
|
|
</div>
|
|
|
|
{/* Media */}
|
|
<div className="flex-1 flex items-center justify-center min-w-0 min-h-0 h-full px-2">
|
|
{isVideo ? (
|
|
<video
|
|
ref={setMediaRef}
|
|
src={current.contentPath}
|
|
className="max-w-full max-h-full rounded-lg"
|
|
controls
|
|
playsInline
|
|
/>
|
|
) : (
|
|
<img
|
|
ref={setMediaRef}
|
|
src={current.contentPath}
|
|
alt={filename}
|
|
className="max-w-full max-h-full object-contain select-none rounded-lg"
|
|
draggable={false}
|
|
/>
|
|
)}
|
|
</div>
|
|
|
|
{/* Right nav zone */}
|
|
<div className="w-16 md:w-24 shrink-0 flex items-center justify-center h-full">
|
|
{items.length > 1 && (
|
|
<button
|
|
type="button"
|
|
onClick={goNext}
|
|
className="rounded-full bg-white/10 p-3 text-white/60 hover:text-white hover:bg-white/20 transition-colors"
|
|
title="Next"
|
|
>
|
|
<ChevronRight className="h-7 w-7" />
|
|
</button>
|
|
)}
|
|
</div>
|
|
</div>
|
|
|
|
{/* Bottom padding for balance */}
|
|
<div className="h-6 shrink-0" />
|
|
</DialogPrimitive.Content>
|
|
</DialogPrimitive.Portal>
|
|
</DialogPrimitive.Root>
|
|
);
|
|
}
|