diff --git a/packages/studio/src/components/editor/DomEditGestureReadout.test.tsx b/packages/studio/src/components/editor/DomEditGestureReadout.test.tsx new file mode 100644 index 0000000000..317532b597 --- /dev/null +++ b/packages/studio/src/components/editor/DomEditGestureReadout.test.tsx @@ -0,0 +1,177 @@ +// @vitest-environment happy-dom +import React, { act, type ComponentProps } from "react"; +import { createRoot, type Root } from "react-dom/client"; +import { afterEach, describe, expect, it, vi } from "vitest"; +import { DomEditGestureReadout } from "./DomEditGestureReadout"; +import { createGestureReadout, updateGestureReadout } from "./domEditGestureReadoutState"; + +const frames = vi.hoisted(() => ({ update: () => {} })); +vi.mock("./overlayFrameLoop", () => ({ + subscribeOverlayFrame: (update: () => void) => { + frames.update = update; + return () => { + frames.update = () => {}; + }; + }, +})); +// React needs its runtime test flag, which the global typings do not declare. +(globalThis as unknown as { IS_REACT_ACT_ENVIRONMENT: boolean }).IS_REACT_ACT_ENVIRONMENT = true; +let root: Root | undefined; +afterEach(() => { + act(() => root?.unmount()); + document.body.replaceChildren(); + vi.clearAllMocks(); +}); + +function mount(kind: "drag" | "resize" | "rotate") { + const host = document.createElement("div"); + const overlay = document.createElement("div"); + const iframe = document.createElement("iframe"); + document.body.append(host, overlay, iframe); + const doc = iframe.contentDocument; + if (!doc) throw new Error("Missing preview document"); + const composition = doc.createElement("div"); + composition.setAttribute("data-composition-id", "scene"); + composition.setAttribute("data-width", "1000"); + composition.setAttribute("data-height", "800"); + const element = doc.createElement("div"); + composition.append(element); + doc.body.append(composition); + let x = 70.25; + let y = 40.75; + const width = 100; + const height = 60; + overlay.getBoundingClientRect = () => new DOMRect(20, 30, 500, 400); + iframe.getBoundingClientRect = () => new DOMRect(20, 30, 500, 400); + composition.getBoundingClientRect = () => new DOMRect(0, 0, 1000, 800); + element.getBoundingClientRect = () => new DOMRect(x, y, width, height); + Object.defineProperties(element, { + offsetWidth: { value: width }, + offsetHeight: { value: height }, + }); + const gestureRef: ComponentProps["gestureRef"] = { + current: { + travelled: true, + readout: createGestureReadout(overlay, iframe, { + left: x / 2, + top: y / 2, + width: width / 2, + height: height / 2, + editScaleX: 0.5, + editScaleY: 0.5, + }), + }, + }; + const update = (text?: string) => + updateGestureReadout( + gestureRef.current?.readout, + { + left: x / 2, + top: y / 2, + width: width / 2, + height: height / 2, + editScaleX: 0.5, + editScaleY: 0.5, + }, + text, + ); + update(kind === "resize" ? "100 × 60" : kind === "rotate" ? "0°" : undefined); + root = createRoot(host); + act(() => + root?.render( + , + ), + ); + const label = host.querySelector("[data-dom-edit-gesture-readout]"); + if (!label) throw new Error("Missing readout"); + Object.defineProperties(label, { offsetWidth: { value: 120 }, offsetHeight: { value: 24 } }); + const draw = () => frames.update(); + const end = () => { + gestureRef.current = null; + draw(); + }; + return { + measurements: [overlay, iframe, composition, element].map((node) => + vi.spyOn(node, "getBoundingClientRect"), + ), + element, + gestureRef, + update, + doc, + label, + draw, + end, + move: (nextX: number, nextY: number) => { + x = nextX; + y = nextY; + update(); + }, + }; +} + +describe("gesture readout", () => { + it("adds no layout reads while drawing and stays hidden on a plain press", () => { + const view = mount("drag"); + const measure = vi.spyOn(Element.prototype, "getBoundingClientRect"); + if (!view.gestureRef.current) throw new Error("Missing gesture"); + view.gestureRef.current.travelled = false; + view.draw(); + expect(view.label.style.display).toBe("none"); + view.gestureRef.current.travelled = true; + view.move(120, 70); + view.draw(); + view.draw(); + expect(view.label.textContent).toBe("Canvas X 120 · Y 70"); + expect(measure).not.toHaveBeenCalled(); + for (const measurement of view.measurements) expect(measurement).not.toHaveBeenCalled(); + measure.mockRestore(); + for (const measurement of view.measurements) measurement.mockRestore(); + }); + it("shows rounded composition coordinates during a move, accounting for preview zoom", () => { + const view = mount("drag"); + view.draw(); + expect(view.label.textContent).toBe("Canvas X 70 · Y 41"); + view.move(120.25, 70.75); + view.draw(); + expect(view.label.textContent).toBe("Canvas X 120 · Y 71"); + expect(view.doc.querySelector("[data-dom-edit-gesture-readout]")).toBeNull(); + view.end(); + expect(view.label.style.display).toBe("none"); + }); + it("shows the actual size draft during resize and hides on release", () => { + const view = mount("resize"); + view.draw(); + expect(view.label.textContent).toBe("100 × 60"); + view.update("144 × 87"); + view.draw(); + expect(view.label.textContent).toBe("144 × 87"); + view.end(); + expect(view.label.style.display).toBe("none"); + }); + it("reads the live angle during rotation and hides on cancellation", () => { + const view = mount("rotate"); + view.update("32°"); + view.draw(); + expect(view.label.textContent).toBe("32°"); + view.update("-46°"); + view.draw(); + expect(view.label.textContent).toBe("-46°"); + view.end(); + expect(view.label.style.display).toBe("none"); + }); + it("clamps the label inside the visible overlay at either edge", () => { + const view = mount("drag"); + view.move(900, -100); + view.draw(); + expect(view.label.style.left).toBe("496px"); + expect(view.label.style.top).toBe("4px"); + view.move(-900, 900); + view.draw(); + expect(view.label.style.left).toBe("4px"); + expect(view.label.style.top).toBe("396px"); + }); +}); diff --git a/packages/studio/src/components/editor/DomEditGestureReadout.tsx b/packages/studio/src/components/editor/DomEditGestureReadout.tsx new file mode 100644 index 0000000000..67608c8f31 --- /dev/null +++ b/packages/studio/src/components/editor/DomEditGestureReadout.tsx @@ -0,0 +1,58 @@ +import { useRef, type RefObject } from "react"; +import { useMountEffect } from "../../hooks/useMountEffect"; +import type { GestureState } from "./domEditOverlayGestures"; +import { subscribeOverlayFrame } from "./overlayFrameLoop"; + +type ReadoutGesture = Pick; + +interface DomEditGestureReadoutProps { + gestureRef: RefObject; + overlayRef: RefObject; + iframeRef: RefObject; +} + +function positionGestureReadout(label: HTMLDivElement, gesture: ReadoutGesture): void { + const readout = gesture.readout; + if (!readout) return; + const bounds = readout.basis.overlayRect; + const rect = readout.rect; + const minX = Math.max(0, -bounds.left) + 4; + const minY = Math.max(0, -bounds.top) + 4; + const maxX = Math.min(bounds.width, readout.viewportWidth - bounds.left) - 4; + const maxY = Math.min(bounds.height, readout.viewportHeight - bounds.top) - 4; + const x = Math.max(minX, Math.min(maxX, rect.left + rect.width + 8)); + const y = Math.max(minY, Math.min(maxY, rect.top - 8)); + label.style.left = `${x}px`; + label.style.top = `${y}px`; + label.style.maxWidth = `${Math.max(0, maxX - minX)}px`; + // CSS resolves the label's own size without a synchronous layout read after its text changes. + label.style.transform = `translate(max(-100%, ${minX - x}px), max(-100%, ${minY - y}px))`; +} + +export function DomEditGestureReadout({ gestureRef }: DomEditGestureReadoutProps) { + const labelRef = useRef(null); + useMountEffect(() => + subscribeOverlayFrame(() => { + const label = labelRef.current; + if (!label) return; + const gesture = gestureRef.current; + const text = gesture?.travelled && gesture.readout?.text; + if (!gesture || !text) { + label.style.display = "none"; + return; + } + if (label.textContent !== text) label.textContent = text; + label.style.display = "block"; + positionGestureReadout(label, gesture); + }), + ); + return ( +