Skip to content

🎥 Make videos programmatically with React

`@remotion/studio`: Avoid timeline jumps when selecting tracks

JonnyBurger5af2b3b79e59
diff --git a/packages/example/e2e/studio.test.mts b/packages/example/e2e/studio.test.mts
index 160504cd99..da40a18a50 100644
--- a/packages/example/e2e/studio.test.mts
+++ b/packages/example/e2e/studio.test.mts
@@ -165,6 +165,51 @@ test.describe('visual mode', () => {
const mountedTrackLabels = page.getByText(/^Virtual track \d{3}$/);
expect(await mountedTrackLabels.count()).toBeLessThan(120);
+ const waitForScrollEffects = () =>
+ page.evaluate(
+ () =>
+ new Promise<void>((resolve) =>
+ requestAnimationFrame(() => requestAnimationFrame(() => resolve())),
+ ),
+ );
+
+ await timelineScroll.evaluate((element) => {
+ element.scrollTop = 600;
+ });
+ const directlySelectedTrack = page.locator(
+ '[data-timeline-marquee-item][title="Virtual track 020"]',
+ );
+ await expect(directlySelectedTrack).toBeVisible();
+ await directlySelectedTrack.evaluate((element) => {
+ element.scrollIntoView({block: 'start'});
+ });
+ await timelineScroll.evaluate((element) => {
+ element.scrollTop -= 50;
+ });
+ const [directlySelectedTrackRect, timelineScrollRectBeforeSelection] =
+ await Promise.all([
+ directlySelectedTrack.boundingBox(),
+ timelineScroll.boundingBox(),
+ ]);
+ expect(directlySelectedTrackRect).not.toBeNull();
+ expect(timelineScrollRectBeforeSelection).not.toBeNull();
+ expect(directlySelectedTrackRect!.y).toBeGreaterThan(
+ timelineScrollRectBeforeSelection!.y,
+ );
+ expect(
+ directlySelectedTrackRect!.y + directlySelectedTrackRect!.height,
+ ).toBeLessThan(
+ timelineScrollRectBeforeSelection!.y +
+ timelineScrollRectBeforeSelection!.height,
+ );
+ const scrollTopBeforeDirectSelection = await timelineScroll.evaluate(
+ (element) => element.scrollTop,
+ );
+ await directlySelectedTrack.click();
+ await waitForScrollEffects();
+ expect(await timelineScroll.evaluate((element) => element.scrollTop)).toBe(
+ scrollTopBeforeDirectSelection,
+ );
const revealTargetTrack = page.locator(
'[data-timeline-marquee-item][title="Reveal target"]',
@@ -174,9 +219,23 @@ test.describe('visual mode', () => {
const visibleOutlines = canvas.locator(
'> svg[aria-hidden="true"] polygon[stroke="#0b84f3"][stroke-opacity="1"]',
);
- await canvas.hover();
+ const canvasRevealTarget = canvas.getByText('Reveal target', {exact: true});
+ await expect(canvasRevealTarget).toBeVisible();
+ const canvasRevealTargetRect = await canvasRevealTarget.boundingBox();
+ expect(canvasRevealTargetRect).not.toBeNull();
+ const canvasRevealTargetCenter = {
+ x: canvasRevealTargetRect!.x + canvasRevealTargetRect!.width / 2,
+ y: canvasRevealTargetRect!.y + canvasRevealTargetRect!.height / 2,
+ };
+ await page.mouse.move(
+ canvasRevealTargetCenter.x,
+ canvasRevealTargetCenter.y,
+ );
await expect.poll(() => visibleOutlines.count()).toBeGreaterThan(0);
- await visibleOutlines.first().click({force: true});
+ await page.mouse.click(
+ canvasRevealTargetCenter.x,
+ canvasRevealTargetCenter.y,
+ );
await expect(revealTargetTrack).toBeVisible();
const [revealTargetRect, timelineScrollRect] = await Promise.all([
@@ -190,11 +249,40 @@ test.describe('visual mode', () => {
timelineScrollRect!.y + timelineScrollRect!.height,
);
await expect(
- page.getByText('Virtual track 119', {exact: true}),
- ).toBeVisible();
- await expect(
- page.locator('[data-timeline-marquee-item][title="Virtual track 119"]'),
+ page.getByText('Virtual track 060', {exact: true}),
).toBeVisible();
+ const revealedParentTrack = page.locator(
+ '[data-timeline-marquee-item][title="Virtual track 060"]',
+ );
+ await expect(revealedParentTrack).toBeVisible();
+ await revealedParentTrack.evaluate((element) => {
+ element.scrollIntoView({block: 'start'});
+ });
+ await timelineScroll.evaluate((element) => {
+ element.scrollTop -= 50;
+ });
+ const adjacentTrack = page.locator(
+ '[data-timeline-marquee-item][title="Virtual track 061"]',
+ );
+ await expect(adjacentTrack).toBeVisible();
+ await adjacentTrack.click();
+ await waitForScrollEffects();
+ const scrollTopBeforeVisibleCanvasSelection = await timelineScroll.evaluate(
+ (element) => element.scrollTop,
+ );
+ await page.mouse.move(
+ canvasRevealTargetCenter.x,
+ canvasRevealTargetCenter.y,
+ );
+ await expect.poll(() => visibleOutlines.count()).toBeGreaterThan(0);
+ await page.mouse.click(
+ canvasRevealTargetCenter.x,
+ canvasRevealTargetCenter.y,
+ );
+ await waitForScrollEffects();
+ expect(await timelineScroll.evaluate((element) => element.scrollTop)).toBe(
+ scrollTopBeforeVisibleCanvasSelection,
+ );
expect(
await timelineScroll.evaluate((element) => element.scrollTop),
).toBeGreaterThan(0);
diff --git a/packages/example/src/TimelineVirtualizationTestbed.tsx b/packages/example/src/TimelineVirtualizationTestbed.tsx
index 0b5d9aea5f..5e91cdd06c 100644
--- a/packages/example/src/TimelineVirtualizationTestbed.tsx
+++ b/packages/example/src/TimelineVirtualizationTestbed.tsx
@@ -186,8 +186,24 @@ export const TimelineVirtualizationTestbed: React.FC = () => {
<Sequence durationInFrames={30} name="Virtual track 059">
<AbsoluteFill />
</Sequence>
- <Sequence durationInFrames={30} name="Virtual track 060">
- <AbsoluteFill />
+ <Sequence
+ durationInFrames={30}
+ name="Virtual track 060"
+ style={{zIndex: 1}}
+ >
+ <Interactive.Div
+ name="Reveal target"
+ style={{
+ backgroundColor: 'red',
+ height: 100,
+ left: 100,
+ position: 'absolute',
+ top: 100,
+ width: 100,
+ }}
+ >
+ Reveal target
+ </Interactive.Div>
</Sequence>
<Sequence durationInFrames={30} name="Virtual track 061">
<AbsoluteFill />
@@ -364,19 +380,7 @@ export const TimelineVirtualizationTestbed: React.FC = () => {
<AbsoluteFill />
</Sequence>
<Sequence durationInFrames={30} name="Virtual track 119">
- <Interactive.Div
- name="Reveal target"
- style={{
- backgroundColor: 'red',
- height: 100,
- left: 100,
- position: 'absolute',
- top: 100,
- width: 100,
- }}
- >
- Reveal target
- </Interactive.Div>
+ <AbsoluteFill />
</Sequence>
</>
);
diff --git a/packages/studio/src/components/Timeline/TimelineSelection.tsx b/packages/studio/src/components/Timeline/TimelineSelection.tsx
index 7a0a0a4852..9c7848d626 100644
--- a/packages/studio/src/components/Timeline/TimelineSelection.tsx
+++ b/packages/studio/src/components/Timeline/TimelineSelection.tsx
@@ -1751,7 +1751,6 @@ export const useTimelineRowSelection = (
selectionItem,
interaction,
selectableTimelineItemsRef.current,
- {reveal: true},
);
},
[selectItem, selectableTimelineItemsRef, selectionItem],
diff --git a/packages/studio/src/components/Timeline/TimelineVirtualization.tsx b/packages/studio/src/components/Timeline/TimelineVirtualization.tsx
index 43aa5972dc..863bf383e8 100644
--- a/packages/studio/src/components/Timeline/TimelineVirtualization.tsx
+++ b/packages/studio/src/components/Timeline/TimelineVirtualization.tsx
@@ -186,7 +186,7 @@ export const TimelineVirtualizationProvider: React.FC<{
const key = getSelectionTrackKey(revealRequest.item);
const index = key === null ? undefined : layout.rootTrackIndexes.get(key);
if (index !== undefined) {
- virtualizer.scrollToIndex(index, {align: 'center'});
+ virtualizer.scrollToIndex(index, {align: 'auto'});
}
}, [layout.rootTrackIndexes, revealRequest, virtualizer]);