🎥 Make videos programmatically with React
remotion: Retain outlineRef as a deprecated no-op
Jonny Burger1d8b75bbcf6d
diff --git a/packages/core/src/Sequence.tsx b/packages/core/src/Sequence.tsxindex c7cef0a246..fed5ec46ac 100644--- a/packages/core/src/Sequence.tsx+++ b/packages/core/src/Sequence.tsx@@ -162,6 +162,10 @@ export type SequencePropsWithoutDuration = {type: 'image';src: string;};+ /**+ * @deprecated This prop has no effect. Remotion Studio discovers selection outlines automatically.+ */+ readonly outlineRef?: React.RefObject<Element | null> | null;} & LayoutAndStyle;export type SequenceProps = {diff --git a/packages/core/src/Track.tsx b/packages/core/src/Track.tsxindex 623cd859b9..40fc23a813 100644--- a/packages/core/src/Track.tsx+++ b/packages/core/src/Track.tsx@@ -23,6 +23,7 @@ export type TrackProps = Omit<| 'cropTop'| 'cropBottom'| `_remotionInternal${string}`+ | 'outlineRef'>;// A packed row has no container bar to drag. Expose its linear timing in thediff --git a/packages/core/src/test/sequence-register-once.test.tsx b/packages/core/src/test/sequence-register-once.test.tsxindex ec7ba01fe5..755ab7394c 100644--- a/packages/core/src/test/sequence-register-once.test.tsx+++ b/packages/core/src/test/sequence-register-once.test.tsx@@ -468,6 +468,53 @@ test('Sequence registers its wrapper element for Studio outlines', () => {expect(registeredSequences[0]?.refForOutline?.current).toBe(ref.current);});+test('Sequence ignores outlineRef and outlines its wrapper', () => {+ const registeredSequences: TSequence[] = [];+ const outlineRef = React.createRef<HTMLDivElement>();+ const wrapperRef = React.createRef<HTMLDivElement>();++ render(+ <SequenceTestWrapper+ onRegisterSequence={(sequence) => {+ registeredSequences.push(sequence);+ }}+ >+ <Sequence ref={wrapperRef} outlineRef={outlineRef}>+ <div ref={outlineRef}>hi</div>+ </Sequence>+ </SequenceTestWrapper>,+ );++ expect(registeredSequences[0]?.refForOutline?.current?.tagName).toBe('DIV');+ expect(registeredSequences[0]?.refForOutline?.current).toBe(+ wrapperRef.current,+ );+});++test('Sequence layout="none" ignores outlineRef and registers automatic outlines', () => {+ const registeredSequences: TSequence[] = [];+ const outlineRef = React.createRef<HTMLDivElement>();++ render(+ <SequenceTestWrapper+ onRegisterSequence={(sequence) => {+ registeredSequences.push(sequence);+ }}+ >+ <Sequence layout="none" outlineRef={outlineRef}>+ <div ref={outlineRef}>hi</div>+ </Sequence>+ </SequenceTestWrapper>,+ );++ expect(outlineRef.current).toBeInstanceOf(HTMLDivElement);+ expect(+ Internals.SequenceOutlineInternals.getNodes(+ registeredSequences[0].refForOutline!,+ ),+ ).toEqual([]);+});+test('Series inherits Sequence controls', () => {const registeredSequences: TSequence[] = [];diff --git a/packages/docs/docs/sequence.mdx b/packages/docs/docs/sequence.mdxindex 62387534b8..6688efc39d 100644--- a/packages/docs/docs/sequence.mdx+++ b/packages/docs/docs/sequence.mdx@@ -289,6 +289,13 @@ export const MyVideo = () => {};```+### ~~`outlineRef?`~~<AvailableFrom v="4.0.479" />++:::info Deprecated+This prop has no effect since <AvailableFrom v="4.0.535" inline />. Remotion Studio discovers selection outlines automatically.+Remove this prop.+:::+### `style?`<AvailableFrom v="3.0.27"/>CSS styles to be applied to the container.