🎥 Make videos programmatically with React
Preserve sidebar reopen widths and centralize canvas refresh
Jonny Burgerf642ec5d468f
diff --git a/packages/example/e2e/sidebar-resize.test.mts b/packages/example/e2e/sidebar-resize.test.mtsindex 81eb9cf5cb..73dedc6c27 100644--- a/packages/example/e2e/sidebar-resize.test.mts+++ b/packages/example/e2e/sidebar-resize.test.mts@@ -105,6 +105,9 @@ test('sidebars can reopen during a resize and keep their last state when dragginawait page.locator(`[data-sidebar-toggle="${side}"]`).click();await expect(content).toBeVisible();await expect(icon).not.toHaveCSS('background-color', 'rgba(0, 0, 0, 0)');+ await expect+ .poll(async () => (await handle.boundingBox())?.x)+ .toBeCloseTo(restoredBox.x, 1);}const finalBox = (await handle.boundingBox())!;@@ -133,5 +136,8 @@ test('sidebars can reopen during a resize and keep their last state when dragginawait expect(content).toBeHidden();await page.locator(`[data-sidebar-toggle="${side}"]`).click();await expect(content).toBeVisible();+ await expect+ .poll(async () => (await handle.boundingBox())?.x)+ .toBeCloseTo(finalBox.x, 1);}});diff --git a/packages/studio/src/components/CanvasIfSizeIsAvailable.tsx b/packages/studio/src/components/CanvasIfSizeIsAvailable.tsxindex f78e933884..f961d8c04a 100644--- a/packages/studio/src/components/CanvasIfSizeIsAvailable.tsx+++ b/packages/studio/src/components/CanvasIfSizeIsAvailable.tsx@@ -1,10 +1,17 @@-import {useContext, useMemo} from 'react';+import {useContext, useLayoutEffect, useMemo} from 'react';import {Internals} from 'remotion';import {applyRulerInsetsToCanvasSize} from '../helpers/ruler-canvas-size';+import {RefreshCanvasSizeContext} from '../state/canvas-ref';import {CanvasOrLoading} from './CanvasOrLoading';import {useIsRulerVisible} from './EditorRuler/use-is-ruler-visible';+import {SplitterLayoutContext} from './Splitter/SplitterContext';export const CanvasIfSizeIsAvailable: React.FC = () => {+ const layout = useContext(SplitterLayoutContext);+ const refreshCanvas = useContext(RefreshCanvasSizeContext);+ useLayoutEffect(() => {+ refreshCanvas?.();+ }, [layout, refreshCanvas]);const rulersAreVisible = useIsRulerVisible();const context = useContext(Internals.CurrentScaleContext);diff --git a/packages/studio/src/components/EditorContent.tsx b/packages/studio/src/components/EditorContent.tsxindex 06e2540c33..132f86d730 100644--- a/packages/studio/src/components/EditorContent.tsx+++ b/packages/studio/src/components/EditorContent.tsx@@ -78,7 +78,11 @@ export const EditorContent: React.FC<{<SplitterElement sticky={null} type="flexer">{children}</SplitterElement>- <SplitterHandle allowToCollapse="none" onCollapse={noop} />+ <SplitterHandle+ allowToCollapse="none"+ onCollapse={noop}+ onCollapseDuringDrag={null}+ /><SplitterElement sticky={null} type="anti-flexer">{showTimeline ? <Timeline /> : <TimelineEmptyState />}</SplitterElement>diff --git a/packages/studio/src/components/Splitter/SplitterContainer.tsx b/packages/studio/src/components/Splitter/SplitterContainer.tsxindex 409181e229..8c7a546bd7 100644--- a/packages/studio/src/components/Splitter/SplitterContainer.tsx+++ b/packages/studio/src/components/Splitter/SplitterContainer.tsx@@ -6,7 +6,6 @@ import React, {useRef,useState,} from 'react';-import {drawRef, RefreshCanvasSizeContext} from '../../state/canvas-ref';import {useTimelineFlex} from '../../state/timeline';import type {SplitterDragState,@@ -59,7 +58,6 @@ export const SplitterContainer: React.FC<{id,}) => {const parentLayout = useContext(SplitterLayoutContext);- const refreshCanvas = useContext(RefreshCanvasSizeContext);const [initialTimelineFlex, persistFlex] = useTimelineFlex(id);const [flexValue, setFlexValue] = useState(initialTimelineFlex ?? defaultFlex,@@ -149,12 +147,9 @@ export const SplitterContainer: React.FC<{const refreshSize = size?.refresh;useLayoutEffect(() => {- // Remeasure only this splitter and its canvas before the layout paints.+ // Remeasure this splitter when its own or an ancestor's layout changes.refreshSize?.();- if (drawRef.current && ref.current?.contains(drawRef.current)) {- refreshCanvas?.();- }- }, [layout, refreshSize, refreshCanvas]);+ }, [layout, refreshSize]);return (<SplitterLayoutContext.Provider value={layout}>diff --git a/packages/studio/src/components/Splitter/SplitterHandle.tsx b/packages/studio/src/components/Splitter/SplitterHandle.tsxindex 847bdbb72a..5bbaef06c2 100644--- a/packages/studio/src/components/Splitter/SplitterHandle.tsx+++ b/packages/studio/src/components/Splitter/SplitterHandle.tsx@@ -1,6 +1,5 @@import React, {useContext, useEffect, useRef} from 'react';import {startCapturedPointerSession} from '../../helpers/pointer-session';-import {SidebarContext} from '../../state/sidebar';import {forceSpecificCursor,stopForcingSpecificCursor,@@ -25,8 +24,10 @@ const containerColumn: React.CSSProperties = {export const SplitterHandle: React.FC<{readonly allowToCollapse: 'right' | 'left' | 'none';readonly onCollapse: () => void;-}> = ({allowToCollapse, onCollapse}) => {- const {setSidebarCollapsedDuringDrag} = useContext(SidebarContext);+ readonly onCollapseDuringDrag:+ | ((side: 'left' | 'right' | null) => void)+ | null;+}> = ({allowToCollapse, onCollapse, onCollapseDuringDrag}) => {const context = useContext(SplitterContext);if (!context) {throw new Error('Cannot find splitter context');@@ -36,8 +37,13 @@ export const SplitterHandle: React.FC<{// Keep the latest props/context readable inside the long-lived pointerdown// listener without re-subscribing it on every render.- const latest = useRef({context, allowToCollapse, onCollapse});- latest.current = {context, allowToCollapse, onCollapse};+ const latest = useRef({+ context,+ allowToCollapse,+ onCollapse,+ onCollapseDuringDrag,+ });+ latest.current = {context, allowToCollapse, onCollapse, onCollapseDuringDrag};useEffect(() => {const {current} = ref;@@ -135,9 +141,7 @@ export const SplitterHandle: React.FC<{// the panel is hidden, so moving inward can restore it.lastCollapsedSide = getCollapsedSide(ev);lastFlex = getNewValue(ev, true);- if (latest.current.allowToCollapse !== 'none') {- setSidebarCollapsedDuringDrag(lastCollapsedSide);- }+ latest.current.onCollapseDuringDrag?.(lastCollapsedSide);dragContext.setCollapsedDuringDrag(lastCollapsedSide);dragContext.setFlexValue(lastFlex);@@ -159,16 +163,15 @@ export const SplitterHandle: React.FC<{// Capture loss and cancellation may have no usable coordinates.// Commit the last displayed state instead of resetting the panel.if (reason !== 'manual' && dragContext.isDragging.current) {- dragContext.setFlexValue(lastFlex);- dragContext.persistFlex(lastFlex);+ const savedFlex = lastCollapsedSide === null ? lastFlex : startFlex;+ dragContext.setFlexValue(savedFlex);+ dragContext.persistFlex(savedFlex);if (lastCollapsedSide !== null) {latest.current.onCollapse();}}- if (latest.current.allowToCollapse !== 'none') {- setSidebarCollapsedDuringDrag(null);- }+ latest.current.onCollapseDuringDrag?.(null);dragContext.setCollapsedDuringDrag(null);dragContext.isDragging.current = false;@@ -184,7 +187,7 @@ export const SplitterHandle: React.FC<{current.removeEventListener('pointerdown', onPointerDown);endDrag?.();};- }, [setSidebarCollapsedDuringDrag]);+ }, []);return (<divdiff --git a/packages/studio/src/components/Timeline/Timeline.tsx b/packages/studio/src/components/Timeline/Timeline.tsxindex 13b4948b57..1e51e4dd5c 100644--- a/packages/studio/src/components/Timeline/Timeline.tsx+++ b/packages/studio/src/components/Timeline/Timeline.tsx@@ -522,7 +522,11 @@ const TimelineInner: React.FC = () => {><TimelineList /></SplitterElement>- <SplitterHandle onCollapse={noop} allowToCollapse="none" />+ <SplitterHandle+ onCollapse={noop}+ onCollapseDuringDrag={null}+ allowToCollapse="none"+ /><SplitterElementtype="anti-flexer"sticky={diff --git a/packages/studio/src/components/TopPanel.tsx b/packages/studio/src/components/TopPanel.tsxindex daffd0aa7b..58ca97e917 100644--- a/packages/studio/src/components/TopPanel.tsx+++ b/packages/studio/src/components/TopPanel.tsx@@ -1,15 +1,7 @@-import React, {- useCallback,- useContext,- useEffect,- useLayoutEffect,- useMemo,- useRef,-} from 'react';+import React, {useCallback, useContext, useEffect, useMemo} from 'react';import {Internals} from 'remotion';import {useMobileLayout} from '../helpers/mobile-layout';import {useBreakpoint} from '../helpers/use-breakpoint';-import {RefreshCanvasSizeContext} from '../state/canvas-ref';import {RULER_WIDTH} from '../state/editor-rulers';import {SidebarContext} from '../state/sidebar';import {CanvasIfSizeIsAvailable} from './CanvasIfSizeIsAvailable';@@ -71,9 +63,11 @@ const TopPanelInner: React.FC<{readonly drawRef: React.Ref<HTMLDivElement>;readonly bufferStateDelayInMilliseconds: number;}> = ({readOnlyStudio, onMounted, drawRef, bufferStateDelayInMilliseconds}) => {- const {setSidebarCollapsedState, sidebarCollapsedStateRight} =- useContext(SidebarContext);- const refreshCanvas = useContext(RefreshCanvasSizeContext);+ const {+ setSidebarCollapsedState,+ sidebarCollapsedStateRight,+ setSidebarCollapsedDuringDrag,+ } = useContext(SidebarContext);const rulersAreVisible = useIsRulerVisible();const {canvasContent} = useContext(Internals.CompositionManager);@@ -87,26 +81,6 @@ const TopPanelInner: React.FC<{return 'expanded';}, [sidebarCollapsedStateRight]);- const previousSidebarState = useRef({- left: actualStateLeft,- right: actualStateRight,- });-- useLayoutEffect(() => {- if (- previousSidebarState.current.left === actualStateLeft &&- previousSidebarState.current.right === actualStateRight- ) {- return;- }-- previousSidebarState.current = {- left: actualStateLeft,- right: actualStateRight,- };- refreshCanvas?.();- }, [actualStateLeft, actualStateRight, refreshCanvas]);-useEffect(() => {onMounted();}, [onMounted]);@@ -160,6 +134,7 @@ const TopPanelInner: React.FC<{<SplitterHandleallowToCollapse="left"onCollapse={onCollapseLeft}+ onCollapseDuringDrag={setSidebarCollapsedDuringDrag}/>) : null}<SplitterElement sticky={null} type="anti-flexer">@@ -183,6 +158,7 @@ const TopPanelInner: React.FC<{<SplitterHandleallowToCollapse="right"onCollapse={onCollapseRight}+ onCollapseDuringDrag={setSidebarCollapsedDuringDrag}/>) : null}{actualStateRight === 'expanded' ? (