Skip to content

armgit / memos

Public Imported from GitHub
0

Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.

fix(web): pan zoomed images in the preview dialog (#6414)

Wallya2ccca7a92cd
diff --git a/web/src/components/PreviewImageDialog.tsx b/web/src/components/PreviewImageDialog.tsx
index 111d339bf..fe41536a7 100644
--- a/web/src/components/PreviewImageDialog.tsx
+++ b/web/src/components/PreviewImageDialog.tsx
@@ -1,5 +1,5 @@
import { ChevronLeft, ChevronRight, InfoIcon, RotateCcw, X, ZoomIn, ZoomOut } from "lucide-react";
-import React, { useEffect, useMemo, useState } from "react";
+import React, { useEffect, useMemo, useRef, useState } from "react";
import MediaMetadataDetails from "@/components/MediaMetadataDetails";
import MotionPhotoPreview from "@/components/MotionPhotoPreview";
import { Button } from "@/components/ui/button";
@@ -25,12 +25,39 @@ const DOUBLE_TAP_ZOOM = 2;
const clampZoom = (scale: number) => Math.min(MAX_ZOOM, Math.max(MIN_ZOOM, scale));
+interface PanOffset {
+ x: number;
+ y: number;
+}
+
+const NO_PAN: PanOffset = { x: 0, y: 0 };
+
+const clampPan = (offset: number, max: number) => Math.min(max, Math.max(-max, offset));
+
+// The image is centered in the surface's content box, so each axis clamps to half of its overflow.
+const clampPanOffset = (offset: PanOffset, scale: number, image: HTMLImageElement | null, surface: HTMLDivElement | null): PanOffset => {
+ if (!image || !surface) {
+ return offset;
+ }
+ const style = window.getComputedStyle(surface);
+ const contentWidth = surface.clientWidth - (Number.parseFloat(style.paddingLeft) || 0) - (Number.parseFloat(style.paddingRight) || 0);
+ const contentHeight = surface.clientHeight - (Number.parseFloat(style.paddingTop) || 0) - (Number.parseFloat(style.paddingBottom) || 0);
+ const maxX = Math.max(0, (image.offsetWidth * scale - contentWidth) / 2);
+ const maxY = Math.max(0, (image.offsetHeight * scale - contentHeight) / 2);
+ return { x: clampPan(offset.x, maxX), y: clampPan(offset.y, maxY) };
+};
+
function PreviewImageDialog({ open, onOpenChange, imgUrls = [], items, initialIndex = 0 }: Props) {
const t = useTranslate();
const sm = useMediaQuery("sm");
const [currentIndex, setCurrentIndex] = useState(initialIndex);
const [zoomScale, setZoomScale] = useState(MIN_ZOOM);
const [showDetails, setShowDetails] = useState(false);
+ const [panOffset, setPanOffset] = useState<PanOffset>(NO_PAN);
+ const [isPanning, setIsPanning] = useState(false);
+ const imageRef = useRef<HTMLImageElement>(null);
+ const surfaceRef = useRef<HTMLDivElement>(null);
+ const panDragRef = useRef<{ pointerId: number; startX: number; startY: number; originX: number; originY: number } | null>(null);
const previewItems = useMemo(
() => items ?? imgUrls.map((url) => ({ id: url, kind: "image" as const, sourceUrl: url, posterUrl: url, filename: "Image" })),
[imgUrls, items],
@@ -74,9 +101,29 @@ function PreviewImageDialog({ open, onOpenChange, imgUrls = [], items, initialIn
}, [itemCount, open]);
useEffect(() => {
+ const drag = panDragRef.current;
+ if (drag && imageRef.current?.hasPointerCapture(drag.pointerId)) {
+ imageRef.current.releasePointerCapture(drag.pointerId);
+ }
+ panDragRef.current = null;
setZoomScale(MIN_ZOOM);
+ setPanOffset(NO_PAN);
+ setIsPanning(false);
}, [currentItem?.id, open]);
+ useEffect(() => {
+ if (zoomScale === MIN_ZOOM) {
+ panDragRef.current = null;
+ setIsPanning(false);
+ }
+ setPanOffset((current) => {
+ if (zoomScale === MIN_ZOOM) {
+ return NO_PAN;
+ }
+ return clampPanOffset(current, zoomScale, imageRef.current, surfaceRef.current);
+ });
+ }, [zoomScale]);
+
const handleClose = () => onOpenChange(false);
const handlePrevious = () => {
setCurrentIndex((prev) => Math.max(prev - 1, 0));
@@ -99,6 +146,43 @@ function PreviewImageDialog({ open, onOpenChange, imgUrls = [], items, initialIn
};
const handleDoubleClick = () => setZoomScale((scale) => (scale === MIN_ZOOM ? DOUBLE_TAP_ZOOM : MIN_ZOOM));
+ const handlePointerDown = (event: React.PointerEvent<HTMLImageElement>) => {
+ if (!isZoomed || event.button !== 0) {
+ return;
+ }
+ event.preventDefault();
+ event.currentTarget.setPointerCapture(event.pointerId);
+ panDragRef.current = {
+ pointerId: event.pointerId,
+ startX: event.clientX,
+ startY: event.clientY,
+ originX: panOffset.x,
+ originY: panOffset.y,
+ };
+ setIsPanning(true);
+ };
+
+ const handlePointerMove = (event: React.PointerEvent<HTMLImageElement>) => {
+ const drag = panDragRef.current;
+ if (!drag || drag.pointerId !== event.pointerId) {
+ return;
+ }
+ const next = { x: drag.originX + event.clientX - drag.startX, y: drag.originY + event.clientY - drag.startY };
+ setPanOffset(clampPanOffset(next, zoomScale, imageRef.current, surfaceRef.current));
+ };
+
+ const handlePointerEnd = (event: React.PointerEvent<HTMLImageElement>) => {
+ const drag = panDragRef.current;
+ if (!drag || drag.pointerId !== event.pointerId) {
+ return;
+ }
+ if (event.currentTarget.hasPointerCapture(event.pointerId)) {
+ event.currentTarget.releasePointerCapture(event.pointerId);
+ }
+ panDragRef.current = null;
+ setIsPanning(false);
+ };
+
if (!itemCount || !currentItem) {
return null;
}
@@ -171,10 +255,11 @@ function PreviewImageDialog({ open, onOpenChange, imgUrls = [], items, initialIn
</div>
<div
+ ref={surfaceRef}
data-testid={isImagePreview ? "preview-zoom-surface" : undefined}
className={cn(
"flex h-full w-full items-center justify-center px-3 pb-20 pt-16 sm:px-16 sm:pb-8 sm:pt-20",
- isImagePreview && "cursor-zoom-in",
+ isImagePreview && !isZoomed && "cursor-zoom-in",
showDetails && "lg:pr-[26rem]",
)}
onWheel={handleWheel}
@@ -217,18 +302,25 @@ function PreviewImageDialog({ open, onOpenChange, imgUrls = [], items, initialIn
/>
) : (
<img
+ ref={imageRef}
src={currentItem.sourceUrl}
alt={`Preview image ${safeIndex + 1} of ${itemCount}`}
className={cn(
"max-h-[calc(100dvh-8rem)] max-w-[calc(100vw-1.5rem)] rounded-md object-contain select-none sm:max-h-[calc(100dvh-7rem)] sm:max-w-[calc(100vw-8rem)]",
showDetails && "lg:max-w-[calc(100vw-30rem)]",
+ isZoomed && (isPanning ? "cursor-grabbing" : "cursor-grab"),
)}
style={{
- transform: `translate3d(0px, 0px, 0) scale(${zoomScale})`,
- transition: "transform 120ms ease-out",
+ transform: `translate3d(${panOffset.x}px, ${panOffset.y}px, 0) scale(${zoomScale})`,
+ transition: isPanning ? "none" : "transform 120ms ease-out",
transformOrigin: "center center",
+ touchAction: "none",
}}
onDoubleClick={handleDoubleClick}
+ onPointerDown={handlePointerDown}
+ onPointerMove={handlePointerMove}
+ onPointerUp={handlePointerEnd}
+ onPointerCancel={handlePointerEnd}
draggable={false}
loading="eager"
decoding="async"
diff --git a/web/tests/preview-image-dialog.test.tsx b/web/tests/preview-image-dialog.test.tsx
index 87d58c4d4..e0b7ac52b 100644
--- a/web/tests/preview-image-dialog.test.tsx
+++ b/web/tests/preview-image-dialog.test.tsx
@@ -1,6 +1,6 @@
import { create } from "@bufbuild/protobuf";
import { fireEvent, render, screen, waitFor } from "@testing-library/react";
-import { describe, expect, it, vi } from "vitest";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import PreviewImageDialog from "@/components/PreviewImageDialog";
import {
AttachmentSchema,
@@ -73,7 +73,28 @@ const buildAttachmentWithPhotoMetadata = () =>
}),
});
+// jsdom has no layout engine, so pan bounds need explicit image and surface sizes.
+const mockPreviewLayout = (image: { width: number; height: number }, surface: { width: number; height: number }) => {
+ vi.spyOn(HTMLElement.prototype, "offsetWidth", "get").mockReturnValue(image.width);
+ vi.spyOn(HTMLElement.prototype, "offsetHeight", "get").mockReturnValue(image.height);
+ vi.spyOn(HTMLElement.prototype, "clientWidth", "get").mockReturnValue(surface.width);
+ vi.spyOn(HTMLElement.prototype, "clientHeight", "get").mockReturnValue(surface.height);
+};
+
describe("<PreviewImageDialog>", () => {
+ beforeEach(() => {
+ // jsdom ships PointerEvent but not pointer capture: stub the capture methods.
+ Element.prototype.setPointerCapture = vi.fn();
+ Element.prototype.hasPointerCapture = vi.fn(() => true);
+ Element.prototype.releasePointerCapture = vi.fn();
+ });
+
+ afterEach(() => {
+ // Prototype assignments outlive `restoreMocks`, so drop them explicitly.
+ for (const method of ["setPointerCapture", "hasPointerCapture", "releasePointerCapture"]) {
+ Reflect.deleteProperty(Element.prototype, method);
+ }
+ });
it("provides a dialog description without accessibility warnings", async () => {
const warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
@@ -138,6 +159,157 @@ describe("<PreviewImageDialog>", () => {
expect(screen.getByText("200%")).toBeInTheDocument();
});
+ it("pans a zoomed image with a pointer drag", () => {
+ mockPreviewLayout({ width: 1200, height: 800 }, { width: 600, height: 600 });
+ render(
+ <PreviewImageDialog
+ open
+ onOpenChange={vi.fn()}
+ items={[{ id: "image-1", kind: "image", sourceUrl: "/image.jpg", posterUrl: "/image.jpg", filename: "image.jpg" }]}
+ />,
+ );
+
+ const image = screen.getByAltText("Preview image 1 of 1");
+ fireEvent.doubleClick(image);
+ fireEvent.pointerDown(image, { button: 0, pointerId: 1, clientX: 100, clientY: 120 });
+ fireEvent.pointerMove(image, { pointerId: 1, clientX: 180, clientY: 160 });
+ fireEvent.pointerUp(image, { pointerId: 1, clientX: 180, clientY: 160 });
+
+ expect(image).toHaveStyle({ transform: "translate3d(80px, 40px, 0) scale(2)" });
+ });
+
+ it("clamps the pan to the enlarged image bounds", () => {
+ mockPreviewLayout({ width: 1200, height: 800 }, { width: 600, height: 600 });
+ render(
+ <PreviewImageDialog
+ open
+ onOpenChange={vi.fn()}
+ items={[{ id: "image-1", kind: "image", sourceUrl: "/image.jpg", posterUrl: "/image.jpg", filename: "image.jpg" }]}
+ />,
+ );
+
+ const image = screen.getByAltText("Preview image 1 of 1");
+ fireEvent.doubleClick(image);
+ fireEvent.pointerDown(image, { button: 0, pointerId: 1, clientX: 0, clientY: 0 });
+ fireEvent.pointerMove(image, { pointerId: 1, clientX: 100000, clientY: 100000 });
+ fireEvent.pointerUp(image, { pointerId: 1, clientX: 100000, clientY: 100000 });
+
+ expect(image).toHaveStyle({ transform: "translate3d(900px, 500px, 0) scale(2)" });
+ });
+
+ it("clamps the pan to the padded content area", () => {
+ mockPreviewLayout({ width: 1200, height: 800 }, { width: 600, height: 600 });
+ render(
+ <PreviewImageDialog
+ open
+ onOpenChange={vi.fn()}
+ items={[{ id: "image-1", kind: "image", sourceUrl: "/image.jpg", posterUrl: "/image.jpg", filename: "image.jpg" }]}
+ />,
+ );
+
+ const surface = screen.getByTestId("preview-zoom-surface");
+ surface.style.paddingBottom = "80px";
+ surface.style.paddingLeft = "64px";
+ surface.style.paddingRight = "416px";
+ const image = screen.getByAltText("Preview image 1 of 1");
+ fireEvent.doubleClick(image);
+ fireEvent.pointerDown(image, { button: 0, pointerId: 1, clientX: 0, clientY: 0 });
+ fireEvent.pointerMove(image, { pointerId: 1, clientX: 100000, clientY: 100000 });
+ fireEvent.pointerUp(image, { pointerId: 1, clientX: 100000, clientY: 100000 });
+
+ expect(image).toHaveStyle({ transform: "translate3d(1140px, 540px, 0) scale(2)" });
+ });
+
+ it("does not pan an image that sits at fit zoom", () => {
+ mockPreviewLayout({ width: 1200, height: 800 }, { width: 600, height: 600 });
+ render(
+ <PreviewImageDialog
+ open
+ onOpenChange={vi.fn()}
+ items={[{ id: "image-1", kind: "image", sourceUrl: "/image.jpg", posterUrl: "/image.jpg", filename: "image.jpg" }]}
+ />,
+ );
+
+ const image = screen.getByAltText("Preview image 1 of 1");
+ fireEvent.pointerDown(image, { button: 0, pointerId: 1, clientX: 10, clientY: 10 });
+ fireEvent.pointerMove(image, { pointerId: 1, clientX: 200, clientY: 200 });
+
+ expect(image).toHaveStyle({ transform: "translate3d(0px, 0px, 0) scale(1)" });
+ });
+
+ it("drops the pan when the zoom returns to fit", () => {
+ mockPreviewLayout({ width: 1200, height: 800 }, { width: 600, height: 600 });
+ render(
+ <PreviewImageDialog
+ open
+ onOpenChange={vi.fn()}
+ items={[{ id: "image-1", kind: "image", sourceUrl: "/image.jpg", posterUrl: "/image.jpg", filename: "image.jpg" }]}
+ />,
+ );
+
+ const image = screen.getByAltText("Preview image 1 of 1");
+ fireEvent.doubleClick(image);
+ fireEvent.pointerDown(image, { button: 0, pointerId: 1, clientX: 100, clientY: 120 });
+ fireEvent.pointerMove(image, { pointerId: 1, clientX: 180, clientY: 160 });
+ fireEvent.pointerUp(image, { pointerId: 1, clientX: 180, clientY: 160 });
+
+ fireEvent.click(screen.getByRole("button", { name: /reset zoom/i }));
+
+ expect(image).toHaveStyle({ transform: "translate3d(0px, 0px, 0) scale(1)" });
+ });
+
+ it("resets the pan when switching to another item", () => {
+ mockPreviewLayout({ width: 1200, height: 800 }, { width: 600, height: 600 });
+ render(
+ <PreviewImageDialog
+ open
+ onOpenChange={vi.fn()}
+ items={[
+ { id: "image-1", kind: "image", sourceUrl: "/image-1.jpg", posterUrl: "/image-1.jpg", filename: "image-1.jpg" },
+ { id: "image-2", kind: "image", sourceUrl: "/image-2.jpg", posterUrl: "/image-2.jpg", filename: "image-2.jpg" },
+ ]}
+ />,
+ );
+
+ const firstImage = screen.getByAltText("Preview image 1 of 2");
+ fireEvent.doubleClick(firstImage);
+ fireEvent.pointerDown(firstImage, { button: 0, pointerId: 1, clientX: 100, clientY: 120 });
+ fireEvent.pointerMove(firstImage, { pointerId: 1, clientX: 180, clientY: 160 });
+
+ fireEvent.click(screen.getByRole("button", { name: /next item/i }));
+
+ expect(screen.getByAltText("Preview image 2 of 2")).toHaveStyle({ transform: "translate3d(0px, 0px, 0) scale(1)" });
+ });
+
+ it("clears a stale drag when the item changes", () => {
+ mockPreviewLayout({ width: 1200, height: 800 }, { width: 600, height: 600 });
+ render(
+ <PreviewImageDialog
+ open
+ onOpenChange={vi.fn()}
+ items={[
+ { id: "image-1", kind: "image", sourceUrl: "/image-1.jpg", posterUrl: "/image-1.jpg", filename: "image-1.jpg" },
+ { id: "video-1", kind: "video", sourceUrl: "/video.mp4", posterUrl: "/poster.jpg", filename: "video.mp4" },
+ ]}
+ />,
+ );
+
+ const image = screen.getByAltText("Preview image 1 of 2");
+ fireEvent.doubleClick(image);
+ fireEvent.pointerDown(image, { button: 0, pointerId: 1, clientX: 300, clientY: 300 });
+ fireEvent.pointerMove(image, { pointerId: 1, clientX: 200, clientY: 300 });
+ expect(image).toHaveStyle({ transform: "translate3d(-100px, 0px, 0) scale(2)" });
+
+ fireEvent.keyDown(document, { key: "ArrowRight" });
+ fireEvent.keyDown(document, { key: "ArrowLeft" });
+
+ const returned = screen.getByAltText("Preview image 1 of 2");
+ fireEvent.doubleClick(returned);
+ fireEvent.pointerMove(returned, { pointerId: 1, clientX: 220, clientY: 300 });
+
+ expect(returned).toHaveStyle({ transform: "translate3d(0px, 0px, 0) scale(2)" });
+ });
+
it("zooms image previews with the wheel", () => {
render(
<PreviewImageDialog