Skip to content

🎥 Make videos programmatically with React

Scope splitter measurements to affected layout and canvas

Jonny Burgerfd3eae2cfb9b
diff --git a/packages/studio/src/components/Editor.tsx b/packages/studio/src/components/Editor.tsx
index b2288af799..cbabe3dae9 100644
--- a/packages/studio/src/components/Editor.tsx
+++ b/packages/studio/src/components/Editor.tsx
@@ -6,7 +6,7 @@ import {BACKGROUND} from '../helpers/colors';
import {noop} from '../helpers/noop';
import {getStudioCurrentScaleContext} from '../helpers/studio-fit-padding';
import {getStudioBufferStateDelayInMilliseconds} from '../helpers/studio-runtime-config';
-import {drawRef} from '../state/canvas-ref';
+import {drawRef, RefreshCanvasSizeContext} from '../state/canvas-ref';
import {compositionListRenderedRef} from '../state/composition-list';
import {ScaleLockProvider} from '../state/scale-lock';
import {TimelineZoomContext} from '../state/timeline-zoom';
@@ -108,33 +108,37 @@ export const Editor: React.FC<{
<HigherZIndex onEscape={noop} onOutsideClick={noop}>
<TimelineZoomContext>
<SequencePropsSubscriptionProvider>
- <Internals.CurrentScaleContext.Provider value={value}>
- <ForceSpecificCursor />
- <CanvasCaptureDropHandler readOnlyStudio={readOnlyStudio} />
- <ScaleLockProvider>
- <div style={background}>
- <Internals.CompositionRenderErrorContext.Provider
- value={compositionRenderErrorContextValue}
- >
- {canvasMounted ? (
- <RootCompositionLoader Root={MemoRoot} />
- ) : null}
- </Internals.CompositionRenderErrorContext.Provider>
- <Internals.CanUseRemotionHooksProvider>
- <RenderErrorContext.Provider value={renderErrorContextValue}>
- <EditorContent readOnlyStudio={readOnlyStudio}>
- <TopPanel
- drawRef={setDrawRef}
- bufferStateDelayInMilliseconds={getStudioBufferStateDelayInMilliseconds()}
- onMounted={onMounted}
- readOnlyStudio={readOnlyStudio}
- />
- </EditorContent>
- </RenderErrorContext.Provider>
- </Internals.CanUseRemotionHooksProvider>
- </div>
- </ScaleLockProvider>
- </Internals.CurrentScaleContext.Provider>
+ <RefreshCanvasSizeContext.Provider value={size?.refresh ?? null}>
+ <Internals.CurrentScaleContext.Provider value={value}>
+ <ForceSpecificCursor />
+ <CanvasCaptureDropHandler readOnlyStudio={readOnlyStudio} />
+ <ScaleLockProvider>
+ <div style={background}>
+ <Internals.CompositionRenderErrorContext.Provider
+ value={compositionRenderErrorContextValue}
+ >
+ {canvasMounted ? (
+ <RootCompositionLoader Root={MemoRoot} />
+ ) : null}
+ </Internals.CompositionRenderErrorContext.Provider>
+ <Internals.CanUseRemotionHooksProvider>
+ <RenderErrorContext.Provider
+ value={renderErrorContextValue}
+ >
+ <EditorContent readOnlyStudio={readOnlyStudio}>
+ <TopPanel
+ drawRef={setDrawRef}
+ bufferStateDelayInMilliseconds={getStudioBufferStateDelayInMilliseconds()}
+ onMounted={onMounted}
+ readOnlyStudio={readOnlyStudio}
+ />
+ </EditorContent>
+ </RenderErrorContext.Provider>
+ </Internals.CanUseRemotionHooksProvider>
+ </div>
+ </ScaleLockProvider>
+ </Internals.CurrentScaleContext.Provider>
+ </RefreshCanvasSizeContext.Provider>
<Modals readOnlyStudio={readOnlyStudio} />
<NotificationCenter />
</SequencePropsSubscriptionProvider>
diff --git a/packages/studio/src/components/Splitter/SplitterContainer.tsx b/packages/studio/src/components/Splitter/SplitterContainer.tsx
index 7f51f878ab..409181e229 100644
--- a/packages/studio/src/components/Splitter/SplitterContainer.tsx
+++ b/packages/studio/src/components/Splitter/SplitterContainer.tsx
@@ -1,12 +1,23 @@
import {PlayerInternals} from '@remotion/player';
-import React, {useLayoutEffect, useMemo, useRef, useState} from 'react';
+import React, {
+ useContext,
+ useLayoutEffect,
+ useMemo,
+ useRef,
+ useState,
+} from 'react';
+import {drawRef, RefreshCanvasSizeContext} from '../../state/canvas-ref';
import {useTimelineFlex} from '../../state/timeline';
import type {
SplitterDragState,
SplitterOrientation,
TSplitterContext,
} from './SplitterContext';
-import {getClampedSplitterFlex, SplitterContext} from './SplitterContext';
+import {
+ getClampedSplitterFlex,
+ SplitterContext,
+ SplitterLayoutContext,
+} from './SplitterContext';
import {SPLITTER_HANDLE_SIZE} from './SplitterHandle';
const containerRow: React.CSSProperties = {
@@ -47,6 +58,8 @@ export const SplitterContainer: React.FC<{
minAntiFlexerSize,
id,
}) => {
+ const parentLayout = useContext(SplitterLayoutContext);
+ const refreshCanvas = useContext(RefreshCanvasSizeContext);
const [initialTimelineFlex, persistFlex] = useTimelineFlex(id);
const [flexValue, setFlexValue] = useState(
initialTimelineFlex ?? defaultFlex,
@@ -112,19 +125,47 @@ export const SplitterContainer: React.FC<{
ref,
]);
+ const childCount = React.Children.toArray(children).length;
+ const layout = useMemo(
+ () => ({
+ parentLayout,
+ effectiveFlexValue,
+ collapsedDuringDrag,
+ orientation,
+ width: size?.width,
+ height: size?.height,
+ childCount,
+ }),
+ [
+ parentLayout,
+ effectiveFlexValue,
+ collapsedDuringDrag,
+ orientation,
+ size?.width,
+ size?.height,
+ childCount,
+ ],
+ );
+ const refreshSize = size?.refresh;
+
useLayoutEffect(() => {
- // Update the canvas and nested splitters before the resized layout paints.
- PlayerInternals.updateAllElementsSizes();
- });
+ // Remeasure only this splitter and its canvas before the layout paints.
+ refreshSize?.();
+ if (drawRef.current && ref.current?.contains(drawRef.current)) {
+ refreshCanvas?.();
+ }
+ }, [layout, refreshSize, refreshCanvas]);
return (
- <SplitterContext.Provider value={value}>
- <div
- ref={ref}
- style={orientation === 'horizontal' ? containerColumn : containerRow}
- >
- {children}
- </div>
- </SplitterContext.Provider>
+ <SplitterLayoutContext.Provider value={layout}>
+ <SplitterContext.Provider value={value}>
+ <div
+ ref={ref}
+ style={orientation === 'horizontal' ? containerColumn : containerRow}
+ >
+ {children}
+ </div>
+ </SplitterContext.Provider>
+ </SplitterLayoutContext.Provider>
);
};
diff --git a/packages/studio/src/components/Splitter/SplitterContext.tsx b/packages/studio/src/components/Splitter/SplitterContext.tsx
index 81a2754dfc..43b58d576c 100644
--- a/packages/studio/src/components/Splitter/SplitterContext.tsx
+++ b/packages/studio/src/components/Splitter/SplitterContext.tsx
@@ -100,3 +100,6 @@ export const SplitterContext = React.createContext<TSplitterContext>({
id: '--',
persistFlex: () => undefined,
});
+
+// Propagate layout changes only through the affected splitter subtree.
+export const SplitterLayoutContext = React.createContext<object | null>(null);
diff --git a/packages/studio/src/components/Splitter/SplitterHandle.tsx b/packages/studio/src/components/Splitter/SplitterHandle.tsx
index df2249d678..847bdbb72a 100644
--- a/packages/studio/src/components/Splitter/SplitterHandle.tsx
+++ b/packages/studio/src/components/Splitter/SplitterHandle.tsx
@@ -1,4 +1,3 @@
-import {PlayerInternals} from '@remotion/player';
import React, {useContext, useEffect, useRef} from 'react';
import {startCapturedPointerSession} from '../../helpers/pointer-session';
import {SidebarContext} from '../../state/sidebar';
@@ -175,7 +174,6 @@ export const SplitterHandle: React.FC<{
dragContext.isDragging.current = false;
stopForcingSpecificCursor();
endDrag = null;
- PlayerInternals.updateAllElementsSizes();
},
});
};
diff --git a/packages/studio/src/components/TopPanel.tsx b/packages/studio/src/components/TopPanel.tsx
index 5b28611143..daffd0aa7b 100644
--- a/packages/studio/src/components/TopPanel.tsx
+++ b/packages/studio/src/components/TopPanel.tsx
@@ -1,4 +1,3 @@
-import {PlayerInternals} from '@remotion/player';
import React, {
useCallback,
useContext,
@@ -10,6 +9,7 @@ import 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';
@@ -73,6 +73,7 @@ const TopPanelInner: React.FC<{
}> = ({readOnlyStudio, onMounted, drawRef, bufferStateDelayInMilliseconds}) => {
const {setSidebarCollapsedState, sidebarCollapsedStateRight} =
useContext(SidebarContext);
+ const refreshCanvas = useContext(RefreshCanvasSizeContext);
const rulersAreVisible = useIsRulerVisible();
const {canvasContent} = useContext(Internals.CompositionManager);
@@ -103,8 +104,8 @@ const TopPanelInner: React.FC<{
left: actualStateLeft,
right: actualStateRight,
};
- PlayerInternals.updateAllElementsSizes();
- }, [actualStateLeft, actualStateRight]);
+ refreshCanvas?.();
+ }, [actualStateLeft, actualStateRight, refreshCanvas]);
useEffect(() => {
onMounted();
diff --git a/packages/studio/src/state/canvas-ref.ts b/packages/studio/src/state/canvas-ref.ts
index d1af9cb61b..794cac0f11 100644
--- a/packages/studio/src/state/canvas-ref.ts
+++ b/packages/studio/src/state/canvas-ref.ts
@@ -1,4 +1,8 @@
-import {createRef} from 'react';
+import {createContext, createRef} from 'react';
export const canvasRef = createRef<HTMLDivElement>();
export const drawRef = createRef<HTMLDivElement>();
+
+export const RefreshCanvasSizeContext = createContext<(() => void) | null>(
+ null,
+);