mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-07 16:35:48 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work, and task status is one of the most-scanned signals across its whole UI. > - The Tasks UI shows status through small coloured ring icons and chips spread across the list, kanban, task detail, the properties flyout, inline `@`-mentions and the breadcrumb. > - Those ring glyphs lean heavily on colour to distinguish states, which is hard to read for colour-blind users, and the status hues were hard-coded in component classes rather than a single source. > - We want color-blind-safe, distinct *shapes* per status plus a single `--status-*` colour-token system the chips and icons share. > - This pull request adds a unified `StatusGlyph` (one shape per status) and the `--status-*` colour-token system, and adopts them across every task-status surface so the new glyphs + colours render by default. > - The benefit is a more accessible, consistent status language with one source of truth for status hues. ## Linked Issues or Issue Description This is a **feature** (no public issue filed). Following the feature issue template: - **Problem / motivation:** Task status is communicated mostly by colour (ring fills/borders), which is hard to distinguish for colour-blind users, and the status hues are duplicated across component classes with no single source of truth. Several community PRs have nibbled at parts of this (see related PRs below). - **Proposed solution:** A single `StatusGlyph` component with a distinct *shape* per status (not just colour), backed by a `--status-*` CSS-variable colour system (base hues + AA-tuned icon hues + `.status-chip` / `.status-fill` color-mix helpers), adopted across all task-status surfaces. - **Alternatives considered:** Recolouring the existing rings in place (rejected — still colour-only, no shape differentiation). - **Roadmap alignment:** Additive UI only; no overlap with planned core work. Related community PRs (partial / different approaches to the same area — not duplicates): - Refs #3806 — Show issue ref and status icon in breadcrumbs and properties - Refs #1760 — Improve design of cancelled task status icon - Refs #1856 — a11y title/aria-label on status and priority icons ## What Changed - **Colour token system:** `--status-agent-*` / `--status-task-*` base hues, AA-tuned `--status-task-icon-*` hues (light + dark), and `.status-chip` / `.status-fill` color-mix helpers in `index.css`; matching status→CSS-var maps in `status-colors.ts`. - **`StatusGlyph`** — one `viewBox="0 0 24 24"` glyph per status with distinct, color-blind-safe shapes (dashed ring, open ring, half-fill, ring+dot, disc+check, ring+bar, ring+slash, and `in_queue` = the blocked shape recoloured blue). Sizes `sm`/`md`/`lg`. - **Adoption (renders by default)** across `StatusIcon`, `StatusBadge` (agent + issue chips), `MarkdownBody` inline mentions, `IssueRow`, `IssuesList`, `IssueProperties`, `BreadcrumbBar` + `BreadcrumbContext`, and the task-detail header/breadcrumb. - **Tests** for `StatusGlyph`, `StatusIcon`, `StatusBadge`, `IssueRow`, `IssuesList`, `MarkdownBody` lock the rendered behaviour. Scope notes: no experimental flag and no Theme Editor surfaces. The generic `StatusBadge` (runs/goals/approvals) is unchanged. Project-status recolour is deferred (no in-scope consumer). ## Verification - `pnpm --filter @paperclipai/shared build` — green (tsc). - `pnpm --filter @paperclipai/ui build` — green (tsc + vite). - Targeted unit tests green: `StatusGlyph`, `StatusIcon`, `StatusBadge`, `IssueRow`, `IssuesList`, `MarkdownBody`, plus consumer suites that render these (`IssueProperties`, `IssueDetail`, `Search`, `IssueChatThread`, `IssueFiltersPopover`, `InterruptHandoffViews`) — all passing. - Remaining: interactive light + dark visual confirmation across list / kanban / detail / properties / inline mentions / breadcrumb. The glyph shapes + AA-tuned hues were previously QA'd on the originating feature branch. ## Risks Low risk. Additive UI: a new component + CSS tokens, adopted at existing status call sites. The generic `StatusBadge` and all non-status UI are untouched; no schema/migration changes. Behaviour is exercised by unit + consumer test suites. ## Model Used Claude Opus 4.8 (`claude-opus-4-8`), extended thinking, with tool use / code execution (file edits, local builds + vitest). ## 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 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 - [ ] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com> Co-authored-by: Paperclip <noreply@paperclip.ing>
136 lines
5.1 KiB
TypeScript
136 lines
5.1 KiB
TypeScript
import { useState } from "react";
|
|
import type { IssueBlockerAttention } from "@paperclipai/shared";
|
|
import { cn } from "../lib/utils";
|
|
import { StatusGlyph, type StatusGlyphSize } from "./StatusGlyph";
|
|
import { Popover, PopoverContent, PopoverTrigger } from "@/components/ui/popover";
|
|
import { Button } from "@/components/ui/button";
|
|
|
|
const allStatuses = ["backlog", "todo", "in_progress", "in_review", "done", "cancelled", "blocked"];
|
|
|
|
function statusLabel(status: string): string {
|
|
return status.replace(/_/g, " ").replace(/\b\w/g, (c) => c.toUpperCase());
|
|
}
|
|
|
|
interface StatusIconProps {
|
|
status: string;
|
|
blockerAttention?: IssueBlockerAttention | null;
|
|
onChange?: (status: string) => void;
|
|
className?: string;
|
|
showLabel?: boolean;
|
|
/** Glyph size (PAP-243a). Default `md` (16px); lists/detail/mentions use `lg` (20px). */
|
|
size?: StatusGlyphSize;
|
|
}
|
|
|
|
function blockedAttentionLabel(blockerAttention: IssueBlockerAttention | null | undefined) {
|
|
if (!blockerAttention || blockerAttention.state === "none") return "Blocked";
|
|
|
|
if (blockerAttention.reason === "active_child") {
|
|
const count = blockerAttention.coveredBlockerCount;
|
|
if (count === 1 && blockerAttention.sampleBlockerIdentifier) {
|
|
return `Blocked · waiting on active sub-task ${blockerAttention.sampleBlockerIdentifier}`;
|
|
}
|
|
if (count === 1) return "Blocked · waiting on 1 active sub-task";
|
|
return `Blocked · waiting on ${count} active sub-tasks`;
|
|
}
|
|
|
|
if (blockerAttention.reason === "active_dependency") {
|
|
const count = blockerAttention.coveredBlockerCount;
|
|
if (count === 1 && blockerAttention.sampleBlockerIdentifier) {
|
|
return `Blocked · covered by active dependency ${blockerAttention.sampleBlockerIdentifier}`;
|
|
}
|
|
if (count === 1) return "Blocked · covered by 1 active dependency";
|
|
return `Blocked · covered by ${count} active dependencies`;
|
|
}
|
|
|
|
if (blockerAttention.reason === "stalled_review") {
|
|
const count = blockerAttention.stalledBlockerCount;
|
|
const leaf = blockerAttention.sampleStalledBlockerIdentifier ?? blockerAttention.sampleBlockerIdentifier;
|
|
if (count === 1 && leaf) return `Blocked · review stalled on ${leaf}`;
|
|
if (count === 1) return "Blocked · review stalled with no clear next step";
|
|
return `Blocked · ${count} reviews stalled with no clear next step`;
|
|
}
|
|
|
|
if (blockerAttention.reason === "attention_required") {
|
|
const count = blockerAttention.attentionBlockerCount || blockerAttention.unresolvedBlockerCount;
|
|
const attentionCopy = `${count} ${count === 1 ? "blocker needs" : "blockers need"} attention`;
|
|
const coveredCount = blockerAttention.coveredBlockerCount;
|
|
if (coveredCount > 0) {
|
|
return `Blocked · ${attentionCopy}; ${coveredCount} covered by active work`;
|
|
}
|
|
return `Blocked · ${attentionCopy}`;
|
|
}
|
|
|
|
return "Blocked";
|
|
}
|
|
|
|
/**
|
|
* Task/issue status indicator — renders the unified, color-blind-safe
|
|
* {@link StatusGlyph} (one distinct shape per status). With `onChange` it also
|
|
* acts as a status picker (popover). This one component drives every standalone
|
|
* status surface: list, kanban, detail header, properties row + picker flyout,
|
|
* sub-task / blocked-by pills, blocked inbox, quicklook, sibling nav, filters,
|
|
* search, columns, dashboard.
|
|
*
|
|
* A "covered" blocked task (waiting on active work) maps to the `in_queue`
|
|
* glyph — the blocked shape recoloured blue — while the full blocked reason
|
|
* still rides on the accessible label.
|
|
*/
|
|
export function StatusIcon({ status, blockerAttention, onChange, className, showLabel, size = "md" }: StatusIconProps) {
|
|
const [open, setOpen] = useState(false);
|
|
const isCoveredBlocked = status === "blocked" && blockerAttention?.state === "covered";
|
|
const ariaLabel = status === "blocked" ? blockedAttentionLabel(blockerAttention) : statusLabel(status);
|
|
const glyphStatus = isCoveredBlocked ? "in_queue" : status;
|
|
|
|
const glyph = (
|
|
<StatusGlyph
|
|
status={glyphStatus}
|
|
size={size}
|
|
className={cn(onChange && !showLabel && "cursor-pointer", className)}
|
|
title={ariaLabel}
|
|
/>
|
|
);
|
|
|
|
if (!onChange) {
|
|
return showLabel ? (
|
|
<span className="inline-flex items-center gap-1.5">
|
|
{glyph}
|
|
<span className="text-sm">{statusLabel(status)}</span>
|
|
</span>
|
|
) : (
|
|
glyph
|
|
);
|
|
}
|
|
|
|
const trigger = showLabel ? (
|
|
<button className="inline-flex items-center gap-1.5 cursor-pointer hover:bg-accent/50 rounded px-1 -mx-1 py-0.5 transition-colors">
|
|
{glyph}
|
|
<span className="text-sm">{statusLabel(status)}</span>
|
|
</button>
|
|
) : (
|
|
glyph
|
|
);
|
|
|
|
return (
|
|
<Popover open={open} onOpenChange={setOpen}>
|
|
<PopoverTrigger asChild>{trigger}</PopoverTrigger>
|
|
<PopoverContent className="w-40 p-1" align="start">
|
|
{allStatuses.map((s) => (
|
|
<Button
|
|
key={s}
|
|
variant="ghost"
|
|
size="sm"
|
|
className={cn("w-full justify-start gap-2 text-xs", s === status && "bg-accent")}
|
|
onClick={() => {
|
|
onChange(s);
|
|
setOpen(false);
|
|
}}
|
|
>
|
|
<StatusIcon status={s} size="lg" />
|
|
{statusLabel(s)}
|
|
</Button>
|
|
))}
|
|
</PopoverContent>
|
|
</Popover>
|
|
);
|
|
}
|