Skip to content

🎥 Make videos programmatically with React

`@remotion/gsap`: Fix delayed `fromTo` leaving from-values behind on remount

Fats4031a3dcba4e60a
diff --git a/packages/gsap/src/test/use-gsap-timeline.test.tsx b/packages/gsap/src/test/use-gsap-timeline.test.tsx
index 72a2347575..03817ab168 100644
--- a/packages/gsap/src/test/use-gsap-timeline.test.tsx
+++ b/packages/gsap/src/test/use-gsap-timeline.test.tsx
@@ -165,6 +165,87 @@ describe('useGsapTimeline', () => {
expect(opacity(container.querySelector('[data-box]')!)).toBeCloseTo(0.6, 4);
});
+ it('restores React styles under a delayed fromTo across Strict Mode remounts', async () => {
+ // fromTo with immediateRender: false is the one tween GSAP's own
+ // context.revert() undid into its from-values, so every remount on the
+ // same element started from the previous mount's from-state.
+ const DelayedHarness = () => {
+ const scope = useGsapTimeline<HTMLDivElement>(({timeline, selector}) => {
+ timeline.fromTo(
+ selector('[data-delayed]'),
+ {opacity: 0.2, yPercent: 60},
+ {
+ opacity: 1,
+ yPercent: 0,
+ duration: 0.5,
+ ease: 'none',
+ immediateRender: false,
+ },
+ 1,
+ );
+ });
+
+ return (
+ <div ref={scope}>
+ <div data-delayed style={{opacity: 0.25}} />
+ </div>
+ );
+ };
+
+ await setFrame(
+ 0,
+ <StrictMode>
+ <DelayedHarness />
+ </StrictMode>,
+ );
+ const delayed = container.querySelector('[data-delayed]') as HTMLElement;
+ expect(opacity(delayed)).toBeCloseTo(0.25, 4);
+
+ await setFrame(
+ 60,
+ <StrictMode>
+ <DelayedHarness />
+ </StrictMode>,
+ );
+ expect(opacity(delayed)).toBeCloseTo(1, 4);
+ expect(gsap.getProperty(delayed, 'y')).toBe(0);
+ expect(gsap.getProperty(delayed, 'yPercent')).toBe(0);
+ });
+
+ it('leaves no from-values behind when a delayed fromTo rebuilds from dependencies', async () => {
+ const RebuildHarness = ({distance}: {readonly distance: number}) => {
+ const scope = useGsapTimeline<HTMLDivElement>(
+ ({timeline, selector}) => {
+ timeline.fromTo(
+ selector('[data-rebuilt]'),
+ {opacity: 0.2},
+ {
+ opacity: distance,
+ duration: 0.5,
+ ease: 'none',
+ immediateRender: false,
+ },
+ 1,
+ );
+ },
+ {dependencies: [distance]},
+ );
+
+ return (
+ <div ref={scope}>
+ <div data-rebuilt style={{opacity: 0.25}} />
+ </div>
+ );
+ };
+
+ await setFrame(45, <RebuildHarness distance={1} />);
+ await setFrame(0, <RebuildHarness distance={0.8} />);
+ expect(opacity(container.querySelector('[data-rebuilt]')!)).toBeCloseTo(
+ 0.25,
+ 4,
+ );
+ });
+
it('clamps premount frames to the start state', async () => {
await setFrame(-20, <Harness distance={1} />);
expect(opacity(container.querySelector('[data-box]')!)).toBeCloseTo(0, 4);
diff --git a/packages/gsap/src/use-gsap-timeline.ts b/packages/gsap/src/use-gsap-timeline.ts
index f92e87b4e7..601621b24f 100644
--- a/packages/gsap/src/use-gsap-timeline.ts
+++ b/packages/gsap/src/use-gsap-timeline.ts
@@ -540,7 +540,15 @@ export const useGsapTimeline = <T extends Element>(
// Builders only describe motion. Reassert package ownership of playback.
state.controls.pause();
+ });
+ // Prime outside the context. Seeking makes GSAP create tweens of its
+ // own (the start state of a fromTo with immediateRender: false). Once
+ // the context records them, context.revert() undoes them before the
+ // tween that owns them, and the owner's revert then puts its
+ // from-values back on the element, where the next mount reads them as
+ // the element's own style. Left to their owners, they revert in order.
+ if (state.timeline && state.controls) {
// A fresh timeline is not path-independent: zero-duration tweens at
// the playhead render only once passed, and overlapping tweens
// record start values lazily at the first visited frame. Sweep the
@@ -582,7 +590,7 @@ export const useGsapTimeline = <T extends Element>(
state.controls.renderAt(
frameToSeconds(frameRef.current, fpsRef.current),
);
- });
+ }
controlsRef.current = state.controls;
} catch (error) {