react-native-screen-transitions 3.9.0-beta.3 → 3.10.0

package/src/shared/utils/animation/animate-to-progress.ts

@@ -16,6 +16,7 @@ interface AnimateToProgressProps {
 	onAnimationFinish?: (finished: boolean) => void;
 	animations: AnimationStoreMap;
 	targetProgress: SharedValue<number>;
+	animationProgress: SharedValue<number>;
 	emitWillAnimate?: boolean;
 	markEntering?: boolean;
 	/** Optional initial velocity for spring-based progress (units: progress/sec). */
@@ -35,17 +36,31 @@ const setTransitionLifecycleFlags = (
 		return;
 	}
 
+	animations.closing.set(FALSE);
+
 	if (markEntering) {
 		animations.entering.set(TRUE);
 	}
 };
 
+export const resolveAnimationProgressRange = (
+	currentProgress: number,
+	targetProgress: number,
+) => {
+	"worklet";
+	return {
+		from: Math.min(1, Math.max(0, currentProgress)),
+		to: targetProgress,
+	};
+};
+
 export const animateToProgress = ({
 	target,
 	spec,
 	onAnimationFinish,
 	animations,
 	targetProgress,
+	animationProgress,
 	emitWillAnimate = true,
 	markEntering = true,
 	initialVelocity,
@@ -77,7 +92,11 @@ export const animateToProgress = ({
 
 	const startAnimation = () => {
 		"worklet";
+		const { from: animationProgressFrom, to: animationProgressTo } =
+			resolveAnimationProgressRange(transitionProgress.get(), value);
+
 		targetProgress.set(value);
+		animationProgress.set(animationProgressFrom);
 
 		const shouldClearEnteringOnFinish =
 			!isClosing && (markEntering || entering.get());
@@ -88,6 +107,7 @@ export const animateToProgress = ({
 			progressAnimating.set(FALSE);
 			progressSettled.set(TRUE);
 			transitionProgress.set(value);
+			animationProgress.set(animationProgressTo);
 			if (shouldClearEnteringOnFinish) {
 				entering.set(FALSE);
 			}
@@ -101,43 +121,54 @@ export const animateToProgress = ({
 		progressAnimating.set(TRUE); //<-- Do not move this into the callback
 		progressSettled.set(FALSE);
 		transitionProgress.set(
-			animate(value, effectiveConfig, (state) => {
-				"worklet";
-				if (state.settled) {
-					progressSettled.set(TRUE);
-				}
+			animate(
+				value,
+				effectiveConfig,
+				(state) => {
+					"worklet";
+					if (state.settled) {
+						progressSettled.set(TRUE);
+					}
 
-				if (!state.finished) return;
+					if (!state.finished) return;
 
-				if (shouldClearEnteringOnFinish) {
-					entering.set(FALSE);
-				}
+					animationProgress.set(animationProgressTo);
 
-				if (isClosing) {
-					progressAnimating.set(FALSE);
+					if (shouldClearEnteringOnFinish) {
+						entering.set(FALSE);
+					}
 
-					if (onAnimationFinish) {
-						// Paint the terminal UI-thread host/style state before React
-						// removes the closing route and its native portal host.
-						requestAnimationFrame(() => {
-							"worklet";
+					if (isClosing) {
+						progressAnimating.set(FALSE);
+
+						if (onAnimationFinish) {
+							// Paint the terminal UI-thread host/style state before React
+							// removes the closing route and its native portal host.
 							requestAnimationFrame(() => {
 								"worklet";
-								runOnJS(onAnimationFinish)(state.finished);
+								requestAnimationFrame(() => {
+									"worklet";
+									runOnJS(onAnimationFinish)(state.finished);
+								});
 							});
+						}
+					} else {
+						if (onAnimationFinish) {
+							runOnJS(onAnimationFinish)(state.finished);
+						}
+
+						// Delay clearing progress animation by one frame to ensure final frame is painted
+						requestAnimationFrame(() => {
+							progressAnimating.set(FALSE);
 						});
 					}
-				} else {
-					if (onAnimationFinish) {
-						runOnJS(onAnimationFinish)(state.finished);
-					}
-
-					// Delay clearing progress animation by one frame to ensure final frame is painted
-					requestAnimationFrame(() => {
-						progressAnimating.set(FALSE);
-					});
-				}
-			}),
+				},
+				{
+					value: animationProgress,
+					from: animationProgressFrom,
+					to: animationProgressTo,
+				},
+			),
 		);
 	};
 

package/src/shared/utils/animation/animate.ts

@@ -1,7 +1,7 @@
 import type { WithTimingConfig } from "react-native-reanimated";
 import { withTiming } from "react-native-reanimated";
 import { type SpringConfig, withInternalSpring } from "./spring";
-import type { AnimationStateCallback } from "./state";
+import type { AnimationProgressDriver, AnimationStateCallback } from "./state";
 
 export type TimingAnimationConfig = WithTimingConfig;
 export type SpringAnimationConfig = SpringConfig;
@@ -9,6 +9,11 @@ export type ScreenAnimationConfig =
 	| SpringAnimationConfig
 	| TimingAnimationConfig;
 
+const linearEasing = (progress: number) => {
+	"worklet";
+	return progress;
+};
+
 export const isSpringAnimationConfig = (
 	config: ScreenAnimationConfig | undefined,
 ): config is SpringAnimationConfig => {
@@ -33,10 +38,21 @@ export const animate = (
 	toValue: number,
 	config?: ScreenAnimationConfig,
 	callback?: AnimationStateCallback,
+	animationProgress?: AnimationProgressDriver,
 ) => {
 	"worklet";
 
 	if (!isSpringAnimationConfig(config)) {
+		if (animationProgress) {
+			animationProgress.value.set(animationProgress.from);
+			animationProgress.value.set(
+				withTiming(animationProgress.to, {
+					...config,
+					easing: linearEasing,
+				}),
+			);
+		}
+
 		return withTiming(toValue, config, (finished) => {
 			"worklet";
 			const didFinish = finished === true;
@@ -47,5 +63,5 @@ export const animate = (
 		});
 	}
 
-	return withInternalSpring(toValue, config, callback);
+	return withInternalSpring(toValue, config, callback, animationProgress);
 };

package/src/shared/utils/animation/spring/spring.ts

@@ -3,7 +3,7 @@ import type {
 	AnimationCallback,
 	ReduceMotion,
 } from "react-native-reanimated";
-import type { AnimationStateCallback } from "../state";
+import type { AnimationProgressDriver, AnimationStateCallback } from "../state";
 import type { SpringConfig } from "./springConfigs";
 import type {
 	DefaultSpringConfig,
@@ -13,6 +13,7 @@ import type {
 } from "./springUtils";
 import {
 	calculateNewStiffnessToMatchDuration,
+	calculateSpringAnimationDuration,
 	checkIfConfigIsValid,
 	criticallyDampedSpringCalculations,
 	getEnergy,
@@ -30,6 +31,7 @@ const REACT_NATIVE_RUNTIME_KIND = 1;
 const REDUCE_MOTION_SYSTEM = "system";
 const REDUCE_MOTION_ALWAYS = "always";
 const DEFAULT_SPRING_SETTLE_DISTANCE = 0.001;
+const MAX_UNFINISHED_ANIMATION_PROGRESS = 1 - 1e-6;
 
 const DEFAULT_SPRING_CONFIG = {
 	damping: 120,
@@ -61,6 +63,7 @@ const getReduceMotionForAnimation = (config?: ReduceMotion) => {
 const defineSpringAnimation = <TAnimation extends Animation<TAnimation>>(
 	_starting: number,
 	factory: () => TAnimation,
+	onReducedMotion?: () => void,
 ): TAnimation => {
 	"worklet";
 	const create = (() => {
@@ -76,6 +79,7 @@ const defineSpringAnimation = <TAnimation extends Animation<TAnimation>>(
 		) => {
 			"worklet";
 			if (animation.reduceMotion) {
+				onReducedMotion?.();
 				animation.current = animation.toValue;
 				animation.onFrame = () => true;
 				return;
@@ -99,6 +103,7 @@ type withSpringType = (
 	toValue: number,
 	userConfig?: SpringConfig,
 	callback?: AnimationStateCallback,
+	animationProgress?: AnimationProgressDriver,
 ) => number;
 
 /**
@@ -123,9 +128,11 @@ export const withInternalSpring = ((
 	toValue: number,
 	userConfig?: SpringConfig,
 	callback?: AnimationStateCallback,
+	animationProgress?: AnimationProgressDriver,
 ): Animation<SpringAnimation> => {
 	"worklet";
 
+	// biome-ignore format: Keep this Reanimated fork aligned with its upstream layout.
 	return defineSpringAnimation<SpringAnimation>(toValue, () => {
 		"worklet";
 		const config: DefaultSpringConfig & SpringConfigInner = safeMergeConfigs<
@@ -175,6 +182,7 @@ export const withInternalSpring = ((
 
 			if (config.skipAnimation) {
 				animation.current = toValue;
+				animationProgress?.value.set(animationProgress.to);
 				animation.lastTimestamp = 0;
 				return true;
 			}
@@ -182,6 +190,7 @@ export const withInternalSpring = ((
 
 			const deltaTime = Math.min(Math.max(now - lastTimestamp, 0), 64);
 			animation.lastTimestamp = now;
+			animation.animationProgressElapsed += deltaTime;
 
 			const t = deltaTime / 1000;
 			const v0 = velocity as number;
@@ -212,6 +221,7 @@ export const withInternalSpring = ((
 			if (isAnimationTerminatingCalculation(animation, config)) {
 				animation.velocity = 0;
 				animation.current = toValue;
+				animationProgress?.value.set(animationProgress.to);
 				settled = true;
 				animation.settled = true;
 				// clear lastTimestamp to avoid using stale value by the next spring animation that starts after this one
@@ -221,6 +231,21 @@ export const withInternalSpring = ((
 
 			notifySettled(animation);
 
+			if (animationProgress) {
+				const elapsedFraction =
+					animation.animationProgressDuration <= 0
+						? MAX_UNFINISHED_ANIMATION_PROGRESS
+						: Math.min(
+								animation.animationProgressElapsed /
+									animation.animationProgressDuration,
+								MAX_UNFINISHED_ANIMATION_PROGRESS,
+							);
+				const nextAnimationProgress =
+					animationProgress.from +
+					(animationProgress.to - animationProgress.from) * elapsedFraction;
+				animationProgress.value.set(nextAnimationProgress);
+			}
+
 			return false;
 		}
 
@@ -307,6 +332,11 @@ export const withInternalSpring = ((
 				config.mass,
 			);
 			animation.initialEnergy = initialEnergy;
+			animation.animationProgressElapsed = 0;
+			animation.animationProgressDuration = config.skipAnimation
+				? 0
+				: calculateSpringAnimationDuration(animation, config);
+			animationProgress?.value.set(animationProgress.from);
 
 			animation.lastTimestamp = previousAnimation?.lastTimestamp || now;
 
@@ -339,9 +369,14 @@ export const withInternalSpring = ((
 			omega0: 0,
 			omega1: 0,
 			initialEnergy: 0,
+			animationProgressElapsed: 0,
+			animationProgressDuration: 0,
 			reduceMotion: getReduceMotionForAnimation(config.reduceMotion),
 		} as SpringAnimation;
 
 		return animation;
+	}, () => {
+		"worklet";
+		animationProgress?.value.set(animationProgress.to);
 	});
 }) as unknown as withSpringType;

package/src/shared/utils/animation/spring/springUtils.ts

@@ -29,6 +29,8 @@ export interface SpringAnimation extends Animation<SpringAnimation> {
 	omega0: number;
 	omega1: number;
 	initialEnergy: number;
+	animationProgressElapsed: number;
+	animationProgressDuration: number;
 }
 
 export type InnerSpringAnimation = SpringAnimation;
@@ -362,6 +364,134 @@ export function underDampedSpringCalculations(
 	return { position: underDampedPosition, velocity: underDampedVelocity };
 }
 
+const MAX_SPRING_DURATION_SECONDS = 60;
+const SPRING_DURATION_PRECISION_SECONDS = 0.0001;
+const MAX_OVERSHOOT_DURATION_SAMPLES = 4096;
+
+export function calculateSpringAnimationDuration(
+	animation: InnerSpringAnimation,
+	config: DefaultSpringConfig & SpringConfigInner,
+): number {
+	"worklet";
+	const startPosition = animation.current;
+	const startVelocity = animation.velocity;
+	const x0 = startPosition - animation.toValue;
+
+	const stateAt = (time: number) => {
+		"worklet";
+		return animation.zeta < 1
+			? underDampedSpringCalculations(animation, {
+					zeta: animation.zeta,
+					v0: startVelocity,
+					x0,
+					omega0: animation.omega0,
+					omega1: animation.omega1,
+					t: time,
+				})
+			: criticallyDampedSpringCalculations(animation, {
+					v0: startVelocity,
+					x0,
+					omega0: animation.omega0,
+					t: time,
+				});
+	};
+
+	const terminatesByEnergyAt = (time: number) => {
+		"worklet";
+		if (animation.initialEnergy === 0) {
+			return true;
+		}
+
+		const state = stateAt(time);
+		const energy = getEnergy(
+			animation.toValue - state.position,
+			state.velocity,
+			config.stiffness,
+			config.mass,
+		);
+
+		return energy / animation.initialEnergy <= config.energyThreshold;
+	};
+
+	if (terminatesByEnergyAt(0)) {
+		return 0;
+	}
+
+	let lowerBound = 0;
+	let upperBound = 1 / 60;
+	while (
+		upperBound < MAX_SPRING_DURATION_SECONDS &&
+		!terminatesByEnergyAt(upperBound)
+	) {
+		lowerBound = upperBound;
+		upperBound *= 2;
+	}
+	upperBound = Math.min(upperBound, MAX_SPRING_DURATION_SECONDS);
+
+	if (terminatesByEnergyAt(upperBound)) {
+		while (upperBound - lowerBound > SPRING_DURATION_PRECISION_SECONDS) {
+			const midpoint = (lowerBound + upperBound) / 2;
+			if (terminatesByEnergyAt(midpoint)) {
+				upperBound = midpoint;
+			} else {
+				lowerBound = midpoint;
+			}
+		}
+	}
+
+	const energyDuration = upperBound;
+	if (!config.overshootClamping || energyDuration === 0) {
+		return energyDuration * 1000;
+	}
+
+	const leftBound =
+		animation.startValue >= 0
+			? animation.toValue
+			: animation.toValue + animation.startValue;
+	const rightBound = leftBound + Math.abs(animation.startValue);
+	const isOutsideBoundsAt = (time: number) => {
+		"worklet";
+		const { position } = stateAt(time);
+		return position < leftBound || position > rightBound;
+	};
+
+	const frequency = animation.zeta < 1 ? animation.omega1 : animation.omega0;
+	const sampleStep =
+		frequency > 0 ? Math.min(1 / 240, Math.PI / (frequency * 8)) : 1 / 240;
+	const sampleCount = Math.min(
+		MAX_OVERSHOOT_DURATION_SAMPLES,
+		Math.max(1, Math.ceil(energyDuration / sampleStep)),
+	);
+	const effectiveStep = energyDuration / sampleCount;
+	let previousTime = 0;
+
+	for (let index = 1; index <= sampleCount; index += 1) {
+		const time = effectiveStep * index;
+		if (!isOutsideBoundsAt(time)) {
+			previousTime = time;
+			continue;
+		}
+
+		let crossingLowerBound = previousTime;
+		let crossingUpperBound = time;
+		while (
+			crossingUpperBound - crossingLowerBound >
+			SPRING_DURATION_PRECISION_SECONDS
+		) {
+			const midpoint = (crossingLowerBound + crossingUpperBound) / 2;
+			if (isOutsideBoundsAt(midpoint)) {
+				crossingUpperBound = midpoint;
+			} else {
+				crossingLowerBound = midpoint;
+			}
+		}
+
+		return crossingUpperBound * 1000;
+	}
+
+	return energyDuration * 1000;
+}
+
 export function isAnimationTerminatingCalculation(
 	animation: InnerSpringAnimation,
 	config: DefaultSpringConfig & SpringConfigInner,

package/src/shared/utils/animation/state.ts

@@ -1,6 +1,14 @@
+import type { SharedValue } from "react-native-reanimated";
+
 export type AnimationState = {
 	finished: boolean;
 	settled: boolean;
 };
 
 export type AnimationStateCallback = (state: AnimationState) => void;
+
+export type AnimationProgressDriver = {
+	value: SharedValue<number>;
+	from: number;
+	to: number;
+};

package/src/shared/utils/bounds/navigation/reveal/math.ts

@@ -2,6 +2,8 @@ import type { MeasuredDimensions } from "react-native-reanimated";
 import { EPSILON } from "../../../../constants";
 import type { Layout } from "../../../../types/screen.types";
 import { computeContentTransformGeometry } from "../../helpers/geometry";
+import type { ContentTransformGeometry } from "../../types/geometry";
+import type { BoundsAnchor } from "../../types/options";
 import {
 	DRAG_DIRECTIONAL_SCALE_EXPONENT,
 	DRAG_DIRECTIONAL_SCALE_MAX,
@@ -184,16 +186,34 @@ function getBoundsCenterY(bounds: MeasuredDimensions) {
 	return bounds.pageY + bounds.height / 2;
 }
 
+export function resolveRevealContentBaseTransformFromGeometry({
+	progress,
+	geometry,
+}: {
+	progress: number;
+	geometry: ContentTransformGeometry;
+}) {
+	"worklet";
+
+	return {
+		translateX: mixUnit(geometry.tx, 0, progress),
+		translateY: mixUnit(geometry.ty, 0, progress),
+		scale: mixUnit(geometry.s, 1, progress),
+	};
+}
+
 export function resolveRevealContentBaseTransform({
 	progress,
 	sourceBounds,
 	destinationBounds,
 	screenLayout,
+	anchor,
 }: {
 	progress: number;
 	sourceBounds: MeasuredDimensions;
 	destinationBounds: MeasuredDimensions;
 	screenLayout: Layout;
+	anchor?: BoundsAnchor;
 }) {
 	"worklet";
 
@@ -202,14 +222,14 @@ export function resolveRevealContentBaseTransform({
 		end: destinationBounds,
 		entering: true,
 		dimensions: screenLayout,
+		anchor,
 		scaleMode: "uniform",
 	});
 
-	return {
-		translateX: mixUnit(geometry.tx, 0, progress),
-		translateY: mixUnit(geometry.ty, 0, progress),
-		scale: mixUnit(geometry.s, 1, progress),
-	};
+	return resolveRevealContentBaseTransformFromGeometry({
+		geometry,
+		progress,
+	});
 }
 
 export function resolveTrackedSourceElementTransform({