Skip to content

🎥 Make videos programmatically with React

`@remotion/studio`: Ignore double-click when the second press drags the sequence

JonnyBurger85a8dc581c62
diff --git a/packages/example/e2e/double-click-drag.test.mts b/packages/example/e2e/double-click-drag.test.mts
new file mode 100644
index 0000000000..0e591e53c4
--- /dev/null
+++ b/packages/example/e2e/double-click-drag.test.mts
@@ -0,0 +1,77 @@
+import fs from 'fs';
+import path from 'path';
+import {expect, test} from '@playwright/test';
+import {EXPANDED_SIDEBAR_STATE, STUDIO_URL, exampleDir} from './constants.mts';
+import {startStudio, stopStudio} from './studio-server.mts';
+
+test.use({storageState: EXPANDED_SIDEBAR_STATE});
+
+const doubleClickDragFile = path.join(
+ exampleDir,
+ 'src',
+ 'VisualModeTests',
+ 'DoubleClickDragRepro.tsx',
+);
+
+test.describe('double-clicking a timeline sequence', () => {
+ let sourceBefore: string;
+
+ test.beforeEach(async () => {
+ sourceBefore = fs.readFileSync(doubleClickDragFile, 'utf-8');
+ await startStudio();
+ });
+
+ test.afterEach(async () => {
+ await stopStudio();
+ fs.writeFileSync(doubleClickDragFile, sourceBefore);
+ });
+
+ test('a double-click whose second press drags the sequence moves it without opening the connected composition', async ({
+ page,
+ }) => {
+ await page.goto(`${STUDIO_URL}/double-click-drag-repro`);
+ await page.waitForFunction(
+ () => !document.body.innerText.includes('Loading...'),
+ {timeout: 30_000},
+ );
+
+ const sequence = page.locator(
+ '[data-timeline-marquee-item][title="Double click drag target"]',
+ );
+ await expect(sequence).toBeVisible({timeout: 15_000});
+ const box = await sequence.boundingBox();
+ if (box === null) {
+ throw new Error('Expected the sequence to have a bounding box');
+ }
+
+ // The sequence is 30 frames wide, so box.width / 30 is one frame.
+ const fourFrames = (box.width / 30) * 4;
+ const centerX = box.x + box.width / 2;
+ const centerY = box.y + box.height / 2;
+
+ // A double-click where the second press turns into a drag: the browser
+ // still fires `dblclick` on the second release.
+ await page.mouse.move(centerX, centerY);
+ await page.mouse.down();
+ await page.mouse.up();
+ await page.mouse.down({clickCount: 2});
+ await page.mouse.move(centerX + fourFrames, centerY, {steps: 5});
+ await page.mouse.up({clickCount: 2});
+
+ // The drag committed...
+ await expect
+ .poll(() => fs.readFileSync(doubleClickDragFile, 'utf-8'), {
+ timeout: 15_000,
+ })
+ .toContain('from={6}');
+ // ...but the gesture did not open the connected composition.
+ await expect(page).toHaveURL(/double-click-drag-repro/);
+
+ // A plain double-click still opens the connected composition.
+ await expect(sequence).toBeVisible({timeout: 15_000});
+ await sequence.dblclick();
+ await expect(page).toHaveURL(/double-click-drag-child/, {
+ timeout: 15_000,
+ });
+ });
+});
diff --git a/packages/example/src/E2eTestRoot.tsx b/packages/example/src/E2eTestRoot.tsx
index b5a0bbcb4e..b2ba1ee859 100644
--- a/packages/example/src/E2eTestRoot.tsx
+++ b/packages/example/src/E2eTestRoot.tsx
@@ -19,6 +19,10 @@ import {TimelineVirtualizationTestbed} from './TimelineVirtualizationTestbed';
import {VisualControls} from './VisualControls';
import {VisualMode3D} from './VisualMode3D';
import {AffineFrameClock} from './VisualModeTests/AffineFrameClock';
+import {
+ DoubleClickDragChild,
+ DoubleClickDragRepro,
+} from './VisualModeTests/DoubleClickDragRepro';
import {OutlineSelectionCases} from './VisualModeTests/OutlineSelectionCases';
import {SequenceShiftRepro} from './VisualModeTests/SequenceShiftRepro';
@@ -208,6 +212,22 @@ export const E2eTestRoot: React.FC = () => {
fps={30}
durationInFrames={60}
/>
+ <Composition
+ id="double-click-drag-repro"
+ component={DoubleClickDragRepro}
+ width={1280}
+ height={720}
+ fps={30}
+ durationInFrames={60}
+ />
+ <Composition
+ id="double-click-drag-child"
+ component={DoubleClickDragChild}
+ width={1280}
+ height={720}
+ fps={30}
+ durationInFrames={30}
+ />
<Composition
id="timeline-virtualization-testbed"
component={TimelineVirtualizationTestbed}
diff --git a/packages/example/src/VisualModeTests/DoubleClickDragRepro.tsx b/packages/example/src/VisualModeTests/DoubleClickDragRepro.tsx
new file mode 100644
index 0000000000..e61cf23b0e
--- /dev/null
+++ b/packages/example/src/VisualModeTests/DoubleClickDragRepro.tsx
@@ -0,0 +1,15 @@
+import {AbsoluteFill, Sequence} from 'remotion';
+
+export const DoubleClickDragChild = () => {
+ return <AbsoluteFill style={{backgroundColor: 'seagreen'}} />;
+};
+
+export const DoubleClickDragRepro = () => {
+ return (
+ <AbsoluteFill style={{backgroundColor: 'black'}}>
+ <Sequence name="Double click drag target" from={2} durationInFrames={30}>
+ <DoubleClickDragChild />
+ </Sequence>
+ </AbsoluteFill>
+ );
+};
diff --git a/packages/studio/src/components/SelectedOutlineElement.tsx b/packages/studio/src/components/SelectedOutlineElement.tsx
index 7ecd5bbf43..29b1f82604 100644
--- a/packages/studio/src/components/SelectedOutlineElement.tsx
+++ b/packages/studio/src/components/SelectedOutlineElement.tsx
@@ -145,6 +145,7 @@ const SelectedOutlineElementUnmemoized: React.FC<
button,
canOpenInEditor: editorAvailable,
numberOfConnectedCompositions: connectedCompositions.length,
+ sequenceWasDragged: false,
});
if (action === null) {
diff --git a/packages/studio/src/components/Timeline/TimelineSequence.tsx b/packages/studio/src/components/Timeline/TimelineSequence.tsx
index 9dfc85eb94..f4a2ec777e 100644
--- a/packages/studio/src/components/Timeline/TimelineSequence.tsx
+++ b/packages/studio/src/components/Timeline/TimelineSequence.tsx
@@ -57,6 +57,7 @@ import {
import {TimelineSequenceFrame} from './TimelineSequenceFrame';
import {
canResizeTimelineSequenceDuration,
+ didTimelineSequenceDragJustMove,
isCascadingSequence,
isTimelineSequenceDurationDraggable,
isTimelineSequenceLeftEdgeDraggable,
@@ -351,6 +352,7 @@ const TimelineSequenceInner: React.FC<{
button: e.button,
canOpenInEditor,
numberOfConnectedCompositions: connectedCompositions.length,
+ sequenceWasDragged: didTimelineSequenceDragJustMove(),
});
if (action === null) {
return;
diff --git a/packages/studio/src/components/Timeline/TimelineSequenceItem.tsx b/packages/studio/src/components/Timeline/TimelineSequenceItem.tsx
index b52f93f5ec..ea6fc87691 100644
--- a/packages/studio/src/components/Timeline/TimelineSequenceItem.tsx
+++ b/packages/studio/src/components/Timeline/TimelineSequenceItem.tsx
@@ -782,6 +782,9 @@ const TimelineSequenceItemInner: React.FC<{
button: e.button,
canOpenInEditor,
numberOfConnectedCompositions: connectedCompositions.length,
+ // The track list row reorders via native drag-and-drop, which
+ // already suppresses `dblclick` after a drag.
+ sequenceWasDragged: false,
});
if (action === null) {
return;
diff --git a/packages/studio/src/components/Timeline/TimelineSequenceRightEdgeDragHandle.tsx b/packages/studio/src/components/Timeline/TimelineSequenceRightEdgeDragHandle.tsx
index d0a42a0d14..468d745072 100644
--- a/packages/studio/src/components/Timeline/TimelineSequenceRightEdgeDragHandle.tsx
+++ b/packages/studio/src/components/Timeline/TimelineSequenceRightEdgeDragHandle.tsx
@@ -49,6 +49,18 @@ import {
const HANDLE_WIDTH = 6;
export const timelineSequenceFromDragSnapThresholdPx = 10;
+// The browser fires `dblclick` even if the second press of a double-click
+// turned into a drag. Double-click handlers consult this to ignore those
+// gestures.
+let lastSequenceDragEnd = {endedAt: 0, moved: false};
+
+const markSequenceDragEnd = (moved: boolean) => {
+ lastSequenceDragEnd = {endedAt: Date.now(), moved};
+};
+
+export const didTimelineSequenceDragJustMove = () =>
+ lastSequenceDragEnd.moved && Date.now() - lastSequenceDragEnd.endedAt < 500;
+
const baseStyle: React.CSSProperties = {
position: 'absolute',
top: 0,
@@ -1095,6 +1107,7 @@ const TimelineSequenceLeftEdgeDragHandleInner: React.FC<{
const dragStateRef = useRef<{
initialClientX: number;
latestDeltaFrames: number;
+ didMove: boolean;
pxPerFrame: number;
pointerId: number;
button: number;
@@ -1126,6 +1139,7 @@ const TimelineSequenceLeftEdgeDragHandleInner: React.FC<{
}
dragStateRef.current = null;
+ markSequenceDragEnd(dragState.didMove);
document.body.style.userSelect = '';
document.body.style.webkitUserSelect = '';
stopForcingSpecificCursor();
@@ -1221,6 +1235,7 @@ const TimelineSequenceLeftEdgeDragHandleInner: React.FC<{
dragStateRef.current = {
initialClientX: e.clientX,
latestDeltaFrames: 0,
+ didMove: false,
pxPerFrame,
pointerId: e.pointerId,
button: e.button,
@@ -1256,6 +1271,10 @@ const TimelineSequenceLeftEdgeDragHandleInner: React.FC<{
const dx = e.clientX - dragState.initialClientX;
const deltaFrames = Math.round(dx / dragState.pxPerFrame);
dragState.latestDeltaFrames = deltaFrames;
+ if (deltaFrames !== 0) {
+ dragState.didMove = true;
+ }
+
for (const target of dragState.targets) {
const nextValues = getTimelineSequenceLeftEdgeDragValues({
initialDuration: target.initialDuration,
@@ -1380,6 +1399,7 @@ export const useTimelineSequenceFromDrag = ({
const dragStateRef = useRef<{
initialClientX: number;
latestDeltaFrames: number;
+ didMove: boolean;
pxPerFrame: number;
pointerId: number;
button: number;
@@ -1417,6 +1437,7 @@ export const useTimelineSequenceFromDrag = ({
}
dragStateRef.current = null;
+ markSequenceDragEnd(dragState.didMove);
document.body.style.userSelect = '';
document.body.style.webkitUserSelect = '';
setDragging(false);
@@ -1526,6 +1547,7 @@ export const useTimelineSequenceFromDrag = ({
dragStateRef.current = {
initialClientX: e.clientX,
latestDeltaFrames: 0,
+ didMove: false,
pxPerFrame,
pointerId: e.pointerId,
button: e.button,
@@ -1565,6 +1587,10 @@ export const useTimelineSequenceFromDrag = ({
targets: dragState.targets,
});
dragState.latestDeltaFrames = deltaFrames;
+ if (deltaFrames !== 0) {
+ dragState.didMove = true;
+ }
+
for (const target of dragState.targets) {
const nextFrom = getTimelineSequenceFromDragValue({
initialFrom: target.initialFrom,
@@ -1678,6 +1704,7 @@ const TimelineSequenceRightEdgeDragHandleInner: React.FC<{
const dragStateRef = useRef<{
initialClientX: number;
latestDeltaFrames: number;
+ didMove: boolean;
pxPerFrame: number;
pointerId: number;
button: number;
@@ -1710,6 +1737,7 @@ const TimelineSequenceRightEdgeDragHandleInner: React.FC<{
}
dragStateRef.current = null;
+ markSequenceDragEnd(dragState.didMove);
document.body.style.userSelect = '';
document.body.style.webkitUserSelect = '';
stopForcingSpecificCursor();
@@ -1803,6 +1831,7 @@ const TimelineSequenceRightEdgeDragHandleInner: React.FC<{
dragStateRef.current = {
initialClientX: e.clientX,
latestDeltaFrames: 0,
+ didMove: false,
pxPerFrame,
pointerId: e.pointerId,
button: e.button,
@@ -1841,6 +1870,10 @@ const TimelineSequenceRightEdgeDragHandleInner: React.FC<{
const dx = e.clientX - dragState.initialClientX;
const deltaFrames = Math.round(dx / dragState.pxPerFrame);
dragState.latestDeltaFrames = deltaFrames;
+ if (deltaFrames !== 0) {
+ dragState.didMove = true;
+ }
+
for (const target of dragState.targets) {
latestRef.current.setDragOverrides(
target.nodePath,
diff --git a/packages/studio/src/helpers/get-sequence-double-click-action.ts b/packages/studio/src/helpers/get-sequence-double-click-action.ts
index 737e9ee6cd..dc1e2e3ad7 100644
--- a/packages/studio/src/helpers/get-sequence-double-click-action.ts
+++ b/packages/studio/src/helpers/get-sequence-double-click-action.ts
@@ -8,11 +8,20 @@ export const getSequenceDoubleClickAction = ({
button,
canOpenInEditor,
numberOfConnectedCompositions,
+ sequenceWasDragged,
}: {
readonly button: number;
readonly canOpenInEditor: boolean;
readonly numberOfConnectedCompositions: number;
+ readonly sequenceWasDragged: boolean;
}): SequenceDoubleClickAction | null => {
+ // The browser still fires `dblclick` when the second press of a
+ // double-click turned into a drag. That gesture is a drag, not a
+ // double-click.
+ if (sequenceWasDragged) {
+ return null;
+ }
+
if (button !== 0) {
return null;
}
diff --git a/packages/studio/src/test/timeline-selection.test.ts b/packages/studio/src/test/timeline-selection.test.ts
index a786de345b..4d4c10f73a 100644
--- a/packages/studio/src/test/timeline-selection.test.ts
+++ b/packages/studio/src/test/timeline-selection.test.ts
@@ -3168,6 +3168,7 @@ test('Sequence double-click opens one connected composition before the editor',
button: 0,
canOpenInEditor: true,
numberOfConnectedCompositions: 1,
+ sequenceWasDragged: false,
}),
).toBe('open-connected-composition');
expect(
@@ -3175,6 +3176,7 @@ test('Sequence double-click opens one connected composition before the editor',
button: 0,
canOpenInEditor: false,
numberOfConnectedCompositions: 1,
+ sequenceWasDragged: false,
}),
).toBe('open-connected-composition');
expect(
@@ -3182,6 +3184,7 @@ test('Sequence double-click opens one connected composition before the editor',
button: 0,
canOpenInEditor: true,
numberOfConnectedCompositions: 0,
+ sequenceWasDragged: false,
}),
).toBe('open-in-editor');
expect(
@@ -3189,6 +3192,7 @@ test('Sequence double-click opens one connected composition before the editor',
button: 0,
canOpenInEditor: true,
numberOfConnectedCompositions: 2,
+ sequenceWasDragged: false,
}),
).toBe('open-in-editor');
expect(
@@ -3196,6 +3200,7 @@ test('Sequence double-click opens one connected composition before the editor',
button: 0,
canOpenInEditor: false,
numberOfConnectedCompositions: 2,
+ sequenceWasDragged: false,
}),
).toBeNull();
expect(
@@ -3203,6 +3208,26 @@ test('Sequence double-click opens one connected composition before the editor',
button: 2,
canOpenInEditor: true,
numberOfConnectedCompositions: 1,
+ sequenceWasDragged: false,
+ }),
+ ).toBeNull();
+});
+
+test('Sequence double-click does nothing when the second press dragged the sequence', () => {
+ expect(
+ getSequenceDoubleClickAction({
+ button: 0,
+ canOpenInEditor: true,
+ numberOfConnectedCompositions: 1,
+ sequenceWasDragged: true,
+ }),
+ ).toBeNull();
+ expect(
+ getSequenceDoubleClickAction({
+ button: 0,
+ canOpenInEditor: true,
+ numberOfConnectedCompositions: 0,
+ sequenceWasDragged: true,
}),
).toBeNull();
});