mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-03 01:27:09 +01:00
<!-- entire-trail-link-start --> https://entire.com/gh/paperclipai/-/trails/247/changes/paperclip/247 <!-- entire-trail-link-end --> ## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Task documents hold plans, reports, and image evidence. > - Task attachments already have an image gallery. > - Inline document images had no gallery navigation or image links. > - This change gives each document a gallery that uses the existing modal. > - People can review the image sequence and share a link to one image. ## Linked Issues or Issue Description **What existing behavior does this improve?** Image review in task documents, including the side panel and Classic interface. **Current behavior** Inline document images do not open a gallery. People cannot move through them with arrow keys or share a link to one image. **Proposed behavior** Select an image to open the gallery. Use arrow keys or Previous and Next. The URL records its one-based position, for example `#document-report&image=2`. Reloading that URL opens the selected image. Revision links keep their exact saved content. **Reason and benefit** People can inspect a document's image evidence in reading order and share the exact view. No matching issue was found. The latest 300 open PR titles were checked for related document gallery work. ## What Changed - Add a document renderer that collects rendered images in reading order, including reference-style and repeated images. - Reuse the gallery modal with optional index-change and focus-return controls. - Keep the document owner in the saved tab identity when people switch between local and other-task documents. - Match explicit current-task document owners with local document tabs. Keep review and viewer parameters during gallery navigation. - Treat another Classic review receipt as a new request while image navigation retains the selected revision. - Make inline image controls work with a keyboard. Keep focus in the modal and restore focus on close. - Keep document, revision, review, and maximized-view link parameters during image navigation. - Fix a Classic revision-cache race found by the browser test. Recheck a pinned revision when the saved document head changes. - Update the feature and agent access maps. No new server API or permission is needed. ## Verification - Passed 119 focused tests for document galleries, the shared gallery, document rendering, the revision panel, and hash routing. - Passed all 3 Chromium journeys: desktop, mobile, and Classic. These use real uploads and saved document revisions. - The browser journeys also check explicit current-task owners, review parameters after reopening, other-task links after tab switches, and a second Classic review link after Return to latest. - Browser checks cover keyboard and button navigation, wraparound, shared-link reload, exact historical content, invalid positions, focus return and containment, scroll locking, and Escape, Close, and backdrop dismissal. - UI typecheck, token gates, map checks, and diff whitespace checks passed. - The UI production build passed in the browser harness. - Earlier browser runs found and then verified the Classic revision-cache fix. A later build exited 137 while the full test suite ran. The browser run passed after that suite stopped. - Full repository typecheck and build could not complete because Cargo is absent. The full repository test run did not complete within this sandbox. These checks remain subject to CI. ## Risks - Image positions follow document reading order. Editing an unpinned document can change those positions. A revision link retains the saved sequence. - The shared modal now uses Radix Escape handling. The existing gallery tests and nested mobile dialog journey pass. - No schema change or migration. ## Model Used OpenAI GPT-6 through Codex. The runtime did not expose a more specific model ID or context window size. Used reasoning, code editing, shell commands, and browser automation. ## 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 - [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: Paperclip <noreply@paperclip.ing>
81 lines
3.5 KiB
TypeScript
81 lines
3.5 KiB
TypeScript
import { useCallback, useEffect, useRef, useState, type ComponentProps } from "react";
|
|
import { useLocation, useNavigate } from "react-router-dom";
|
|
import { buildDocumentAnnotationHash, parseDocumentAnnotationHash } from "@/lib/document-annotation-hash";
|
|
import { ImageGalleryModal, type GalleryMediaItem } from "./ImageGalleryModal";
|
|
import { MarkdownBody } from "./MarkdownBody";
|
|
|
|
type DocumentMarkdownBodyProps = Omit<ComponentProps<typeof MarkdownBody>, "onImageClick"> & {
|
|
documentKey: string;
|
|
revisionId?: string;
|
|
documentIssueId?: string;
|
|
currentIssueId?: string;
|
|
};
|
|
|
|
export function DocumentMarkdownBody({ documentKey, revisionId, documentIssueId, currentIssueId, ...props }: DocumentMarkdownBodyProps) {
|
|
const location = useLocation();
|
|
const navigate = useNavigate();
|
|
const locationRef = useRef(location);
|
|
locationRef.current = location;
|
|
const containerRef = useRef<HTMLDivElement>(null);
|
|
const returnFocusRef = useRef<HTMLImageElement | null>(null);
|
|
const [items, setItems] = useState<GalleryMediaItem[]>([]);
|
|
const target = parseDocumentAnnotationHash(location.hash);
|
|
const matchesDocument = target?.documentKey === documentKey
|
|
&& target.revisionId === revisionId
|
|
&& (target.documentIssueId ?? currentIssueId) === (documentIssueId ?? currentIssueId);
|
|
const image = matchesDocument ? target.image : undefined;
|
|
|
|
const readImages = useCallback(() =>
|
|
Array.from(containerRef.current?.querySelectorAll<HTMLImageElement>(".paperclip-markdown img[src]") ?? [])
|
|
.filter((element) => Boolean(element.getAttribute("src"))), []);
|
|
|
|
useEffect(() => {
|
|
if (!image) return;
|
|
const images = readImages();
|
|
setItems(images.map((element, index) => ({
|
|
id: String(index),
|
|
contentPath: element.getAttribute("src")!,
|
|
downloadPath: element.getAttribute("src")!,
|
|
contentType: "image/*",
|
|
originalFilename: element.alt || `Image ${index + 1}`,
|
|
})));
|
|
if (!returnFocusRef.current?.isConnected) returnFocusRef.current = images[image - 1] ?? null;
|
|
}, [image, props.children, readImages]);
|
|
|
|
const updateImage = useCallback((index?: number) => {
|
|
const location = locationRef.current;
|
|
const current = parseDocumentAnnotationHash(location.hash);
|
|
const sameDocument = current?.documentKey === documentKey
|
|
&& current.revisionId === revisionId
|
|
&& (current.documentIssueId ?? currentIssueId) === (documentIssueId ?? currentIssueId);
|
|
const hash = buildDocumentAnnotationHash({
|
|
...(sameDocument ? current : { documentKey, threadId: null, commentId: null }),
|
|
revisionId,
|
|
documentIssueId: sameDocument ? current.documentIssueId : documentIssueId,
|
|
image: index === undefined ? undefined : index + 1,
|
|
});
|
|
navigate({ pathname: location.pathname, search: location.search, hash }, { replace: true, state: location.state });
|
|
}, [currentIssueId, documentIssueId, documentKey, navigate, revisionId]);
|
|
|
|
const openImage = useCallback((_src: string, element: HTMLImageElement) => {
|
|
const index = readImages().indexOf(element);
|
|
if (index < 0) return;
|
|
returnFocusRef.current = element;
|
|
updateImage(index);
|
|
}, [readImages, updateImage]);
|
|
|
|
return (
|
|
<div ref={containerRef}>
|
|
<MarkdownBody {...props} onImageClick={openImage} />
|
|
<ImageGalleryModal
|
|
items={items}
|
|
initialIndex={(image ?? 1) - 1}
|
|
open={Boolean(image && image <= items.length)}
|
|
onIndexChange={updateImage}
|
|
onOpenChange={(open) => { if (!open) updateImage(); }}
|
|
returnFocusRef={returnFocusRef}
|
|
/>
|
|
</div>
|
|
);
|
|
}
|