mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-30 13:20:54 +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>
249 lines
9.4 KiB
TypeScript
249 lines
9.4 KiB
TypeScript
import type { ReactElement, ReactNode } from "react";
|
||
import { Loader2, ShieldCheck, Terminal, TriangleAlert } from "lucide-react";
|
||
import { BOOTSTRAP_FALLBACK_COMMAND } from "@/bootstrapSetup";
|
||
import { Button } from "@/components/ui/button";
|
||
import { Card } from "@/components/ui/card";
|
||
|
||
type LabFixtureKey =
|
||
| "signed-out-private"
|
||
| "signed-in-private"
|
||
| "claiming"
|
||
| "claim-error"
|
||
| "claim-success"
|
||
| "public-invite-only";
|
||
|
||
const FIXTURE_LABELS: Record<LabFixtureKey, string> = {
|
||
"signed-out-private": "1 · authenticated/private — signed out (browser claim available)",
|
||
"signed-in-private": "2 · authenticated/private — signed in (claim CTA primary)",
|
||
claiming: "3 · authenticated/private — claim in flight",
|
||
"claim-error": "4 · authenticated/private — claim error (e.g. 409 already claimed)",
|
||
"claim-success": "5 · authenticated/private — claim succeeded, redirect pending",
|
||
"public-invite-only": "6 · authenticated/public — invite-only (no browser claim)",
|
||
};
|
||
|
||
const FIXTURE_ORDER: LabFixtureKey[] = [
|
||
"signed-out-private",
|
||
"signed-in-private",
|
||
"claiming",
|
||
"claim-error",
|
||
"claim-success",
|
||
"public-invite-only",
|
||
];
|
||
|
||
function CliFallback({ hasActiveInvite }: { hasActiveInvite: boolean }) {
|
||
return (
|
||
<div className="mt-6 border-t border-border pt-5">
|
||
<div className="flex items-center gap-2 text-sm font-medium">
|
||
<Terminal className="size-4 text-muted-foreground" aria-hidden />
|
||
<span>Prefer to finish setup from the host?</span>
|
||
</div>
|
||
<p className="mt-2 text-sm text-muted-foreground">
|
||
{hasActiveInvite
|
||
? "A bootstrap invite is already active. Check your Paperclip startup logs for the first‑admin URL, or run this command on the host to rotate it:"
|
||
: "Run this command on the host that runs Paperclip to print a one‑time first‑admin invite URL:"}
|
||
</p>
|
||
<pre className="mt-3 overflow-x-auto rounded-md border border-border bg-muted/30 p-3 font-mono text-xs">
|
||
{BOOTSTRAP_FALLBACK_COMMAND}
|
||
</pre>
|
||
</div>
|
||
);
|
||
}
|
||
|
||
function StateChrome({ children }: { children: ReactNode }) {
|
||
return (
|
||
<div className="mx-auto max-w-xl py-10">
|
||
<Card className="block p-6">{children}</Card>
|
||
</div>
|
||
);
|
||
}
|
||
|
||
function SignedOutPrivate() {
|
||
return (
|
||
<StateChrome>
|
||
<h1 className="text-xl font-semibold">Finish setting up this Paperclip</h1>
|
||
<p className="mt-2 text-sm text-muted-foreground">
|
||
No admin has claimed this instance yet. Sign in or create your Paperclip account to become the first
|
||
admin from this browser.
|
||
</p>
|
||
<div className="mt-5">
|
||
<Button asChild>
|
||
<a href="/auth?next=/">Sign in / Create account</a>
|
||
</Button>
|
||
</div>
|
||
<CliFallback hasActiveInvite={false} />
|
||
</StateChrome>
|
||
);
|
||
}
|
||
|
||
function SignedInPrivate() {
|
||
return (
|
||
<StateChrome>
|
||
<h1 className="text-xl font-semibold">Finish setting up this Paperclip</h1>
|
||
<p className="mt-2 text-sm text-muted-foreground">
|
||
No admin has claimed this instance yet. Claim it now to become the first admin and start onboarding.
|
||
</p>
|
||
<div className="mt-5 flex flex-wrap items-center gap-3">
|
||
<Button>Claim this instance</Button>
|
||
<span className="text-sm text-muted-foreground">
|
||
Signed in as <span className="font-medium text-foreground">jane@appliance.local</span>
|
||
</span>
|
||
</div>
|
||
<p className="mt-3 text-xs text-muted-foreground">
|
||
Wrong account?{" "}
|
||
<a href="/auth?next=/" className="underline underline-offset-2">
|
||
Switch account
|
||
</a>
|
||
.
|
||
</p>
|
||
<CliFallback hasActiveInvite={false} />
|
||
</StateChrome>
|
||
);
|
||
}
|
||
|
||
function ClaimingPrivate() {
|
||
return (
|
||
<StateChrome>
|
||
<h1 className="text-xl font-semibold">Finish setting up this Paperclip</h1>
|
||
<p className="mt-2 text-sm text-muted-foreground">
|
||
No admin has claimed this instance yet. Claim it now to become the first admin and start onboarding.
|
||
</p>
|
||
<div className="mt-5 flex flex-wrap items-center gap-3">
|
||
<Button disabled>
|
||
<Loader2 className="mr-2 size-4 animate-spin" aria-hidden />
|
||
Claiming…
|
||
</Button>
|
||
<span className="text-sm text-muted-foreground">
|
||
Signed in as <span className="font-medium text-foreground">jane@appliance.local</span>
|
||
</span>
|
||
</div>
|
||
<CliFallback hasActiveInvite={false} />
|
||
</StateChrome>
|
||
);
|
||
}
|
||
|
||
function ClaimErrorPrivate() {
|
||
return (
|
||
<StateChrome>
|
||
<h1 className="text-xl font-semibold">Finish setting up this Paperclip</h1>
|
||
<p className="mt-2 text-sm text-muted-foreground">
|
||
No admin has claimed this instance yet. Claim it now to become the first admin and start onboarding.
|
||
</p>
|
||
<div className="mt-5 flex flex-wrap items-center gap-3">
|
||
<Button>Claim this instance</Button>
|
||
<span className="text-sm text-muted-foreground">
|
||
Signed in as <span className="font-medium text-foreground">jane@appliance.local</span>
|
||
</span>
|
||
</div>
|
||
<div
|
||
role="alert"
|
||
className="mt-4 flex items-start gap-2 rounded-md border border-destructive/40 bg-destructive/10 p-3 text-sm text-destructive"
|
||
>
|
||
<TriangleAlert className="mt-0.5 size-4 flex-shrink-0" aria-hidden />
|
||
<div>
|
||
<p className="font-medium">Someone else has already claimed this instance.</p>
|
||
<p className="mt-1 text-destructive/90">
|
||
Refresh to sign in, or ask the existing admin to invite you from{" "}
|
||
<span className="font-mono">Instance settings → Access</span>.
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<CliFallback hasActiveInvite={false} />
|
||
</StateChrome>
|
||
);
|
||
}
|
||
|
||
function ClaimSuccess() {
|
||
return (
|
||
<StateChrome>
|
||
<div className="flex items-start gap-3">
|
||
<div className="mt-0.5 flex size-9 flex-shrink-0 items-center justify-center rounded-full bg-emerald-500/15 text-emerald-600 dark:text-emerald-400">
|
||
<ShieldCheck className="size-5" aria-hidden />
|
||
</div>
|
||
<div>
|
||
<h1 className="text-xl font-semibold">You’re the instance admin</h1>
|
||
<p className="mt-2 text-sm text-muted-foreground">
|
||
Setup is complete. Taking you to onboarding to create your first company…
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<div className="mt-5 flex items-center gap-3">
|
||
<Loader2 className="size-4 animate-spin text-muted-foreground" aria-hidden />
|
||
<span className="text-sm text-muted-foreground">Redirecting…</span>
|
||
</div>
|
||
<div className="mt-5">
|
||
<Button asChild variant="outline">
|
||
<a href="/">Continue to dashboard</a>
|
||
</Button>
|
||
</div>
|
||
</StateChrome>
|
||
);
|
||
}
|
||
|
||
function PublicInviteOnly() {
|
||
return (
|
||
<StateChrome>
|
||
<h1 className="text-xl font-semibold">This Paperclip is waiting on its first admin</h1>
|
||
<p className="mt-2 text-sm text-muted-foreground">
|
||
This instance runs in invite‑only mode. The operator must generate a one‑time first‑admin invite URL
|
||
from the host. Once you have the link, open it from this browser to finish setup.
|
||
</p>
|
||
<CliFallback hasActiveInvite />
|
||
<p className="mt-4 text-xs text-muted-foreground">
|
||
Browser‑based claim is intentionally disabled in public mode so anyone on the network can’t
|
||
promote themselves.
|
||
</p>
|
||
</StateChrome>
|
||
);
|
||
}
|
||
|
||
const FIXTURE_BODIES: Record<LabFixtureKey, ReactElement> = {
|
||
"signed-out-private": <SignedOutPrivate />,
|
||
"signed-in-private": <SignedInPrivate />,
|
||
claiming: <ClaimingPrivate />,
|
||
"claim-error": <ClaimErrorPrivate />,
|
||
"claim-success": <ClaimSuccess />,
|
||
"public-invite-only": <PublicInviteOnly />,
|
||
};
|
||
|
||
export function BootstrapSetupUxLab() {
|
||
return (
|
||
<div className="bg-background min-h-screen pb-16">
|
||
<header className="border-b border-border bg-muted/20">
|
||
<div className="mx-auto max-w-3xl px-6 py-6">
|
||
<p className="text-xs font-medium uppercase tracking-wider text-muted-foreground">UX Lab</p>
|
||
<h1 className="mt-1 text-2xl font-semibold">Bootstrap-pending setup states</h1>
|
||
<p className="mt-2 max-w-2xl text-sm text-muted-foreground">
|
||
Fixtures for the bootstrap-pending screen in <span className="font-mono">CloudAccessGate</span>. Used
|
||
as the UX spec for{" "}
|
||
<a className="underline underline-offset-2" href="/PAP/issues/PAP-10113">
|
||
PAP-10113
|
||
</a>{" "}
|
||
and the implementation reference for{" "}
|
||
<a className="underline underline-offset-2" href="/PAP/issues/PAP-10114">
|
||
PAP-10114
|
||
</a>
|
||
. The browser claim CTA only appears when{" "}
|
||
<span className="font-mono">deploymentMode === "authenticated"</span> and{" "}
|
||
<span className="font-mono">deploymentExposure === "private"</span>.
|
||
</p>
|
||
</div>
|
||
</header>
|
||
<main className="mx-auto max-w-3xl space-y-12 px-6 pt-10">
|
||
{FIXTURE_ORDER.map((key) => (
|
||
<section key={key} aria-labelledby={`lab-${key}`}>
|
||
<h2
|
||
id={`lab-${key}`}
|
||
className="mb-3 text-xs font-medium uppercase tracking-wider text-muted-foreground"
|
||
>
|
||
{FIXTURE_LABELS[key]}
|
||
</h2>
|
||
<div className="rounded-lg border border-dashed border-border/70 bg-muted/10 p-2">
|
||
{FIXTURE_BODIES[key]}
|
||
</div>
|
||
</section>
|
||
))}
|
||
</main>
|
||
</div>
|
||
);
|
||
}
|