mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-26 10:26:26 +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>
447 lines
17 KiB
TypeScript
447 lines
17 KiB
TypeScript
import { useCallback, useEffect, useMemo, useRef, useState, type ReactNode } from "react";
|
|
import { useQuery } from "@tanstack/react-query";
|
|
import type { Agent, DocumentAnnotationThreadWithComments, IssueDocument } from "@paperclipai/shared";
|
|
import { MessageSquare } from "lucide-react";
|
|
import { Button } from "@/components/ui/button";
|
|
import { cn } from "@/lib/utils";
|
|
import { documentAnnotationsApi, type DocumentAnnotationTarget } from "@/api/document-annotations";
|
|
import { queryKeys } from "@/lib/queryKeys";
|
|
import { parseDocumentAnnotationHash } from "@/lib/document-annotation-hash";
|
|
import { DocumentAnnotationLayer, type PendingAnchor } from "./DocumentAnnotationLayer";
|
|
import { DocumentAnnotationPanel } from "./DocumentAnnotationPanel";
|
|
import type { CompanyUserProfile } from "@/lib/company-members";
|
|
|
|
const DESKTOP_ANNOTATION_PANEL_WIDTH = 360;
|
|
const DESKTOP_ANNOTATION_PANEL_MIN_WIDTH = 280;
|
|
const DESKTOP_ANNOTATION_PANEL_GAP = 24;
|
|
const DESKTOP_ANNOTATION_PANEL_VIEWPORT_MARGIN = 16;
|
|
|
|
type AnnotationDocument = Pick<IssueDocument, "key" | "latestRevisionId" | "latestRevisionNumber">;
|
|
|
|
export interface IssueDocumentAnnotationsProps {
|
|
issueId: string;
|
|
doc: AnnotationDocument;
|
|
target?: DocumentAnnotationTarget;
|
|
/** The body that is being rendered/edited (current or historical revision). */
|
|
bodyMarkdown: string;
|
|
/** True when a draft has unsaved changes or is currently saving. */
|
|
draftDirty: boolean;
|
|
/** True when there is a remote conflict that requires user resolution. */
|
|
draftConflicted: boolean;
|
|
/** True when the document is being viewed in historical revision preview. */
|
|
historicalPreview: boolean;
|
|
/** Render the document body (rendered MarkdownBody or MarkdownEditor) inside the wrapper. */
|
|
children: ReactNode;
|
|
/** Current location hash so we can resolve deep-link targets. */
|
|
locationHash: string;
|
|
/** Controlled panel state. Caller owns this so the count chip can live in the doc header. */
|
|
panelOpen: boolean;
|
|
onPanelOpenChange: (open: boolean) => void;
|
|
agentMap?: ReadonlyMap<string, Pick<Agent, "id" | "name"> & Partial<Pick<Agent, "icon">>>;
|
|
userProfileMap?: ReadonlyMap<string, CompanyUserProfile>;
|
|
/** Seed which thread is focused on mount. Used by Storybook/screenshot harness. */
|
|
defaultFocusedThreadId?: string;
|
|
/**
|
|
* Seed the composer with a pending anchor and open the panel once. Used when
|
|
* a host captures a selection before the annotated document wrapper exists.
|
|
*/
|
|
initialComposerAnchor?: PendingAnchor | null;
|
|
onInitialComposerAnchorConsumed?: () => void;
|
|
}
|
|
|
|
export function IssueDocumentAnnotations({
|
|
issueId,
|
|
doc,
|
|
target,
|
|
bodyMarkdown,
|
|
draftDirty,
|
|
draftConflicted,
|
|
historicalPreview,
|
|
children,
|
|
locationHash,
|
|
panelOpen,
|
|
onPanelOpenChange,
|
|
agentMap,
|
|
userProfileMap,
|
|
defaultFocusedThreadId,
|
|
initialComposerAnchor,
|
|
onInitialComposerAnchorConsumed,
|
|
}: IssueDocumentAnnotationsProps) {
|
|
const containerRef = useRef<HTMLElement | null>(null);
|
|
const [focusedThreadId, setFocusedThreadId] = useState<string | null>(defaultFocusedThreadId ?? null);
|
|
const [focusedCommentId, setFocusedCommentId] = useState<string | null>(null);
|
|
const [selectionAnchor, setSelectionAnchor] = useState<PendingAnchor | null>(null);
|
|
const [composerAnchor, setComposerAnchor] = useState<PendingAnchor | null>(null);
|
|
const [isMobile, setIsMobile] = useState(false);
|
|
const [desktopPanelFrame, setDesktopPanelFrame] = useState<{
|
|
left: number;
|
|
top: number;
|
|
maxHeight: number;
|
|
width: number;
|
|
} | null>(null);
|
|
const hashHandledRef = useRef<string | null>(null);
|
|
// Bus token to ask the body layer to capture the current selection into a pendingAnchor.
|
|
const [captureSelectionRequestId, setCaptureSelectionRequestId] = useState(0);
|
|
const consumedInitialAnchorRef = useRef<PendingAnchor | null>(null);
|
|
|
|
useEffect(() => {
|
|
if (typeof window === "undefined" || typeof window.matchMedia !== "function") return;
|
|
const mediaQuery = window.matchMedia("(max-width: 1023px)");
|
|
const handler = () => setIsMobile(mediaQuery.matches);
|
|
handler();
|
|
if (typeof mediaQuery.addEventListener === "function") {
|
|
mediaQuery.addEventListener("change", handler);
|
|
return () => mediaQuery.removeEventListener("change", handler);
|
|
}
|
|
return undefined;
|
|
}, []);
|
|
|
|
useEffect(() => {
|
|
if (!panelOpen || isMobile || typeof window === "undefined") {
|
|
setDesktopPanelFrame(null);
|
|
return;
|
|
}
|
|
|
|
const updatePanelFrame = () => {
|
|
const container = containerRef.current;
|
|
const rect = container?.getBoundingClientRect();
|
|
if (!container || !rect) {
|
|
setDesktopPanelFrame(null);
|
|
return;
|
|
}
|
|
const boundaryRect = container.closest("main")?.getBoundingClientRect();
|
|
const boundaryLeft = boundaryRect?.left ?? 0;
|
|
const boundaryRight = boundaryRect?.right ?? window.innerWidth;
|
|
const boundaryWidth = Math.max(0, boundaryRight - boundaryLeft);
|
|
const maxPanelWidth = Math.max(
|
|
DESKTOP_ANNOTATION_PANEL_MIN_WIDTH,
|
|
boundaryWidth - DESKTOP_ANNOTATION_PANEL_VIEWPORT_MARGIN * 2,
|
|
);
|
|
const desiredWidth = Math.min(DESKTOP_ANNOTATION_PANEL_WIDTH, maxPanelWidth);
|
|
// Clamp the panel below the sticky top nav (the scroll container's top edge)
|
|
// so the comments thread never tucks under the nav bar while scrolling.
|
|
const boundaryTop = boundaryRect?.top ?? DESKTOP_ANNOTATION_PANEL_VIEWPORT_MARGIN;
|
|
const minTop = Math.max(DESKTOP_ANNOTATION_PANEL_VIEWPORT_MARGIN, boundaryTop)
|
|
+ DESKTOP_ANNOTATION_PANEL_VIEWPORT_MARGIN;
|
|
const top = Math.max(minTop, rect.top);
|
|
const desiredLeft = rect.right + DESKTOP_ANNOTATION_PANEL_GAP;
|
|
const spaceRightOfDocument = boundaryRight
|
|
- desiredLeft
|
|
- DESKTOP_ANNOTATION_PANEL_VIEWPORT_MARGIN;
|
|
const width = spaceRightOfDocument >= DESKTOP_ANNOTATION_PANEL_MIN_WIDTH
|
|
? Math.min(desiredWidth, spaceRightOfDocument)
|
|
: desiredWidth;
|
|
const maxVisibleLeft = boundaryRight
|
|
- width
|
|
- DESKTOP_ANNOTATION_PANEL_VIEWPORT_MARGIN;
|
|
setDesktopPanelFrame({
|
|
left: Math.max(
|
|
boundaryLeft + DESKTOP_ANNOTATION_PANEL_VIEWPORT_MARGIN,
|
|
Math.min(desiredLeft, maxVisibleLeft),
|
|
),
|
|
top,
|
|
width,
|
|
maxHeight: Math.max(240, window.innerHeight - top - DESKTOP_ANNOTATION_PANEL_VIEWPORT_MARGIN),
|
|
});
|
|
};
|
|
|
|
updatePanelFrame();
|
|
window.addEventListener("resize", updatePanelFrame);
|
|
window.addEventListener("scroll", updatePanelFrame, true);
|
|
const resizeObserver = typeof window.ResizeObserver === "function"
|
|
? new window.ResizeObserver(updatePanelFrame)
|
|
: null;
|
|
const observedContainer = containerRef.current;
|
|
if (resizeObserver && observedContainer) {
|
|
resizeObserver.observe(observedContainer);
|
|
const main = observedContainer.closest("main");
|
|
if (main) resizeObserver.observe(main);
|
|
}
|
|
return () => {
|
|
window.removeEventListener("resize", updatePanelFrame);
|
|
window.removeEventListener("scroll", updatePanelFrame, true);
|
|
resizeObserver?.disconnect();
|
|
};
|
|
}, [doc.key, isMobile, panelOpen]);
|
|
|
|
const annotationsQuery = useQuery({
|
|
queryKey: target?.kind === "routine"
|
|
? queryKeys.routines.documentAnnotations(target.routineId, target.documentKey, "all")
|
|
: queryKeys.issues.documentAnnotations(issueId, doc.key, "all"),
|
|
queryFn: () => target
|
|
? documentAnnotationsApi.listForTarget(target, { status: "all", includeComments: true })
|
|
: documentAnnotationsApi.list(issueId, doc.key, { status: "all", includeComments: true }),
|
|
staleTime: 30_000,
|
|
});
|
|
const allThreads = annotationsQuery.data ?? [];
|
|
|
|
// Resolve deep link `#document-<key>&thread=...&comment=...` once per change.
|
|
useEffect(() => {
|
|
if (!locationHash) return;
|
|
if (hashHandledRef.current === locationHash) return;
|
|
const target = parseDocumentAnnotationHash(locationHash);
|
|
if (!target || target.documentKey !== doc.key) return;
|
|
if (!target.threadId) return;
|
|
hashHandledRef.current = locationHash;
|
|
onPanelOpenChange(true);
|
|
setFocusedThreadId(target.threadId);
|
|
setFocusedCommentId(target.commentId);
|
|
}, [doc.key, locationHash, onPanelOpenChange]);
|
|
|
|
const newCommentDisabled = draftDirty || draftConflicted || historicalPreview || !doc.latestRevisionId;
|
|
const newCommentDisabledReason = historicalPreview
|
|
? "New comments are disabled while previewing a historical revision."
|
|
: draftConflicted
|
|
? "Resolve the document conflict before adding new comments."
|
|
: draftDirty
|
|
? "Save the draft to anchor new comments."
|
|
: !doc.latestRevisionId
|
|
? "Document has no saved revision yet."
|
|
: null;
|
|
|
|
const handleSelectionAnchorChange = useCallback((anchor: PendingAnchor | null) => {
|
|
setSelectionAnchor(anchor);
|
|
}, []);
|
|
|
|
const handleClearComposerAnchor = useCallback(() => {
|
|
setSelectionAnchor(null);
|
|
setComposerAnchor(null);
|
|
}, []);
|
|
|
|
const handleRequestComment = useCallback((anchor: PendingAnchor) => {
|
|
if (newCommentDisabled) return;
|
|
setSelectionAnchor(null);
|
|
setComposerAnchor(anchor);
|
|
onPanelOpenChange(true);
|
|
}, [newCommentDisabled, onPanelOpenChange]);
|
|
|
|
useEffect(() => {
|
|
if (!initialComposerAnchor) return;
|
|
if (consumedInitialAnchorRef.current === initialComposerAnchor) return;
|
|
if (newCommentDisabled) return;
|
|
consumedInitialAnchorRef.current = initialComposerAnchor;
|
|
setComposerAnchor(initialComposerAnchor);
|
|
onPanelOpenChange(true);
|
|
onInitialComposerAnchorConsumed?.();
|
|
}, [initialComposerAnchor, newCommentDisabled, onInitialComposerAnchorConsumed, onPanelOpenChange]);
|
|
|
|
const handleThreadFocus = useCallback((threadId: string | null) => {
|
|
setFocusedThreadId(threadId);
|
|
if (threadId) {
|
|
onPanelOpenChange(true);
|
|
setFocusedCommentId(null);
|
|
}
|
|
}, [onPanelOpenChange]);
|
|
|
|
const handleRequestCommentFromSelection = useCallback(() => {
|
|
if (newCommentDisabled) return;
|
|
if (selectionAnchor) {
|
|
handleRequestComment(selectionAnchor);
|
|
return;
|
|
}
|
|
// Trigger the layer to re-read the current selection and emit a pendingAnchor.
|
|
setCaptureSelectionRequestId((current) => current + 1);
|
|
}, [handleRequestComment, newCommentDisabled, selectionAnchor]);
|
|
|
|
// ⌘⇧M / Ctrl+Shift+M global shortcut while the panel is open.
|
|
useEffect(() => {
|
|
if (!panelOpen) return;
|
|
if (typeof window === "undefined") return;
|
|
const onKeyDown = (event: KeyboardEvent) => {
|
|
if (event.defaultPrevented) return;
|
|
const isMeta = event.metaKey || event.ctrlKey;
|
|
if (!isMeta || !event.shiftKey) return;
|
|
if (event.key.toLowerCase() !== "m") return;
|
|
event.preventDefault();
|
|
handleRequestCommentFromSelection();
|
|
};
|
|
window.addEventListener("keydown", onKeyDown);
|
|
return () => window.removeEventListener("keydown", onKeyDown);
|
|
}, [panelOpen, handleRequestCommentFromSelection]);
|
|
|
|
const focusedThread = useMemo(() => {
|
|
if (!focusedThreadId) return null;
|
|
return allThreads.find((thread) => thread.id === focusedThreadId) ?? null;
|
|
}, [allThreads, focusedThreadId]);
|
|
|
|
const overlayThreads = useMemo(
|
|
() => allThreads.map((thread) => ({
|
|
id: thread.id,
|
|
selectedText: thread.selectedText,
|
|
status: thread.status,
|
|
anchorState: thread.anchorState,
|
|
})),
|
|
[allThreads],
|
|
);
|
|
|
|
const fallbackDesktopPanelFrame = useMemo(() => {
|
|
if (!panelOpen || isMobile || desktopPanelFrame || typeof window === "undefined") return null;
|
|
const width = Math.min(
|
|
DESKTOP_ANNOTATION_PANEL_WIDTH,
|
|
Math.max(
|
|
DESKTOP_ANNOTATION_PANEL_MIN_WIDTH,
|
|
window.innerWidth - DESKTOP_ANNOTATION_PANEL_VIEWPORT_MARGIN * 2,
|
|
),
|
|
);
|
|
return {
|
|
left: Math.max(
|
|
DESKTOP_ANNOTATION_PANEL_VIEWPORT_MARGIN,
|
|
window.innerWidth - width - DESKTOP_ANNOTATION_PANEL_VIEWPORT_MARGIN,
|
|
),
|
|
top: DESKTOP_ANNOTATION_PANEL_VIEWPORT_MARGIN,
|
|
maxHeight: Math.max(
|
|
240,
|
|
window.innerHeight - DESKTOP_ANNOTATION_PANEL_VIEWPORT_MARGIN * 2,
|
|
),
|
|
width,
|
|
};
|
|
}, [desktopPanelFrame, isMobile, panelOpen]);
|
|
const renderedDesktopPanelFrame = desktopPanelFrame ?? fallbackDesktopPanelFrame;
|
|
|
|
const annotationPanel = panelOpen ? (
|
|
<DocumentAnnotationPanel
|
|
open={panelOpen}
|
|
onOpenChange={(open) => {
|
|
onPanelOpenChange(open);
|
|
if (!open) {
|
|
setSelectionAnchor(null);
|
|
setComposerAnchor(null);
|
|
setFocusedThreadId(null);
|
|
setFocusedCommentId(null);
|
|
}
|
|
}}
|
|
issueId={issueId}
|
|
target={target}
|
|
documentKey={doc.key}
|
|
documentRevisionNumber={doc.latestRevisionNumber}
|
|
baseRevisionId={doc.latestRevisionId}
|
|
baseRevisionNumber={doc.latestRevisionNumber}
|
|
threads={allThreads as DocumentAnnotationThreadWithComments[]}
|
|
focusedThreadId={focusedThreadId}
|
|
focusedCommentId={focusedCommentId}
|
|
onFocusThread={(id) => {
|
|
setFocusedThreadId(id);
|
|
if (!id) setFocusedCommentId(null);
|
|
}}
|
|
pendingAnchor={composerAnchor}
|
|
onClearPendingAnchor={handleClearComposerAnchor}
|
|
onRequestCommentFromSelection={handleRequestCommentFromSelection}
|
|
newCommentDisabled={newCommentDisabled}
|
|
newCommentDisabledReason={newCommentDisabledReason}
|
|
isMobile={isMobile}
|
|
desktopWidth={renderedDesktopPanelFrame?.width}
|
|
agentMap={agentMap}
|
|
userProfileMap={userProfileMap}
|
|
/>
|
|
) : null;
|
|
|
|
return (
|
|
<div className="paperclip-doc-annotation-host relative">
|
|
<section
|
|
ref={(element) => {
|
|
containerRef.current = element;
|
|
}}
|
|
className="relative min-w-0"
|
|
data-testid={`document-annotation-body-${doc.key}`}
|
|
>
|
|
<div className="relative z-(--z-1)">
|
|
{children}
|
|
</div>
|
|
{!historicalPreview && doc.latestRevisionId ? (
|
|
<DocumentAnnotationLayer
|
|
containerRef={containerRef}
|
|
markdown={bodyMarkdown}
|
|
threads={overlayThreads}
|
|
focusedThreadId={focusedThread?.id ?? null}
|
|
onThreadFocus={handleThreadFocus}
|
|
pendingAnchor={selectionAnchor}
|
|
onPendingAnchorChange={handleSelectionAnchorChange}
|
|
onRequestComment={handleRequestComment}
|
|
newCommentDisabled={newCommentDisabled}
|
|
newCommentDisabledReason={newCommentDisabledReason}
|
|
hideResolved
|
|
captureSelectionRequestId={captureSelectionRequestId}
|
|
pendingHighlightText={composerAnchor?.selectedText ?? null}
|
|
/>
|
|
) : null}
|
|
</section>
|
|
{panelOpen && !isMobile && renderedDesktopPanelFrame ? (
|
|
<div
|
|
data-testid="document-annotation-panel-anchor"
|
|
className="pointer-events-auto fixed z-(--z-60) hidden lg:block"
|
|
style={{
|
|
left: renderedDesktopPanelFrame.left,
|
|
maxHeight: renderedDesktopPanelFrame.maxHeight,
|
|
top: renderedDesktopPanelFrame.top,
|
|
width: renderedDesktopPanelFrame.width,
|
|
}}
|
|
>
|
|
{annotationPanel}
|
|
</div>
|
|
) : null}
|
|
{panelOpen && isMobile ? annotationPanel : null}
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export interface DocumentAnnotationsCountChipProps {
|
|
issueId: string;
|
|
docKey: string;
|
|
target?: DocumentAnnotationTarget;
|
|
panelOpen: boolean;
|
|
onToggle: () => void;
|
|
}
|
|
|
|
/**
|
|
* Renders the unresolved-count chip for a document. Lives in the document header row
|
|
* (next to `rev N ▾`) so it stays visible when the document is folded.
|
|
*/
|
|
export function DocumentAnnotationsCountChip({
|
|
issueId,
|
|
docKey,
|
|
target,
|
|
panelOpen,
|
|
onToggle,
|
|
}: DocumentAnnotationsCountChipProps) {
|
|
const annotationsQuery = useQuery({
|
|
queryKey: target?.kind === "routine"
|
|
? queryKeys.routines.documentAnnotations(target.routineId, target.documentKey, "all")
|
|
: queryKeys.issues.documentAnnotations(issueId, docKey, "all"),
|
|
queryFn: () => target
|
|
? documentAnnotationsApi.listForTarget(target, { status: "all", includeComments: true })
|
|
: documentAnnotationsApi.list(issueId, docKey, { status: "all", includeComments: true }),
|
|
staleTime: 30_000,
|
|
});
|
|
const threads = annotationsQuery.data ?? [];
|
|
const openCount = useMemo(
|
|
() => threads.filter((thread) => thread.status === "open" && thread.anchorState !== "orphaned").length,
|
|
[threads],
|
|
);
|
|
|
|
return (
|
|
<Button
|
|
type="button"
|
|
size="sm"
|
|
variant="ghost"
|
|
data-state={panelOpen ? "open" : "closed"}
|
|
className={cn(
|
|
"h-auto gap-1 rounded-md px-1.5 py-0 text-(length:--text-micro) font-normal text-muted-foreground hover:text-foreground",
|
|
panelOpen && "bg-muted text-foreground",
|
|
openCount > 0 && "text-foreground",
|
|
)}
|
|
onClick={onToggle}
|
|
data-testid={`document-annotation-count-${docKey}`}
|
|
aria-label={openCount === 0
|
|
? `Open comments on ${docKey}`
|
|
: `Open ${openCount} unresolved comments on ${docKey}`}
|
|
aria-expanded={panelOpen}
|
|
>
|
|
<MessageSquare className="h-3 w-3" aria-hidden="true" />
|
|
<span className="tabular-nums">{openCount}</span>
|
|
<span className="hidden sm:inline">
|
|
{openCount === 1 ? "comment" : "comments"}
|
|
</span>
|
|
</Button>
|
|
);
|
|
}
|