mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-27 19:35:13 +01: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>
221 lines
8.2 KiB
TypeScript
221 lines
8.2 KiB
TypeScript
import { forwardRef, useCallback, useEffect, useMemo, useRef, useState, type ReactNode } from "react";
|
|
import { Check } from "lucide-react";
|
|
import { Popover, PopoverContent, PopoverTrigger } from "@/components/ui/popover";
|
|
import { orderItemsBySelectedAndRecent } from "../lib/recent-selections";
|
|
import { cn } from "../lib/utils";
|
|
|
|
export interface InlineEntityOption {
|
|
id: string;
|
|
label: string;
|
|
searchText?: string;
|
|
}
|
|
|
|
interface InlineEntitySelectorProps {
|
|
value: string;
|
|
options: InlineEntityOption[];
|
|
placeholder: string;
|
|
noneLabel: string;
|
|
searchPlaceholder: string;
|
|
emptyMessage: string;
|
|
onChange: (id: string) => void;
|
|
onConfirm?: () => void;
|
|
className?: string;
|
|
renderTriggerValue?: (option: InlineEntityOption | null) => ReactNode;
|
|
renderOption?: (option: InlineEntityOption, isSelected: boolean) => ReactNode;
|
|
recentOptionIds?: string[];
|
|
/** Skip the Portal so the popover stays in the DOM tree (fixes scroll inside Dialogs). */
|
|
disablePortal?: boolean;
|
|
/** Open the popover when the trigger receives keyboard/programmatic focus. */
|
|
openOnFocus?: boolean;
|
|
}
|
|
|
|
const EMPTY_RECENT_OPTION_IDS: string[] = [];
|
|
|
|
export const InlineEntitySelector = forwardRef<HTMLButtonElement, InlineEntitySelectorProps>(
|
|
function InlineEntitySelector(
|
|
{
|
|
value,
|
|
options,
|
|
placeholder,
|
|
noneLabel,
|
|
searchPlaceholder,
|
|
emptyMessage,
|
|
onChange,
|
|
onConfirm,
|
|
className,
|
|
renderTriggerValue,
|
|
renderOption,
|
|
recentOptionIds = EMPTY_RECENT_OPTION_IDS,
|
|
disablePortal,
|
|
openOnFocus = true,
|
|
},
|
|
ref,
|
|
) {
|
|
const [open, setOpen] = useState(false);
|
|
const [query, setQuery] = useState("");
|
|
const [highlightedIndex, setHighlightedIndex] = useState(0);
|
|
const highlightedIndexRef = useRef(0);
|
|
const inputRef = useRef<HTMLInputElement>(null);
|
|
const shouldPreventCloseAutoFocusRef = useRef(false);
|
|
const isPointerDownRef = useRef(false);
|
|
|
|
const allOptions = useMemo<InlineEntityOption[]>(() => {
|
|
const baseOptions = [{ id: "", label: noneLabel, searchText: noneLabel }, ...options];
|
|
return orderItemsBySelectedAndRecent(baseOptions, value, recentOptionIds);
|
|
}, [noneLabel, options, recentOptionIds, value]);
|
|
|
|
const filteredOptions = useMemo(() => {
|
|
const term = query.trim().toLowerCase();
|
|
if (!term) return allOptions;
|
|
return allOptions.filter((option) => {
|
|
const haystack = `${option.label} ${option.searchText ?? ""}`.toLowerCase();
|
|
return haystack.includes(term);
|
|
});
|
|
}, [allOptions, query]);
|
|
|
|
const currentOption = options.find((option) => option.id === value) ?? null;
|
|
|
|
const setHighlightedIndexValue = useCallback((next: number | ((current: number) => number)) => {
|
|
const resolved = typeof next === "function" ? next(highlightedIndexRef.current) : next;
|
|
highlightedIndexRef.current = resolved;
|
|
setHighlightedIndex(resolved);
|
|
}, []);
|
|
|
|
useEffect(() => {
|
|
if (!open) return;
|
|
const selectedIndex = filteredOptions.findIndex((option) => option.id === value);
|
|
setHighlightedIndexValue(selectedIndex >= 0 ? selectedIndex : 0);
|
|
}, [filteredOptions, open, setHighlightedIndexValue, value]);
|
|
|
|
const commitSelection = (index: number, moveNext: boolean) => {
|
|
const option = filteredOptions[index] ?? filteredOptions[0];
|
|
if (option) onChange(option.id);
|
|
shouldPreventCloseAutoFocusRef.current = moveNext;
|
|
setOpen(false);
|
|
setQuery("");
|
|
if (moveNext && onConfirm) {
|
|
requestAnimationFrame(() => {
|
|
onConfirm();
|
|
});
|
|
}
|
|
};
|
|
|
|
return (
|
|
<Popover
|
|
open={open}
|
|
onOpenChange={(next) => {
|
|
setOpen(next);
|
|
if (!next) setQuery("");
|
|
}}
|
|
>
|
|
<PopoverTrigger asChild>
|
|
<button
|
|
ref={ref}
|
|
type="button"
|
|
className={cn(
|
|
"inline-flex min-w-0 items-center gap-1 rounded-md border border-border bg-muted/40 px-2 py-1 text-sm font-medium text-foreground transition-colors hover:bg-accent/50 focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring",
|
|
className,
|
|
)}
|
|
onPointerDown={() => { isPointerDownRef.current = true; }}
|
|
onFocus={() => {
|
|
if (openOnFocus && !isPointerDownRef.current) setOpen(true);
|
|
isPointerDownRef.current = false;
|
|
}}
|
|
>
|
|
{renderTriggerValue
|
|
? renderTriggerValue(currentOption)
|
|
: (currentOption?.label ?? <span className="text-muted-foreground">{placeholder}</span>)}
|
|
</button>
|
|
</PopoverTrigger>
|
|
<PopoverContent
|
|
align="start"
|
|
side="bottom"
|
|
collisionPadding={16}
|
|
className="w-(--sz-calc-6) p-1"
|
|
disablePortal={disablePortal}
|
|
onOpenAutoFocus={(event) => {
|
|
event.preventDefault();
|
|
inputRef.current?.focus();
|
|
}}
|
|
onCloseAutoFocus={(event) => {
|
|
if (!shouldPreventCloseAutoFocusRef.current) return;
|
|
event.preventDefault();
|
|
shouldPreventCloseAutoFocusRef.current = false;
|
|
}}
|
|
>
|
|
<input
|
|
ref={inputRef}
|
|
className="w-full border-b border-border bg-transparent px-2 py-1.5 text-sm outline-none placeholder:text-muted-foreground/60"
|
|
placeholder={searchPlaceholder}
|
|
value={query}
|
|
onChange={(event) => {
|
|
setQuery(event.target.value);
|
|
}}
|
|
onKeyDown={(event) => {
|
|
if (event.key === "ArrowDown") {
|
|
event.preventDefault();
|
|
event.stopPropagation();
|
|
setHighlightedIndexValue((current) =>
|
|
filteredOptions.length === 0 ? 0 : (current + 1) % filteredOptions.length,
|
|
);
|
|
return;
|
|
}
|
|
if (event.key === "ArrowUp") {
|
|
event.preventDefault();
|
|
event.stopPropagation();
|
|
setHighlightedIndexValue((current) => {
|
|
if (filteredOptions.length === 0) return 0;
|
|
return current <= 0 ? filteredOptions.length - 1 : current - 1;
|
|
});
|
|
return;
|
|
}
|
|
if (event.key === "Enter") {
|
|
event.preventDefault();
|
|
event.stopPropagation();
|
|
commitSelection(highlightedIndexRef.current, true);
|
|
return;
|
|
}
|
|
if (event.key === "Tab" && !event.shiftKey) {
|
|
event.preventDefault();
|
|
event.stopPropagation();
|
|
commitSelection(highlightedIndexRef.current, true);
|
|
return;
|
|
}
|
|
if (event.key === "Escape") {
|
|
event.preventDefault();
|
|
event.stopPropagation();
|
|
setOpen(false);
|
|
}
|
|
}}
|
|
/>
|
|
<div className="max-h-56 overflow-y-auto overscroll-contain py-1 touch-pan-y">
|
|
{filteredOptions.length === 0 ? (
|
|
<p className="px-2 py-2 text-xs text-muted-foreground">{emptyMessage}</p>
|
|
) : (
|
|
filteredOptions.map((option, index) => {
|
|
const isSelected = option.id === value;
|
|
const isHighlighted = index === highlightedIndex;
|
|
return (
|
|
<button
|
|
key={option.id || "__none__"}
|
|
type="button"
|
|
className={cn(
|
|
"flex w-full items-center gap-2 rounded px-2 py-1.5 text-left text-sm touch-manipulation",
|
|
isHighlighted && "bg-accent",
|
|
)}
|
|
onMouseEnter={() => setHighlightedIndexValue(index)}
|
|
onClick={() => commitSelection(index, true)}
|
|
>
|
|
{renderOption ? renderOption(option, isSelected) : <span className="truncate">{option.label}</span>}
|
|
<Check className={cn("ml-auto h-3.5 w-3.5 text-muted-foreground", isSelected ? "opacity-100" : "opacity-0")} />
|
|
</button>
|
|
);
|
|
})
|
|
)}
|
|
</div>
|
|
</PopoverContent>
|
|
</Popover>
|
|
);
|
|
},
|
|
);
|