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 governed by a design system (`DESIGN.md` + the token layer in `ui/src/index.css`, merged in #9134) whose first principle is "one way to say each thing" — one Card, one Badge, one nav row > - After the token extraction landed, ~35 files still hand-rolled card containers, ~45 files hand-rolled pill spans, the sidebar agents section duplicated the nav-row chrome, and the inbox and tasks lists rendered the same task rows two subtly different ways > - Each divergence is a place where a future design change (radius, hover language, status vocabulary) silently misses surfaces, defeating the "edit tokens + run checks" model the design system exists for > - This pull request converges those surfaces onto the shared primitives, codifies the radius scale as the modern multiplicative shadcn ladder, and unifies the row/hover/tree-guide language across the inbox and tasks lists — every visible delta was human-reviewed screen-by-screen against a live instance across nine feedback rounds > - The benefit is that the app's look is now steerable from single knobs (one `--radius` anchor, one Card, one Badge, one row component), and the visual regression suite covers the result (514 snapshots including a new AgentDetail page story) ## Linked Issues or Issue Description No public GitHub issue exists for this work; describing per the feature template: - **Problem**: after the design-token foundation (#9134), component-level drift remained — hand-rolled cards/pills, duplicated sidebar row chrome, and two different renderings of task rows (inbox vs tasks list) meant design changes had to be applied per-surface and frequently missed spots (e.g. status glyphs rendered 16px in the inbox but 20px in the tasks list because a slot override silently beat the component default). - **Proposed behavior**: all card-shaped containers render via `Card`, all label pills via `Badge`, sidebar rows via `SidebarNavItem`, and both task-list surfaces via one `IssueRow` configuration; the radius scale is a single multiplicative ladder anchored at `--radius: 0.5rem`. - **Alternatives considered**: converting interactive `<button>`/`<Link>` cards to `Card` divs (rejected — breaks semantics; documented inline with `design-allow` comments instead); keeping the legacy additive radius ladder (rejected in favor of the standard shadcn multiplicative mapping). ## What Changed - `Card` adoption across ~35 files (settings pages, auth/board flows, dashboards, list containers, KPI tiles); non-adoptable sites (interactive cards, `<li>` rows, class-string props, chart tooltip) carry documented `design-allow(card-pattern)` comments - `Card` gains an `interactive` prop — one quiet hover affordance for clickable cards (cursor, border darken, shadow lift, focus ring), applied to skills tiles, artifact cards, and the company selector; cards carry no resting shadow - `Badge` adoption for 113 hand-rolled pill spans across ~45 files; `PropertyChip` wraps `Badge` internally; `StatusBadge`, external-object chips, and match chips stay bespoke by documented decision (WCAG-tuned status mechanics) - Radius ladder becomes the multiplicative shadcn mapping (`sm/md/lg/xl/2xl/3xl/4xl = 0.6/0.8/1.0/1.4/1.8/2.2/2.6 × --radius`, anchor `0.5rem`); every card surface unifies on `rounded-lg`; the orphaned 8px literal token is deleted - Sidebar: agent rows render via `SidebarNavItem` (new additive props: `iconNode`, `active`, `trailing`, `liveAccessory`); live dots use `--status-agent-running`; one row rhythm and inset rounded pill highlight; right-aligned trailing badges; every labeled section is collapsible - Inbox + tasks lists unified: md status glyphs, `accent/50` rounded row hovers, vertical tree guides under parent rows (opaque underlay so dark-mode translucent borders don't stack), no horizontal dividers under expanded parents; the swipe-to-archive reveal layer shows only mid-swipe; board toggle uses the `SquareKanban` glyph - Kanban: every column carries a status-hued tint; lanes default expanded (including empty); compact mode collapses empty lanes to labeled rails (fixes a clipped, label-less empty-column state) - Storybook: new AgentDetail page story (realistic fixtures, light+dark) joins the visual suite; suite captures with `reducedMotion: 'reduce'` and the ux-lab reasoning ticker honors `prefers-reduced-motion`; a stale lexical alias in `storybook/main.ts` is fixed (build was broken since the lexical 0.46 bump) - Keyboard navigation, from live review of the unified lists: inbox navigation keys work on every tab (archive keys stay scoped to the archivable tab); keyboard-driven scrolling no longer hands the selection to whatever row lands under the stationary cursor (hover selects only after real pointer movement); the tasks list view gains the same j/k / arrows / Enter selection model as the inbox; and the `g` then `i` go-to-inbox chord works app-wide instead of only on the issue detail page - Token gates restored to 3/3 CLEAN (tokenized a post-#9134 regression in the recovery card); decisions recorded in `doc/design/DECISION-SHEET.md` and `doc/design/COMPONENT-INVENTORY.md` (investigation verdicts: FileTree vs WorkspaceFileBrowser and the four entity pickers stay separate — evidence included) ## Verification - `pnpm check:token-gates` → 3/3 CLEAN - `pnpm typecheck` → green (all packages) - `cd ui && npx vitest run` → 2106/2106 (assertions updated in lockstep where they documented superseded decisions; new tests for the global go-to-inbox chord) - `pnpm --filter @paperclipai/ui build` → exit 0 - `pnpm build-storybook` → succeeds (also fixes the lexical-alias break on master) - Visual regression: 514-snapshot Playwright suite green against the updated baseline (zero diffs from the keyboard-navigation round — those changes are purely behavioral). Note: baselines live outside git per the suite design and the baseline-manifest archive is not yet published, so CI cannot run this suite — it was run locally throughout; every visible delta was reviewed screen-by-screen in a live instance across nine review rounds. Review evidence (before/after triplets) intentionally kept out of the repo for size; available on request. - Manual: exercised dashboard, tasks (list + board), inbox, agents, skills, costs, settings, and artifact surfaces in light and dark themes ## Risks - Wide but shallow visual surface: most changes are class-string substitutions with behavior preserved (props, handlers, roles, test ids). The riskiest areas — dnd-kit card refs (React 19 ref-as-prop), inbox swipe-to-archive, and sidebar overlays — are covered by existing unit tests (all green) and were manually exercised. - Intentional visual deltas (rounded cards, tinted kanban columns, md status glyphs, unified hovers) are design decisions recorded in `doc/design/DECISION-SHEET.md`; each maps to a re-baselined snapshot set locally. - The visual suite cannot yet run in CI (unpublished baseline archive — pre-existing condition from #9134); until that lands, snapshot coverage is local-only. ## Model Used - Claude Fable 5 (`claude-fable-5`, Anthropic) via Claude Code — agentic coding with tool use (file editing, test execution, Playwright screenshot verification); extended thinking enabled. ## 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 tests locally and they pass - [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 (will confirm once CI runs) - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups (pending first review) - [x] I will address all Greptile and reviewer comments before requesting merge 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
339 lines
13 KiB
TypeScript
339 lines
13 KiB
TypeScript
import { useState } from "react";
|
|
import { useQuery } from "@tanstack/react-query";
|
|
import type { IssueWorkProduct } from "@paperclipai/shared";
|
|
import { issuesApi } from "../api/issues";
|
|
import { queryKeys } from "../lib/queryKeys";
|
|
import { MarkdownBody } from "./MarkdownBody";
|
|
import { cn } from "../lib/utils";
|
|
import {
|
|
FileText,
|
|
ExternalLink,
|
|
GitBranch,
|
|
GitCommit,
|
|
Globe,
|
|
Server,
|
|
Package,
|
|
Loader2,
|
|
ArrowLeft,
|
|
X,
|
|
CheckCircle2,
|
|
XCircle,
|
|
RotateCcw,
|
|
} from "lucide-react";
|
|
import { Button } from "@/components/ui/button";
|
|
import { Badge } from "@/components/ui/badge";
|
|
|
|
interface ArtifactsPanelProps {
|
|
taskId: string;
|
|
isAgentWorking?: boolean;
|
|
/** Open the document viewer directly to a specific doc */
|
|
openDocKey?: string | null;
|
|
openDocTitle?: string | null;
|
|
onClearOpenDoc?: () => void;
|
|
/** Approval callbacks — called from the document viewer */
|
|
onApprove?: () => void;
|
|
onReject?: () => void;
|
|
}
|
|
|
|
type FilterValue = "all" | "in_progress" | "for_review" | "completed";
|
|
|
|
const FILTERS: Array<{ label: string; value: FilterValue }> = [
|
|
{ label: "All", value: "all" },
|
|
{ label: "In Progress", value: "in_progress" },
|
|
{ label: "For Review", value: "for_review" },
|
|
{ label: "Completed", value: "completed" },
|
|
];
|
|
|
|
function matchesFilter(wp: IssueWorkProduct, filter: FilterValue): boolean {
|
|
if (filter === "all") return true;
|
|
if (filter === "in_progress") return wp.status === "active" || wp.status === "draft";
|
|
if (filter === "for_review") return wp.status === "ready_for_review";
|
|
if (filter === "completed") return wp.status === "approved" || wp.status === "merged";
|
|
return true;
|
|
}
|
|
|
|
function typeIcon(type: string) {
|
|
switch (type) {
|
|
case "document": return FileText;
|
|
case "pull_request": return GitBranch;
|
|
case "branch": return GitBranch;
|
|
case "commit": return GitCommit;
|
|
case "preview_url": return Globe;
|
|
case "runtime_service": return Server;
|
|
case "artifact": return Package;
|
|
default: return FileText;
|
|
}
|
|
}
|
|
|
|
function statusBadge(status: string) {
|
|
switch (status) {
|
|
case "active":
|
|
case "draft":
|
|
return { label: "In Progress", className: "bg-blue-500/10 text-blue-600 dark:text-blue-400" };
|
|
case "ready_for_review":
|
|
return { label: "For Review", className: "bg-amber-500/10 text-amber-600 dark:text-amber-400" };
|
|
case "approved":
|
|
case "merged":
|
|
return { label: "Completed", className: "bg-green-500/10 text-green-600 dark:text-green-400" };
|
|
case "changes_requested":
|
|
return { label: "Changes Requested", className: "bg-orange-500/10 text-orange-600 dark:text-orange-400" };
|
|
case "failed":
|
|
return { label: "Failed", className: "bg-red-500/10 text-red-600 dark:text-red-400" };
|
|
default:
|
|
return { label: status, className: "bg-muted text-muted-foreground" };
|
|
}
|
|
}
|
|
|
|
export function ArtifactsPanel({ taskId, isAgentWorking, openDocKey, openDocTitle, onClearOpenDoc, onApprove, onReject }: ArtifactsPanelProps) {
|
|
const [filter, setFilter] = useState<FilterValue>("all");
|
|
const [viewingDoc, setViewingDoc] = useState<{ key: string; title: string } | null>(null);
|
|
|
|
const { data: workProducts, isLoading } = useQuery({
|
|
queryKey: queryKeys.issues.workProducts(taskId),
|
|
queryFn: () => issuesApi.listWorkProducts(taskId),
|
|
refetchInterval: 5000,
|
|
});
|
|
|
|
// Open doc from parent (e.g. clicking plan link in chat)
|
|
const effectiveViewingDoc = openDocKey
|
|
? { key: openDocKey, title: openDocTitle ?? "Document" }
|
|
: viewingDoc;
|
|
|
|
const handleBack = () => {
|
|
setViewingDoc(null);
|
|
onClearOpenDoc?.();
|
|
};
|
|
|
|
// Find the work product for the currently viewed doc to know its status
|
|
const viewedWorkProduct = effectiveViewingDoc
|
|
? (workProducts ?? []).find((wp) => wp.title === effectiveViewingDoc.title)
|
|
: null;
|
|
|
|
const filtered = (workProducts ?? []).filter((wp) => matchesFilter(wp, filter));
|
|
|
|
// Document viewer
|
|
if (effectiveViewingDoc) {
|
|
return (
|
|
<DocumentViewer
|
|
taskId={taskId}
|
|
docKey={effectiveViewingDoc.key}
|
|
title={effectiveViewingDoc.title}
|
|
onBack={handleBack}
|
|
status={viewedWorkProduct?.status ?? null}
|
|
reviewState={viewedWorkProduct?.reviewState ?? null}
|
|
onApprove={onApprove}
|
|
onReject={onReject}
|
|
/>
|
|
);
|
|
}
|
|
|
|
return (
|
|
<div className="flex flex-col h-full" data-artifacts-panel>
|
|
<div className="px-4 py-3 border-b border-border flex items-center gap-2">
|
|
<Package className="h-4 w-4 text-muted-foreground shrink-0" />
|
|
<h3 className="text-sm font-semibold">Artifacts</h3>
|
|
</div>
|
|
|
|
{/* Filter chips */}
|
|
<div className="px-4 py-2 flex flex-wrap gap-1 border-b border-border">
|
|
{FILTERS.map((f) => (
|
|
<button
|
|
key={f.value}
|
|
className={cn(
|
|
"rounded-full px-2.5 py-0.5 text-(length:--text-micro) font-medium transition-colors",
|
|
filter === f.value
|
|
? "bg-foreground text-background"
|
|
: "text-muted-foreground hover:text-foreground hover:bg-accent/50",
|
|
)}
|
|
onClick={() => setFilter(f.value)}
|
|
>
|
|
{f.label}
|
|
</button>
|
|
))}
|
|
</div>
|
|
|
|
{/* Work products list */}
|
|
<div className="flex-1 overflow-y-auto scrollbar-auto-hide">
|
|
{isLoading ? (
|
|
<div className="flex items-center justify-center py-8 text-muted-foreground text-sm">
|
|
<Loader2 className="h-4 w-4 mr-2 animate-spin" />
|
|
Loading...
|
|
</div>
|
|
) : filtered.length === 0 ? (
|
|
<div className="px-4 py-8 text-center">
|
|
<Package className="h-8 w-8 mx-auto text-muted-foreground/40 mb-3" />
|
|
<p className="text-sm text-muted-foreground">
|
|
{workProducts?.length === 0
|
|
? "Your team's deliverables and plans will appear here as they're produced."
|
|
: "No artifacts match this filter."}
|
|
</p>
|
|
</div>
|
|
) : (
|
|
<div className="divide-y divide-border">
|
|
{filtered.map((wp) => {
|
|
const Icon = typeIcon(wp.type);
|
|
const badge = statusBadge(wp.status);
|
|
const isDraft = wp.status === "draft" || wp.status === "active";
|
|
const showGenerating = isDraft && isAgentWorking;
|
|
return (
|
|
<button
|
|
key={wp.id}
|
|
className={cn(
|
|
"w-full text-left px-4 py-3 hover:bg-accent/30 transition-colors",
|
|
showGenerating && "bg-muted/30",
|
|
)}
|
|
onClick={() => {
|
|
if (wp.type === "document") {
|
|
setViewingDoc({ key: "plan", title: wp.title });
|
|
} else if (wp.url) {
|
|
window.open(wp.url, "_blank", "noopener,noreferrer");
|
|
}
|
|
}}
|
|
>
|
|
<div className="flex items-start gap-2.5">
|
|
{showGenerating ? (
|
|
<div className="mt-0.5 shrink-0">
|
|
<span className="relative flex h-4 w-4">
|
|
<span className="animate-ping absolute inline-flex h-full w-full rounded-full bg-blue-400 opacity-75" />
|
|
<span className="relative inline-flex rounded-full h-4 w-4 bg-blue-500" />
|
|
</span>
|
|
</div>
|
|
) : (
|
|
<Icon className="h-4 w-4 mt-0.5 text-muted-foreground shrink-0" />
|
|
)}
|
|
<div className="min-w-0 flex-1">
|
|
<div className="flex items-center gap-2">
|
|
<span className="text-sm font-medium truncate">{wp.title}</span>
|
|
{wp.url && (
|
|
<ExternalLink className="h-3 w-3 text-muted-foreground shrink-0" />
|
|
)}
|
|
</div>
|
|
<div className="flex items-center gap-2 mt-1">
|
|
<span className="text-(length:--text-nano) text-muted-foreground capitalize">
|
|
{wp.type.replace(/_/g, " ")}
|
|
</span>
|
|
{showGenerating ? (
|
|
<Badge variant="ghost" className="[&>svg]:size-2.5 text-(length:--text-nano) px-1.5 bg-blue-500/10 text-blue-600 dark:text-blue-400">
|
|
<Loader2 className="h-2.5 w-2.5 animate-spin" />
|
|
Generating...
|
|
</Badge>
|
|
) : (
|
|
<Badge variant="ghost" className={cn("text-(length:--text-nano) px-1.5", badge.className)}>
|
|
{badge.label}
|
|
</Badge>
|
|
)}
|
|
</div>
|
|
{wp.summary && (
|
|
<p className="text-(length:--text-micro) text-muted-foreground mt-1 line-clamp-2">
|
|
{wp.summary}
|
|
</p>
|
|
)}
|
|
</div>
|
|
</div>
|
|
</button>
|
|
);
|
|
})}
|
|
</div>
|
|
)}
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function DocumentViewer({
|
|
taskId,
|
|
docKey,
|
|
title,
|
|
onBack,
|
|
status,
|
|
reviewState,
|
|
onApprove,
|
|
onReject,
|
|
}: {
|
|
taskId: string;
|
|
docKey: string;
|
|
title: string;
|
|
onBack: () => void;
|
|
status: string | null;
|
|
reviewState: string | null;
|
|
onApprove?: () => void;
|
|
onReject?: () => void;
|
|
}) {
|
|
const { data: doc, isLoading, error } = useQuery({
|
|
queryKey: queryKeys.issues.documents(taskId),
|
|
queryFn: () => issuesApi.getDocument(taskId, docKey),
|
|
});
|
|
|
|
const needsAction = status === "ready_for_review" || reviewState === "needs_board_review";
|
|
const isApproved = status === "approved" || reviewState === "approved";
|
|
const isRejected = status === "changes_requested" || reviewState === "changes_requested";
|
|
|
|
return (
|
|
<div className="flex flex-col h-full">
|
|
<div className="px-4 py-3 border-b border-border flex items-center gap-2">
|
|
<button onClick={onBack} className="text-muted-foreground hover:text-foreground">
|
|
<ArrowLeft className="h-4 w-4" />
|
|
</button>
|
|
<h3 className="text-sm font-semibold flex-1 truncate">{title}</h3>
|
|
<button onClick={onBack} className="text-muted-foreground hover:text-foreground">
|
|
<X className="h-4 w-4" />
|
|
</button>
|
|
</div>
|
|
<div className="flex-1 overflow-y-auto scrollbar-auto-hide p-4">
|
|
{isLoading ? (
|
|
<div className="flex items-center justify-center py-8 text-muted-foreground text-sm">
|
|
<Loader2 className="h-4 w-4 mr-2 animate-spin" />
|
|
Loading document...
|
|
</div>
|
|
) : error ? (
|
|
<p className="text-sm text-muted-foreground">Document not available yet.</p>
|
|
) : doc?.body ? (
|
|
<div className="prose prose-sm dark:prose-invert max-w-none">
|
|
<MarkdownBody>{doc.body}</MarkdownBody>
|
|
</div>
|
|
) : (
|
|
<p className="text-sm text-muted-foreground">Document is empty.</p>
|
|
)}
|
|
</div>
|
|
|
|
{/* Sticky action footer */}
|
|
{needsAction && (
|
|
<div className="border-t border-border px-4 py-3 bg-background shrink-0">
|
|
<p className="text-(length:--text-micro) text-muted-foreground mb-2">This document needs your review.</p>
|
|
<div className="flex items-center gap-3">
|
|
<Button size="lg" className="h-11 px-8 text-base font-semibold flex-1 rounded-lg bg-green-700 hover:bg-green-800 text-white border-0" onClick={onApprove}>
|
|
Approve
|
|
</Button>
|
|
<Button size="lg" className="h-11 px-8 text-base font-semibold flex-1 rounded-lg bg-red-900 hover:bg-red-950 text-white border-0" onClick={() => {
|
|
onReject?.();
|
|
onBack();
|
|
}}>
|
|
Reject
|
|
</Button>
|
|
</div>
|
|
</div>
|
|
)}
|
|
{isApproved && (
|
|
<div className="border-t border-green-500/30 bg-green-500/5 px-4 py-3 shrink-0">
|
|
<div className="flex items-center gap-2">
|
|
<CheckCircle2 className="h-4 w-4 text-green-500" />
|
|
<p className="text-(length:--text-compact) font-medium text-green-700 dark:text-green-400">
|
|
Approved — hire tasks created
|
|
</p>
|
|
</div>
|
|
</div>
|
|
)}
|
|
{isRejected && (
|
|
<div className="border-t border-orange-500/30 bg-orange-500/5 px-4 py-3 shrink-0">
|
|
<div className="flex items-center gap-2">
|
|
<XCircle className="h-4 w-4 text-orange-500" />
|
|
<p className="text-(length:--text-compact) font-medium text-orange-700 dark:text-orange-400">
|
|
Changes requested — CEO is revising
|
|
</p>
|
|
</div>
|
|
</div>
|
|
)}
|
|
</div>
|
|
);
|
|
}
|