mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-12 18:06:11 +02: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>
216 lines
7.4 KiB
TypeScript
216 lines
7.4 KiB
TypeScript
import type { IssueRelatedWorkItem, IssueRelatedWorkSummary } from "@paperclipai/shared";
|
||
import { IssueReferencePill } from "./IssueReferencePill";
|
||
import { ExternalObjectPill } from "./ExternalObjectPill";
|
||
import type { IssueExternalObjectGroup } from "../hooks/useIssueExternalObjects";
|
||
import { externalObjectToneSeverity } from "../lib/external-objects";
|
||
import { Badge } from "@/components/ui/badge";
|
||
|
||
type GroupedSource = {
|
||
label: string;
|
||
count: number;
|
||
sampleMatchedText: string | null;
|
||
};
|
||
|
||
function groupSourcesByLabel(sources: IssueRelatedWorkItem["sources"]): GroupedSource[] {
|
||
const groups = new Map<string, GroupedSource>();
|
||
for (const source of sources) {
|
||
const existing = groups.get(source.label);
|
||
if (existing) {
|
||
existing.count += 1;
|
||
} else {
|
||
groups.set(source.label, {
|
||
label: source.label,
|
||
count: 1,
|
||
sampleMatchedText: source.matchedText ?? null,
|
||
});
|
||
}
|
||
}
|
||
return Array.from(groups.values());
|
||
}
|
||
|
||
function Section({
|
||
title,
|
||
description,
|
||
items,
|
||
emptyLabel,
|
||
}: {
|
||
title: string;
|
||
description: string;
|
||
items: IssueRelatedWorkItem[];
|
||
emptyLabel: string;
|
||
}) {
|
||
return (
|
||
<section className="space-y-3 rounded-lg border border-border p-3">
|
||
<div className="space-y-1">
|
||
<h3 className="text-sm font-semibold">{title}</h3>
|
||
<p className="text-xs text-muted-foreground">{description}</p>
|
||
</div>
|
||
|
||
{items.length === 0 ? (
|
||
<p className="text-xs text-muted-foreground">{emptyLabel}</p>
|
||
) : (
|
||
<ul className="-mx-1 flex flex-col">
|
||
{items.map((item) => {
|
||
const groupedSources = groupSourcesByLabel(item.sources);
|
||
const showTitle = item.issue.identifier !== item.issue.title;
|
||
return (
|
||
<li
|
||
key={item.issue.id}
|
||
className="flex flex-wrap items-center gap-x-2 gap-y-1.5 rounded-md px-1 py-1.5 hover:bg-accent/40"
|
||
>
|
||
<IssueReferencePill issue={item.issue} />
|
||
{showTitle ? (
|
||
<span className="min-w-0 flex-1 truncate text-sm text-muted-foreground">
|
||
{item.issue.title}
|
||
</span>
|
||
) : null}
|
||
<div className="flex flex-wrap items-center gap-1.5">
|
||
{groupedSources.map((group) => (
|
||
<Badge variant="outline"
|
||
key={`${item.issue.id}:${group.label}`}
|
||
className="border-border bg-muted/40 text-muted-foreground"
|
||
title={group.sampleMatchedText ?? undefined}
|
||
>
|
||
<span>{group.label}</span>
|
||
{group.count > 1 ? (
|
||
<span className="tabular-nums text-(length:--text-nano) font-medium opacity-80">×{group.count}</span>
|
||
) : null}
|
||
</Badge>
|
||
))}
|
||
</div>
|
||
</li>
|
||
);
|
||
})}
|
||
</ul>
|
||
)}
|
||
</section>
|
||
);
|
||
}
|
||
|
||
function ExternalObjectsSection({
|
||
groups,
|
||
isLoading,
|
||
isError,
|
||
onRetry,
|
||
}: {
|
||
groups: IssueExternalObjectGroup[];
|
||
isLoading: boolean;
|
||
isError: boolean;
|
||
onRetry?: () => void;
|
||
}) {
|
||
// Severity-first sort with most-recently-changed as the secondary sort.
|
||
const sorted = [...groups].sort((a, b) => {
|
||
const aTone = externalObjectToneSeverity(a.pill.statusCategory ? a.group.object?.statusTone ?? null : null);
|
||
const bTone = externalObjectToneSeverity(b.pill.statusCategory ? b.group.object?.statusTone ?? null : null);
|
||
if (aTone !== bTone) return bTone - aTone;
|
||
const aChanged = a.group.object?.lastChangedAt ?? a.group.object?.lastResolvedAt ?? "";
|
||
const bChanged = b.group.object?.lastChangedAt ?? b.group.object?.lastResolvedAt ?? "";
|
||
return aChanged < bChanged ? 1 : aChanged > bChanged ? -1 : 0;
|
||
});
|
||
|
||
return (
|
||
<section className="space-y-3 rounded-lg border border-border p-3">
|
||
<div className="space-y-1">
|
||
<h3 className="text-sm font-semibold">External objects</h3>
|
||
<p className="text-xs text-muted-foreground">
|
||
Remote work referenced from this issue — pull requests, deployments, tickets in other systems, and more.
|
||
</p>
|
||
</div>
|
||
|
||
{isError ? (
|
||
<p className="text-xs text-muted-foreground">
|
||
Couldn't load external objects.{" "}
|
||
{onRetry ? (
|
||
<button
|
||
type="button"
|
||
onClick={onRetry}
|
||
className="text-primary underline-offset-2 hover:underline"
|
||
>
|
||
Retry
|
||
</button>
|
||
) : null}
|
||
</p>
|
||
) : isLoading ? (
|
||
<p className="text-xs text-muted-foreground">Loading external objects…</p>
|
||
) : sorted.length === 0 ? (
|
||
<p className="text-xs text-muted-foreground">
|
||
This issue does not reference any external objects yet.
|
||
</p>
|
||
) : (
|
||
<ul className="-mx-1 flex flex-col">
|
||
{sorted.map(({ pill, mentionCount, sourceLabels, group }) => {
|
||
const object = group.object;
|
||
return (
|
||
<li
|
||
key={object?.id ?? `${pill.providerKey}:${pill.objectType}:${pill.url ?? "anon"}`}
|
||
className="flex flex-wrap items-center gap-x-2 gap-y-1.5 rounded-md px-1 py-1.5 hover:bg-accent/40"
|
||
>
|
||
<ExternalObjectPill object={pill} sourceCount={mentionCount} sourceSummary={sourceLabels.join(", ")} />
|
||
{pill.displayTitle ? (
|
||
<span className="min-w-0 flex-1 truncate text-sm text-muted-foreground">
|
||
{pill.displayTitle}
|
||
</span>
|
||
) : null}
|
||
<div className="flex flex-wrap items-center gap-1.5">
|
||
{sourceLabels.map((label) => (
|
||
<Badge variant="outline"
|
||
key={`${object?.id ?? pill.url ?? label}:${label}`}
|
||
className="border-border bg-muted/40 text-muted-foreground"
|
||
>
|
||
<span>{label}</span>
|
||
</Badge>
|
||
))}
|
||
</div>
|
||
</li>
|
||
);
|
||
})}
|
||
</ul>
|
||
)}
|
||
</section>
|
||
);
|
||
}
|
||
|
||
export function IssueRelatedWorkPanel({
|
||
relatedWork,
|
||
externalObjectsEnabled = true,
|
||
externalObjects,
|
||
externalObjectsLoading,
|
||
externalObjectsError,
|
||
onRetryExternalObjects,
|
||
}: {
|
||
relatedWork?: IssueRelatedWorkSummary | null;
|
||
externalObjectsEnabled?: boolean;
|
||
externalObjects?: IssueExternalObjectGroup[];
|
||
externalObjectsLoading?: boolean;
|
||
externalObjectsError?: boolean;
|
||
onRetryExternalObjects?: () => void;
|
||
}) {
|
||
const outbound = relatedWork?.outbound ?? [];
|
||
const inbound = relatedWork?.inbound ?? [];
|
||
|
||
return (
|
||
<div className="space-y-3">
|
||
<Section
|
||
title="References"
|
||
description="Other tasks this task currently points at in its title, description, comments, or documents."
|
||
items={outbound}
|
||
emptyLabel="This task does not reference any other tasks yet."
|
||
/>
|
||
{externalObjectsEnabled ? (
|
||
<ExternalObjectsSection
|
||
groups={externalObjects ?? []}
|
||
isLoading={Boolean(externalObjectsLoading)}
|
||
isError={Boolean(externalObjectsError)}
|
||
onRetry={onRetryExternalObjects}
|
||
/>
|
||
) : null}
|
||
<Section
|
||
title="Referenced by"
|
||
description="Other tasks that currently point at this task."
|
||
items={inbound}
|
||
emptyLabel="No other tasks reference this task yet."
|
||
/>
|
||
</div>
|
||
);
|
||
}
|