mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-28 04:02:18 +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>
419 lines
13 KiB
TypeScript
419 lines
13 KiB
TypeScript
import { useState, useRef, useEffect, useCallback } from "react";
|
|
import { cn } from "../lib/utils";
|
|
import { MarkdownBody, type MarkdownExternalReferenceMap } from "./MarkdownBody";
|
|
import { MarkdownEditor, type MarkdownEditorRef, type MentionOption } from "./MarkdownEditor";
|
|
import { useAutosaveIndicator } from "../hooks/useAutosaveIndicator";
|
|
import { FoldCurtain } from "./FoldCurtain";
|
|
|
|
interface InlineEditorProps {
|
|
value: string;
|
|
onSave: (value: string) => void | Promise<unknown>;
|
|
as?: "h1" | "h2" | "p" | "span";
|
|
className?: string;
|
|
placeholder?: string;
|
|
multiline?: boolean;
|
|
imageUploadHandler?: (file: File) => Promise<string>;
|
|
/** Called when a non-image file is dropped onto the editor. */
|
|
onDropFile?: (file: File) => Promise<void>;
|
|
mentions?: MentionOption[];
|
|
nullable?: boolean;
|
|
/** When true, long display-mode markdown is clipped with a fade curtain that expands on click. */
|
|
foldable?: boolean;
|
|
/**
|
|
* Optional host-resolved external object metadata. Forwarded to the read-mode
|
|
* `MarkdownBody` so resolved URLs render with the inline status icon prefix.
|
|
*/
|
|
externalReferences?: MarkdownExternalReferenceMap;
|
|
}
|
|
|
|
/** Shared padding so display and edit modes occupy the exact same box. */
|
|
const pad = "px-1 -mx-1";
|
|
const markdownPad = "px-1";
|
|
const AUTOSAVE_DEBOUNCE_MS = 900;
|
|
|
|
export function queueContainedBlurCommit(container: HTMLDivElement, onCommit: () => void) {
|
|
let frameId = requestAnimationFrame(() => {
|
|
frameId = requestAnimationFrame(() => {
|
|
frameId = 0;
|
|
const active = document.activeElement;
|
|
if (active instanceof Node && container.contains(active)) return;
|
|
onCommit();
|
|
});
|
|
});
|
|
|
|
return () => {
|
|
if (frameId === 0) return;
|
|
cancelAnimationFrame(frameId);
|
|
frameId = 0;
|
|
};
|
|
}
|
|
|
|
export function InlineEditor({
|
|
value,
|
|
onSave,
|
|
as: Tag = "span",
|
|
className,
|
|
placeholder = "Click to edit...",
|
|
multiline = false,
|
|
nullable = false,
|
|
imageUploadHandler,
|
|
onDropFile,
|
|
mentions,
|
|
foldable = false,
|
|
externalReferences,
|
|
}: InlineEditorProps) {
|
|
const [editing, setEditing] = useState(false);
|
|
const [multilineEditing, setMultilineEditing] = useState(false);
|
|
const [multilineFocused, setMultilineFocused] = useState(false);
|
|
const [draft, setDraft] = useState(value);
|
|
const lastPropValueRef = useRef(value);
|
|
const inputRef = useRef<HTMLTextAreaElement>(null);
|
|
const markdownRef = useRef<MarkdownEditorRef>(null);
|
|
const autosaveDebounceRef = useRef<ReturnType<typeof setTimeout> | null>(null);
|
|
const blurCommitFrameRef = useRef<(() => void) | null>(null);
|
|
const pendingFocusFrameRef = useRef<number | null>(null);
|
|
const justEnteredEditRef = useRef(false);
|
|
const hasBeenFocusedRef = useRef(false);
|
|
const {
|
|
state: autosaveState,
|
|
markDirty,
|
|
reset,
|
|
runSave,
|
|
} = useAutosaveIndicator();
|
|
|
|
useEffect(() => {
|
|
const previousValue = lastPropValueRef.current;
|
|
lastPropValueRef.current = value;
|
|
setDraft((currentDraft) => {
|
|
if (multiline && multilineFocused && currentDraft !== previousValue) {
|
|
return currentDraft;
|
|
}
|
|
return value;
|
|
});
|
|
}, [value, multiline, multilineFocused]);
|
|
|
|
useEffect(() => {
|
|
return () => {
|
|
if (autosaveDebounceRef.current) {
|
|
clearTimeout(autosaveDebounceRef.current);
|
|
}
|
|
if (blurCommitFrameRef.current !== null) {
|
|
blurCommitFrameRef.current();
|
|
blurCommitFrameRef.current = null;
|
|
}
|
|
if (pendingFocusFrameRef.current !== null) {
|
|
cancelAnimationFrame(pendingFocusFrameRef.current);
|
|
pendingFocusFrameRef.current = null;
|
|
}
|
|
};
|
|
}, []);
|
|
|
|
const autoSize = useCallback((el: HTMLTextAreaElement | null) => {
|
|
if (!el) return;
|
|
el.style.height = "auto";
|
|
el.style.height = `${el.scrollHeight}px`;
|
|
}, []);
|
|
|
|
useEffect(() => {
|
|
if (editing && inputRef.current) {
|
|
inputRef.current.focus();
|
|
inputRef.current.select();
|
|
if (inputRef.current instanceof HTMLTextAreaElement) {
|
|
autoSize(inputRef.current);
|
|
}
|
|
}
|
|
}, [editing, autoSize]);
|
|
|
|
useEffect(() => {
|
|
if (!multilineEditing || !multiline) return;
|
|
if (!justEnteredEditRef.current) return;
|
|
justEnteredEditRef.current = false;
|
|
if (pendingFocusFrameRef.current !== null) {
|
|
cancelAnimationFrame(pendingFocusFrameRef.current);
|
|
}
|
|
pendingFocusFrameRef.current = requestAnimationFrame(() => {
|
|
pendingFocusFrameRef.current = null;
|
|
markdownRef.current?.focus();
|
|
});
|
|
return () => {
|
|
if (pendingFocusFrameRef.current !== null) {
|
|
cancelAnimationFrame(pendingFocusFrameRef.current);
|
|
pendingFocusFrameRef.current = null;
|
|
}
|
|
};
|
|
}, [multilineEditing, multiline]);
|
|
|
|
// Once the editor has been focused at least once, it's blurred, and any
|
|
// autosave has settled, swap back to the MarkdownBody preview so inline
|
|
// issue refs render with status + quicklook.
|
|
useEffect(() => {
|
|
if (multilineFocused) {
|
|
hasBeenFocusedRef.current = true;
|
|
return;
|
|
}
|
|
if (!multiline || !multilineEditing) return;
|
|
if (!hasBeenFocusedRef.current) return;
|
|
if (autosaveState !== "idle") return;
|
|
hasBeenFocusedRef.current = false;
|
|
setMultilineEditing(false);
|
|
}, [multiline, multilineEditing, multilineFocused, autosaveState]);
|
|
|
|
|
|
const commit = useCallback(async (nextValue = draft) => {
|
|
const valueToSave = nextValue.trim();
|
|
const valueChanged = valueToSave !== value;
|
|
const shouldSave = nullable
|
|
? valueChanged
|
|
: Boolean(valueToSave && valueChanged);
|
|
if (shouldSave) {
|
|
await Promise.resolve(onSave(valueToSave));
|
|
} else {
|
|
setDraft(value);
|
|
}
|
|
if (!multiline) {
|
|
setEditing(false);
|
|
}
|
|
}, [draft, multiline, nullable, onSave, value]);
|
|
|
|
/** Multiline blur/submit: show autosave indicator when persisting */
|
|
const finalizeMultilineBlurOrSubmit = useCallback(() => {
|
|
const trimmed = draft.trim();
|
|
if (trimmed === value) {
|
|
reset();
|
|
void commit();
|
|
return;
|
|
}
|
|
if (!trimmed && !nullable) {
|
|
reset();
|
|
void commit();
|
|
return;
|
|
}
|
|
void runSave(() => commit());
|
|
}, [commit, draft, nullable, reset, runSave, value]);
|
|
|
|
const cancelPendingBlurCommit = useCallback(() => {
|
|
if (blurCommitFrameRef.current === null) return;
|
|
blurCommitFrameRef.current();
|
|
blurCommitFrameRef.current = null;
|
|
}, []);
|
|
|
|
const scheduleBlurCommit = useCallback((container: HTMLDivElement) => {
|
|
cancelPendingBlurCommit();
|
|
blurCommitFrameRef.current = queueContainedBlurCommit(container, () => {
|
|
blurCommitFrameRef.current = null;
|
|
if (autosaveDebounceRef.current) {
|
|
clearTimeout(autosaveDebounceRef.current);
|
|
}
|
|
setMultilineFocused(false);
|
|
finalizeMultilineBlurOrSubmit();
|
|
});
|
|
}, [cancelPendingBlurCommit, finalizeMultilineBlurOrSubmit]);
|
|
|
|
function handleKeyDown(e: React.KeyboardEvent) {
|
|
if (e.key === "Enter" && !multiline) {
|
|
e.preventDefault();
|
|
void commit();
|
|
}
|
|
if (e.key === "Escape") {
|
|
if (autosaveDebounceRef.current) {
|
|
clearTimeout(autosaveDebounceRef.current);
|
|
}
|
|
reset();
|
|
setDraft(value);
|
|
if (multiline) {
|
|
setMultilineFocused(false);
|
|
setMultilineEditing(false);
|
|
hasBeenFocusedRef.current = false;
|
|
if (document.activeElement instanceof HTMLElement) {
|
|
document.activeElement.blur();
|
|
}
|
|
} else {
|
|
setEditing(false);
|
|
}
|
|
}
|
|
}
|
|
|
|
useEffect(() => {
|
|
if (!multiline) return;
|
|
if (!multilineFocused) return;
|
|
const trimmed = draft.trim();
|
|
// Nullable: empty draft can still be a real edit (clearing); only skip debounce when unchanged or empty is invalid.
|
|
if (trimmed === value || (!trimmed && !nullable)) {
|
|
if (autosaveState !== "saved") {
|
|
reset();
|
|
}
|
|
return;
|
|
}
|
|
markDirty();
|
|
if (autosaveDebounceRef.current) {
|
|
clearTimeout(autosaveDebounceRef.current);
|
|
}
|
|
autosaveDebounceRef.current = setTimeout(() => {
|
|
void runSave(() => commit(trimmed));
|
|
}, AUTOSAVE_DEBOUNCE_MS);
|
|
|
|
return () => {
|
|
if (autosaveDebounceRef.current) {
|
|
clearTimeout(autosaveDebounceRef.current);
|
|
}
|
|
};
|
|
}, [autosaveState, commit, draft, markDirty, multiline, multilineFocused, nullable, reset, runSave, value]);
|
|
|
|
if (multiline) {
|
|
const previewValue = autosaveState === "saved" || autosaveState === "idle" ? draft : value;
|
|
const hasValue = Boolean(previewValue.trim());
|
|
const showEditor = multilineEditing || multilineFocused || !hasValue;
|
|
|
|
if (!showEditor) {
|
|
const enterEditMode = () => {
|
|
if (multilineEditing) return;
|
|
justEnteredEditRef.current = true;
|
|
setMultilineEditing(true);
|
|
};
|
|
return (
|
|
<div
|
|
className={cn(markdownPad, "rounded transition-colors hover:bg-accent/20")}
|
|
onClick={(event) => {
|
|
if (event.defaultPrevented) return;
|
|
const target = event.target as HTMLElement | null;
|
|
if (target && target.closest("a,button,[data-mention-kind],[data-radix-popper-content-wrapper]")) {
|
|
return;
|
|
}
|
|
enterEditMode();
|
|
}}
|
|
onDragEnter={() => enterEditMode()}
|
|
onKeyDown={(event) => {
|
|
if (event.key !== "Enter" && event.key !== " ") return;
|
|
event.preventDefault();
|
|
enterEditMode();
|
|
}}
|
|
role="textbox"
|
|
aria-multiline="true"
|
|
aria-label={placeholder}
|
|
tabIndex={0}
|
|
>
|
|
{foldable ? (
|
|
<FoldCurtain>
|
|
<MarkdownBody
|
|
className={cn("paperclip-edit-in-place-content", className)}
|
|
externalReferences={externalReferences}
|
|
>
|
|
{previewValue}
|
|
</MarkdownBody>
|
|
</FoldCurtain>
|
|
) : (
|
|
<MarkdownBody
|
|
className={cn("paperclip-edit-in-place-content", className)}
|
|
externalReferences={externalReferences}
|
|
>
|
|
{previewValue}
|
|
</MarkdownBody>
|
|
)}
|
|
</div>
|
|
);
|
|
}
|
|
|
|
return (
|
|
<div
|
|
className={cn(
|
|
markdownPad,
|
|
"rounded transition-colors",
|
|
multilineFocused ? "bg-transparent" : "hover:bg-accent/20",
|
|
)}
|
|
onFocusCapture={(event) => {
|
|
// Ignore focus events where the active element isn't actually inside
|
|
// the wrapper (React 19 can emit a synthetic focus after a blur).
|
|
const active = document.activeElement;
|
|
if (!(active instanceof Node) || !event.currentTarget.contains(active)) return;
|
|
cancelPendingBlurCommit();
|
|
setMultilineFocused(true);
|
|
}}
|
|
onBlurCapture={(event) => {
|
|
if (event.currentTarget.contains(event.relatedTarget as Node | null)) return;
|
|
if (pendingFocusFrameRef.current !== null) {
|
|
cancelAnimationFrame(pendingFocusFrameRef.current);
|
|
pendingFocusFrameRef.current = null;
|
|
}
|
|
scheduleBlurCommit(event.currentTarget);
|
|
}}
|
|
onKeyDown={handleKeyDown}
|
|
>
|
|
<MarkdownEditor
|
|
ref={markdownRef}
|
|
value={draft}
|
|
onChange={setDraft}
|
|
placeholder={placeholder}
|
|
bordered={false}
|
|
className="bg-transparent"
|
|
contentClassName={cn("paperclip-edit-in-place-content", className)}
|
|
imageUploadHandler={imageUploadHandler}
|
|
onDropFile={onDropFile}
|
|
mentions={mentions}
|
|
onSubmit={() => {
|
|
finalizeMultilineBlurOrSubmit();
|
|
}}
|
|
/>
|
|
<div className="flex min-h-4 items-center justify-end pr-1">
|
|
<span
|
|
className={cn(
|
|
"text-(length:--text-micro) transition-opacity duration-150",
|
|
autosaveState === "error" ? "text-destructive" : "text-muted-foreground",
|
|
autosaveState === "idle" ? "opacity-0" : "opacity-100",
|
|
)}
|
|
>
|
|
{autosaveState === "saving"
|
|
? "Autosaving..."
|
|
: autosaveState === "saved"
|
|
? "Saved"
|
|
: autosaveState === "error"
|
|
? "Could not save"
|
|
: "Idle"}
|
|
</span>
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
if (editing) {
|
|
|
|
return (
|
|
<textarea
|
|
ref={inputRef}
|
|
value={draft}
|
|
rows={1}
|
|
onChange={(e) => {
|
|
setDraft(e.target.value);
|
|
autoSize(e.target);
|
|
}}
|
|
onBlur={() => {
|
|
void commit();
|
|
}}
|
|
onKeyDown={handleKeyDown}
|
|
className={cn(
|
|
"w-full bg-transparent rounded outline-none resize-none overflow-hidden",
|
|
pad,
|
|
className
|
|
)}
|
|
/>
|
|
);
|
|
}
|
|
|
|
// Use div instead of Tag when rendering markdown to avoid invalid nesting
|
|
// (e.g. <p> cannot contain the <div>/<p> elements that markdown produces)
|
|
const DisplayTag = value && multiline ? "div" : Tag;
|
|
|
|
return (
|
|
<DisplayTag
|
|
className={cn(
|
|
"cursor-pointer rounded hover:bg-accent/50 transition-colors overflow-hidden",
|
|
pad,
|
|
!value && "text-muted-foreground italic",
|
|
className,
|
|
)}
|
|
onClick={() => setEditing(true)}
|
|
>
|
|
{value || placeholder}
|
|
</DisplayTag>
|
|
);
|
|
}
|