Skip to content

Commit a4a84de

Browse files
authored
feat(studio): show canvas gesture position, size and rotation (#5594)
* feat(studio): show live canvas gesture measurements Candidate source; required readout regressions pass. Browser captures and full Studio validation remain in progress. * test(studio): explain the React test flag typing boundary * fix(studio): derive gesture readout from pointer drafts
1 parent 6c0cab8 commit a4a84de

7 files changed

Lines changed: 322 additions & 13 deletions
Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
// @vitest-environment happy-dom
2+
import React, { act, type ComponentProps } from "react";
3+
import { createRoot, type Root } from "react-dom/client";
4+
import { afterEach, describe, expect, it, vi } from "vitest";
5+
import { DomEditGestureReadout } from "./DomEditGestureReadout";
6+
import { createGestureReadout, updateGestureReadout } from "./domEditGestureReadoutState";
7+
8+
const frames = vi.hoisted(() => ({ update: () => {} }));
9+
vi.mock("./overlayFrameLoop", () => ({
10+
subscribeOverlayFrame: (update: () => void) => {
11+
frames.update = update;
12+
return () => {
13+
frames.update = () => {};
14+
};
15+
},
16+
}));
17+
// React needs its runtime test flag, which the global typings do not declare.
18+
(globalThis as unknown as { IS_REACT_ACT_ENVIRONMENT: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
19+
let root: Root | undefined;
20+
afterEach(() => {
21+
act(() => root?.unmount());
22+
document.body.replaceChildren();
23+
vi.clearAllMocks();
24+
});
25+
26+
function mount(kind: "drag" | "resize" | "rotate") {
27+
const host = document.createElement("div");
28+
const overlay = document.createElement("div");
29+
const iframe = document.createElement("iframe");
30+
document.body.append(host, overlay, iframe);
31+
const doc = iframe.contentDocument;
32+
if (!doc) throw new Error("Missing preview document");
33+
const composition = doc.createElement("div");
34+
composition.setAttribute("data-composition-id", "scene");
35+
composition.setAttribute("data-width", "1000");
36+
composition.setAttribute("data-height", "800");
37+
const element = doc.createElement("div");
38+
composition.append(element);
39+
doc.body.append(composition);
40+
let x = 70.25;
41+
let y = 40.75;
42+
const width = 100;
43+
const height = 60;
44+
overlay.getBoundingClientRect = () => new DOMRect(20, 30, 500, 400);
45+
iframe.getBoundingClientRect = () => new DOMRect(20, 30, 500, 400);
46+
composition.getBoundingClientRect = () => new DOMRect(0, 0, 1000, 800);
47+
element.getBoundingClientRect = () => new DOMRect(x, y, width, height);
48+
Object.defineProperties(element, {
49+
offsetWidth: { value: width },
50+
offsetHeight: { value: height },
51+
});
52+
const gestureRef: ComponentProps<typeof DomEditGestureReadout>["gestureRef"] = {
53+
current: {
54+
travelled: true,
55+
readout: createGestureReadout(overlay, iframe, {
56+
left: x / 2,
57+
top: y / 2,
58+
width: width / 2,
59+
height: height / 2,
60+
editScaleX: 0.5,
61+
editScaleY: 0.5,
62+
}),
63+
},
64+
};
65+
const update = (text?: string) =>
66+
updateGestureReadout(
67+
gestureRef.current?.readout,
68+
{
69+
left: x / 2,
70+
top: y / 2,
71+
width: width / 2,
72+
height: height / 2,
73+
editScaleX: 0.5,
74+
editScaleY: 0.5,
75+
},
76+
text,
77+
);
78+
update(kind === "resize" ? "100 × 60" : kind === "rotate" ? "0°" : undefined);
79+
root = createRoot(host);
80+
act(() =>
81+
root?.render(
82+
<DomEditGestureReadout
83+
gestureRef={gestureRef}
84+
overlayRef={{ current: overlay }}
85+
iframeRef={{ current: iframe }}
86+
/>,
87+
),
88+
);
89+
const label = host.querySelector<HTMLDivElement>("[data-dom-edit-gesture-readout]");
90+
if (!label) throw new Error("Missing readout");
91+
Object.defineProperties(label, { offsetWidth: { value: 120 }, offsetHeight: { value: 24 } });
92+
const draw = () => frames.update();
93+
const end = () => {
94+
gestureRef.current = null;
95+
draw();
96+
};
97+
return {
98+
measurements: [overlay, iframe, composition, element].map((node) =>
99+
vi.spyOn(node, "getBoundingClientRect"),
100+
),
101+
element,
102+
gestureRef,
103+
update,
104+
doc,
105+
label,
106+
draw,
107+
end,
108+
move: (nextX: number, nextY: number) => {
109+
x = nextX;
110+
y = nextY;
111+
update();
112+
},
113+
};
114+
}
115+
116+
describe("gesture readout", () => {
117+
it("adds no layout reads while drawing and stays hidden on a plain press", () => {
118+
const view = mount("drag");
119+
const measure = vi.spyOn(Element.prototype, "getBoundingClientRect");
120+
if (!view.gestureRef.current) throw new Error("Missing gesture");
121+
view.gestureRef.current.travelled = false;
122+
view.draw();
123+
expect(view.label.style.display).toBe("none");
124+
view.gestureRef.current.travelled = true;
125+
view.move(120, 70);
126+
view.draw();
127+
view.draw();
128+
expect(view.label.textContent).toBe("Canvas X 120 · Y 70");
129+
expect(measure).not.toHaveBeenCalled();
130+
for (const measurement of view.measurements) expect(measurement).not.toHaveBeenCalled();
131+
measure.mockRestore();
132+
for (const measurement of view.measurements) measurement.mockRestore();
133+
});
134+
it("shows rounded composition coordinates during a move, accounting for preview zoom", () => {
135+
const view = mount("drag");
136+
view.draw();
137+
expect(view.label.textContent).toBe("Canvas X 70 · Y 41");
138+
view.move(120.25, 70.75);
139+
view.draw();
140+
expect(view.label.textContent).toBe("Canvas X 120 · Y 71");
141+
expect(view.doc.querySelector("[data-dom-edit-gesture-readout]")).toBeNull();
142+
view.end();
143+
expect(view.label.style.display).toBe("none");
144+
});
145+
it("shows the actual size draft during resize and hides on release", () => {
146+
const view = mount("resize");
147+
view.draw();
148+
expect(view.label.textContent).toBe("100 × 60");
149+
view.update("144 × 87");
150+
view.draw();
151+
expect(view.label.textContent).toBe("144 × 87");
152+
view.end();
153+
expect(view.label.style.display).toBe("none");
154+
});
155+
it("reads the live angle during rotation and hides on cancellation", () => {
156+
const view = mount("rotate");
157+
view.update("32°");
158+
view.draw();
159+
expect(view.label.textContent).toBe("32°");
160+
view.update("-46°");
161+
view.draw();
162+
expect(view.label.textContent).toBe("-46°");
163+
view.end();
164+
expect(view.label.style.display).toBe("none");
165+
});
166+
it("clamps the label inside the visible overlay at either edge", () => {
167+
const view = mount("drag");
168+
view.move(900, -100);
169+
view.draw();
170+
expect(view.label.style.left).toBe("496px");
171+
expect(view.label.style.top).toBe("4px");
172+
view.move(-900, 900);
173+
view.draw();
174+
expect(view.label.style.left).toBe("4px");
175+
expect(view.label.style.top).toBe("396px");
176+
});
177+
});
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
import { useRef, type RefObject } from "react";
2+
import { useMountEffect } from "../../hooks/useMountEffect";
3+
import type { GestureState } from "./domEditOverlayGestures";
4+
import { subscribeOverlayFrame } from "./overlayFrameLoop";
5+
6+
type ReadoutGesture = Pick<GestureState, "readout" | "travelled">;
7+
8+
interface DomEditGestureReadoutProps {
9+
gestureRef: RefObject<ReadoutGesture | null>;
10+
overlayRef: RefObject<HTMLDivElement | null>;
11+
iframeRef: RefObject<HTMLIFrameElement | null>;
12+
}
13+
14+
function positionGestureReadout(label: HTMLDivElement, gesture: ReadoutGesture): void {
15+
const readout = gesture.readout;
16+
if (!readout) return;
17+
const bounds = readout.basis.overlayRect;
18+
const rect = readout.rect;
19+
const minX = Math.max(0, -bounds.left) + 4;
20+
const minY = Math.max(0, -bounds.top) + 4;
21+
const maxX = Math.min(bounds.width, readout.viewportWidth - bounds.left) - 4;
22+
const maxY = Math.min(bounds.height, readout.viewportHeight - bounds.top) - 4;
23+
const x = Math.max(minX, Math.min(maxX, rect.left + rect.width + 8));
24+
const y = Math.max(minY, Math.min(maxY, rect.top - 8));
25+
label.style.left = `${x}px`;
26+
label.style.top = `${y}px`;
27+
label.style.maxWidth = `${Math.max(0, maxX - minX)}px`;
28+
// CSS resolves the label's own size without a synchronous layout read after its text changes.
29+
label.style.transform = `translate(max(-100%, ${minX - x}px), max(-100%, ${minY - y}px))`;
30+
}
31+
32+
export function DomEditGestureReadout({ gestureRef }: DomEditGestureReadoutProps) {
33+
const labelRef = useRef<HTMLDivElement | null>(null);
34+
useMountEffect(() =>
35+
subscribeOverlayFrame(() => {
36+
const label = labelRef.current;
37+
if (!label) return;
38+
const gesture = gestureRef.current;
39+
const text = gesture?.travelled && gesture.readout?.text;
40+
if (!gesture || !text) {
41+
label.style.display = "none";
42+
return;
43+
}
44+
if (label.textContent !== text) label.textContent = text;
45+
label.style.display = "block";
46+
positionGestureReadout(label, gesture);
47+
}),
48+
);
49+
return (
50+
<div
51+
ref={labelRef}
52+
aria-hidden="true"
53+
data-dom-edit-gesture-readout="true"
54+
className="pointer-events-none absolute z-50 overflow-hidden rounded bg-studio-surface px-2 py-1 font-mono text-xs whitespace-nowrap text-studio-text shadow-md"
55+
style={{ display: "none" }}
56+
/>
57+
);
58+
}

‎packages/studio/src/components/editor/DomEditOverlay.tsx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ import type { ZOrderAction, ZOrderPatch } from "./canvasContextMenuZOrder";
4040
import { getPreviewTargetFromPointer } from "../../utils/studioPreviewHelpers";
4141
import { logSelect } from "../../utils/selectDebug";
4242
import { useOffCanvasIndicators } from "./useOffCanvasIndicators";
43+
import { DomEditGestureReadout } from "./DomEditGestureReadout";
4344

4445
// Re-exports for external consumers — preserving existing import paths.
4546
export {
@@ -542,6 +543,11 @@ export const DomEditOverlay = memo(function DomEditOverlay({
542543
onBoxClick={handleBoxClick}
543544
/>
544545
)}
546+
<DomEditGestureReadout
547+
gestureRef={gestureRef}
548+
overlayRef={overlayRef}
549+
iframeRef={iframeRef}
550+
/>
545551
<ChildRectOutlines rects={compRect.width > 0 ? childRects : []} />
546552
{/* Mounted here rather than with the selection chrome: the chrome does
547553
not render for every selection, and the toolbar belongs to the
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
import { computeOverlayRootScale, type OverlayRootScale } from "./domEditOverlayBasis";
2+
import type { OverlayRect } from "./domEditOverlayGeometry";
3+
4+
export interface GestureReadoutState {
5+
basis: OverlayRootScale;
6+
viewportWidth: number;
7+
viewportHeight: number;
8+
text: string;
9+
rect: OverlayRect;
10+
}
11+
12+
export function createGestureReadout(
13+
overlay: HTMLDivElement | null,
14+
iframe: HTMLIFrameElement | null,
15+
rect: OverlayRect,
16+
): GestureReadoutState | undefined {
17+
const basis =
18+
overlay && iframe && computeOverlayRootScale(overlay, iframe, iframe.contentDocument);
19+
if (!basis || basis.rootScaleX <= 0 || basis.rootScaleY <= 0) return undefined;
20+
return {
21+
basis,
22+
viewportWidth: window.innerWidth,
23+
viewportHeight: window.innerHeight,
24+
text: "",
25+
rect,
26+
};
27+
}
28+
29+
export function updateGestureReadout(
30+
readout: GestureReadoutState | undefined,
31+
rect: OverlayRect,
32+
text?: string,
33+
): void {
34+
if (!readout) return;
35+
const { basis } = readout;
36+
const x = (rect.left - (basis.iframeRect.left - basis.overlayRect.left)) / basis.rootScaleX;
37+
const y = (rect.top - (basis.iframeRect.top - basis.overlayRect.top)) / basis.rootScaleY;
38+
readout.text = text ?? `Canvas X ${Math.round(x)} · Y ${Math.round(y)}`;
39+
readout.rect = rect;
40+
}
41+
42+
export function updateGestureReadoutAngle(
43+
readout: GestureReadoutState | undefined,
44+
angle: number,
45+
): void {
46+
if (readout) updateGestureReadout(readout, readout.rect, `${Math.round(angle)}°`);
47+
}
48+
49+
export function updateGestureReadoutSize(
50+
readout: GestureReadoutState | undefined,
51+
rect: OverlayRect,
52+
size: { width: number; height: number },
53+
): void {
54+
updateGestureReadout(readout, rect, `${Math.round(size.width)} × ${Math.round(size.height)}`);
55+
}

‎packages/studio/src/components/editor/domEditOverlayGestures.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import type { GestureReadoutState } from "./domEditGestureReadoutState";
12
import type { RefObject } from "react";
23
import type { DomEditSelection } from "./domEditing";
34
import type {
@@ -47,6 +48,7 @@ const ROTATION_SNAP_DEGREES = 15;
4748
export const ROTATED_SNAP_BYPASS_DEGREES = 0.5;
4849

4950
export interface GestureState {
51+
readout?: GestureReadoutState;
5052
kind: GestureKind;
5153
mode: "path-offset" | "box-size" | "rotation";
5254
selection: DomEditSelection;
@@ -311,3 +313,13 @@ export type UseDomEditOverlayGesturesOptions = {
311313
onCanvasMouseDown: (e: React.MouseEvent<HTMLDivElement>, o?: PreviewMouseDownOptions) => void;
312314
snapGuidesRef: RefObject<SnapGuidesState | null>;
313315
};
316+
317+
export function isDomEditGestureTap(
318+
g: { startX: number; startY: number; travelled?: boolean },
319+
e: React.PointerEvent,
320+
) {
321+
return (
322+
!g.travelled &&
323+
Math.hypot(e.clientX - g.startX, e.clientY - g.startY) < BLOCKED_MOVE_THRESHOLD_PX
324+
);
325+
}

‎packages/studio/src/components/editor/domEditOverlayStartGesture.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { createGestureReadout } from "./domEditGestureReadoutState";
12
/**
23
* Gesture-begin functions: startGroupDrag and startGesture.
34
* These are pure "start a new gesture" operations — no draft rect updates.
@@ -278,6 +279,7 @@ export function startGesture(
278279
opts.rafPausedRef.current = true;
279280
opts.gestureRef.current = {
280281
kind,
282+
readout: createGestureReadout(overlayEl, iframe, rect),
281283
mode,
282284
selection: sel,
283285
pointerId: e.pointerId,

0 commit comments

Comments
 (0)