Skip to content

🎥 Make videos programmatically with React

`@remotion/studio`: Ignore right clicks in double-click gestures

JonnyBurgere68c9bbf6e95
diff --git a/packages/example/e2e/timeline-right-edge.test.mts b/packages/example/e2e/timeline-right-edge.test.mts
index f64edfe51f..ccfd3cd16a 100644
--- a/packages/example/e2e/timeline-right-edge.test.mts
+++ b/packages/example/e2e/timeline-right-edge.test.mts
@@ -118,6 +118,30 @@ export const E2eTestRoot = () => <Composition id="timeline-edges" component={Lay
const movableLayer = page.locator(
'[data-timeline-marquee-item][title="Natural end"]',
);
+ await movableLayer.dispatchEvent('pointerdown', {
+ button: 2,
+ buttons: 2,
+ pointerId: 1,
+ });
+ await movableLayer.dispatchEvent('pointerup', {
+ button: 2,
+ buttons: 0,
+ pointerId: 1,
+ });
+ await movableLayer.dispatchEvent('pointerdown', {
+ button: 0,
+ buttons: 1,
+ pointerId: 1,
+ });
+ await movableLayer.dispatchEvent('pointerup', {
+ button: 0,
+ buttons: 0,
+ pointerId: 1,
+ });
+ await movableLayer.dispatchEvent('dblclick', {button: 0, detail: 2});
+ await page.waitForTimeout(100);
+ expect(openInEditorRequests).toHaveLength(0);
+
await movableLayer.dblclick({position: {x: 30, y: 10}});
await expect.poll(() => openInEditorRequests.length).toBe(1);
diff --git a/packages/studio/src/components/SelectedOutlinePolygon.tsx b/packages/studio/src/components/SelectedOutlinePolygon.tsx
index 5c38878c16..30143b7cf1 100644
--- a/packages/studio/src/components/SelectedOutlinePolygon.tsx
+++ b/packages/studio/src/components/SelectedOutlinePolygon.tsx
@@ -493,6 +493,10 @@ const SelectedOutlinePolygonUnmemoized: React.FC<{
const onDoubleClick = React.useCallback(
(event: React.MouseEvent<SVGPolygonElement>) => {
+ if (!dragAwareDoubleClick.doubleClickWasPrimary()) {
+ return;
+ }
+
const target = getTarget();
if (target === undefined) {
return;
diff --git a/packages/studio/src/components/Timeline/TimelineRowChrome.tsx b/packages/studio/src/components/Timeline/TimelineRowChrome.tsx
index 248f890498..f90ad36061 100644
--- a/packages/studio/src/components/Timeline/TimelineRowChrome.tsx
+++ b/packages/studio/src/components/Timeline/TimelineRowChrome.tsx
@@ -1,5 +1,6 @@
import React, {useCallback, useContext, useMemo} from 'react';
import {TIMELINE_TRACK_SEPARATOR} from '../../helpers/colors';
+import {createDragAwareDoubleClickTracker} from '../../helpers/drag-aware-double-click';
import {Padder} from './Padder';
import {
getTimelineRowIndentWidth,
@@ -107,6 +108,10 @@ export const TimelineRowChrome: React.FC<{
TimelineRowLayoutContext,
);
const selectedBackground = useContext(TimelineRowSelectedBackgroundContext);
+ const doubleClickTracker = useMemo(
+ () => createDragAwareDoubleClickTracker(),
+ [],
+ );
const indentWidth = getTimelineRowIndentWidth(depth);
const chromeColumnStyle = useMemo(
@@ -145,6 +150,10 @@ export const TimelineRowChrome: React.FC<{
const onDoubleClickIfNotInteractive = useCallback(
(e: React.MouseEvent<HTMLDivElement>) => {
+ if (!doubleClickTracker.doubleClickWasPrimary()) {
+ return;
+ }
+
const {target} = e;
if (
target instanceof Element &&
@@ -160,7 +169,7 @@ export const TimelineRowChrome: React.FC<{
onDoubleClick?.(e);
},
- [onDoubleClick],
+ [doubleClickTracker, onDoubleClick],
);
const highlightBackground = getTimelineRowHighlightBackground({
@@ -229,6 +238,7 @@ export const TimelineRowChrome: React.FC<{
onDragLeave={onDragLeave}
onDragOver={onDragOver}
onDrop={onDrop}
+ onPointerDownCapture={doubleClickTracker.beginPointerGesture}
onPointerDown={selectable ? onPointerDown : undefined}
onContextMenu={selectable ? onContextMenu : undefined}
onDoubleClick={onDoubleClickIfNotInteractive}
@@ -245,6 +255,7 @@ export const TimelineRowChrome: React.FC<{
onDragLeave={onDragLeave}
onDragOver={onDragOver}
onDrop={onDrop}
+ onPointerDownCapture={doubleClickTracker.beginPointerGesture}
onPointerDown={selectable ? onPointerDown : undefined}
onContextMenu={selectable ? onContextMenu : undefined}
onDoubleClick={onDoubleClickIfNotInteractive}
diff --git a/packages/studio/src/components/Timeline/TimelineSequence.tsx b/packages/studio/src/components/Timeline/TimelineSequence.tsx
index 9f0c84794a..45de338c94 100644
--- a/packages/studio/src/components/Timeline/TimelineSequence.tsx
+++ b/packages/studio/src/components/Timeline/TimelineSequence.tsx
@@ -190,7 +190,7 @@ const TimelineSequenceCurrentFrame: React.FC<{
readonly onMoveDragPointerDown: (
e: React.PointerEvent<HTMLDivElement>,
) => void;
- readonly onPointerDownCapture: () => void;
+ readonly onPointerDownCapture: React.PointerEventHandler<HTMLDivElement>;
readonly onDoubleClick?: (e: React.MouseEvent<HTMLDivElement>) => void;
}> = ({
s,
@@ -540,6 +540,9 @@ const TimelineSequenceInner: React.FC<{
e.stopPropagation();
return;
}
+ if (!dragAwareDoubleClick.doubleClickWasPrimary()) {
+ return;
+ }
const action = getSequenceDoubleClickAction({
button: e.button,
diff --git a/packages/studio/src/helpers/drag-aware-double-click.ts b/packages/studio/src/helpers/drag-aware-double-click.ts
index f73924f008..793262ba84 100644
--- a/packages/studio/src/helpers/drag-aware-double-click.ts
+++ b/packages/studio/src/helpers/drag-aware-double-click.ts
@@ -1,16 +1,21 @@
export type DragAwareDoubleClickTracker = {
- readonly beginPointerGesture: () => void;
+ readonly beginPointerGesture: (event: Pick<PointerEvent, 'button'>) => void;
readonly endPointerGesture: (wasDragged: boolean) => void;
readonly consumePointerGestureWasDragged: () => boolean;
+ readonly doubleClickWasPrimary: () => boolean;
};
export const createDragAwareDoubleClickTracker =
(): DragAwareDoubleClickTracker => {
let pointerGestureWasDragged = false;
+ let previousPointerButton: number | null = null;
+ let currentPointerButton: number | null = null;
return {
- beginPointerGesture: () => {
+ beginPointerGesture: (event) => {
pointerGestureWasDragged = false;
+ previousPointerButton = currentPointerButton;
+ currentPointerButton = event.button;
},
endPointerGesture: (wasDragged) => {
pointerGestureWasDragged = wasDragged;
@@ -20,5 +25,8 @@ export const createDragAwareDoubleClickTracker =
pointerGestureWasDragged = false;
return wasDragged;
},
+ doubleClickWasPrimary: () => {
+ return previousPointerButton === 0 && currentPointerButton === 0;
+ },
};
};
diff --git a/packages/studio/src/test/drag-aware-double-click.test.ts b/packages/studio/src/test/drag-aware-double-click.test.ts
index fdf8bcc8a0..92e6b4ba15 100644
--- a/packages/studio/src/test/drag-aware-double-click.test.ts
+++ b/packages/studio/src/test/drag-aware-double-click.test.ts
@@ -4,14 +4,25 @@ import {createDragAwareDoubleClickTracker} from '../helpers/drag-aware-double-cl
test('Drag-aware double clicks consume the drag from the current pointer gesture', () => {
const tracker = createDragAwareDoubleClickTracker();
- tracker.beginPointerGesture();
+ tracker.beginPointerGesture({button: 0});
tracker.endPointerGesture(true);
expect(tracker.consumePointerGestureWasDragged()).toBe(true);
expect(tracker.consumePointerGestureWasDragged()).toBe(false);
- tracker.beginPointerGesture();
+ tracker.beginPointerGesture({button: 0});
tracker.endPointerGesture(true);
- tracker.beginPointerGesture();
+ tracker.beginPointerGesture({button: 0});
tracker.endPointerGesture(false);
expect(tracker.consumePointerGestureWasDragged()).toBe(false);
});
+
+test('Double clicks require two primary-button pointer gestures', () => {
+ const tracker = createDragAwareDoubleClickTracker();
+
+ tracker.beginPointerGesture({button: 2});
+ tracker.beginPointerGesture({button: 0});
+ expect(tracker.doubleClickWasPrimary()).toBe(false);
+
+ tracker.beginPointerGesture({button: 0});
+ expect(tracker.doubleClickWasPrimary()).toBe(true);
+});