react-native-screen-transitions 3.0.0-rc.5 → 3.1.0

package/src/shared/types/animation.types.ts

@@ -21,10 +21,59 @@ export interface OverlayInterpolationProps {
 }
 
 export type ScreenTransitionState = {
+	/**
+	 * Animation progress for this screen.
+	 * - `0`: Screen is fully off-screen (entering)
+	 * - `1`: Screen is fully visible (active)
+	 *
+	 * This value animates from 0 to 1 when the screen enters,
+	 * and from 1 to 0 when it exits.
+	 */
 	progress: number;
+
+	/**
+	 * Whether this screen is in the process of being dismissed.
+	 * - `0`: Screen is opening or active
+	 * - `1`: Screen is closing/being dismissed
+	 *
+	 * Use this to trigger different animations when navigating back vs forward.
+	 */
 	closing: number;
+
+	/**
+	 * Whether this screen is currently animating.
+	 * - `0`: No animation in progress
+	 * - `1`: Animation or gesture is in progress
+	 */
 	animating: number;
+
+	/**
+	 * Live gesture values for this screen.
+	 * Contains translation (x, y), normalized values (-1 to 1),
+	 * and flags for dragging/dismissing state.
+	 */
 	gesture: GestureValues;
+
+	/**
+	 * Custom metadata passed from screen options.
+	 * Use this for conditional animation logic instead of checking route names.
+	 *
+	 * @example
+	 * // In screen options:
+	 * options={{ meta: { scalesOthers: true } }}
+	 *
+	 * // In animation logic:
+	 * if (props.next?.meta?.scalesOthers) { ... }
+	 */
+	meta?: Record<string, unknown>;
+
+	/**
+	 * The route object for this screen.
+	 *
+	 * @deprecated Use `meta` instead for conditional animation logic.
+	 * Pass route params via options: `options={({ route }) => ({ meta: { id: route.params.id } })}`
+	 * This field may be removed in a future version.
+	 */
 	route: RouteProp<ParamListBase>;
 };
 
@@ -98,13 +147,21 @@ export interface ScreenInterpolationProps {
 	 */
 	active: ScreenTransitionState;
 
+	/**
+	 * The screen state that is NOT driving the transition.
+	 * When focused, this is the previous screen. When not focused, this is the current screen.
+	 */
+	inactive: ScreenTransitionState | undefined;
+
 	/**
 	 * Whether the active screen is currently transitioning (either being dragged or animating).
+	 * @deprecated Use `active.animating` instead.
 	 */
 	isActiveTransitioning: boolean;
 
 	/**
 	 * Whether the active screen is in the process of being dismissed/closed.
+	 * @deprecated Use `active.closing` instead.
 	 */
 	isDismissing: boolean;
 }

package/src/shared/types/bounds.types.ts

@@ -19,7 +19,18 @@ export type BoundEntry = {
 	styles: StyleProps;
 };
 
+export type BoundsLink = {
+	source: BoundEntry | null;
+	destination: BoundEntry | null;
+};
+
 export type BoundsAccessor = {
 	<T extends BoundsBuilderOptions>(options: T): BoundsReturnType<T>;
 	getSnapshot: (id: string, key?: string) => Snapshot | null;
+	getLink: (id: string) => BoundsLink | null;
+	interpolateStyle: (
+		id: string,
+		property: keyof StyleProps,
+		fallback?: number,
+	) => number;
 };

package/src/shared/types/core.types.ts

@@ -100,4 +100,12 @@ export type ScreenTransitionConfig = {
 	 * The area of the screen where the gesture is activated.
 	 */
 	gestureActivationArea?: GestureActivationArea;
+
+	/**
+	 * Custom metadata passed through to animation props.
+	 *
+	 * @example
+	 * options={{ meta: { scalesOthers: true } }}
+	 */
+	meta?: Record<string, unknown>;
 };

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

@@ -1,6 +1,7 @@
 import type { ScreenTransitionState } from "../../types/animation.types";
 
 interface DerivationsParams {
+	previous?: ScreenTransitionState;
 	current: ScreenTransitionState;
 	next?: ScreenTransitionState;
 }
@@ -8,7 +9,7 @@ interface DerivationsParams {
 /**
  * Additional values to help make defining animations easier.
  */
-export const derivations = ({ current, next }: DerivationsParams) => {
+export const derivations = ({ previous, current, next }: DerivationsParams) => {
 	"worklet";
 
 	// The combined progress (current + next, 0-2 range)
@@ -17,7 +18,12 @@ export const derivations = ({ current, next }: DerivationsParams) => {
 	// Whether the current screen is focused
 	const focused = !next;
 
+	// The screen driving the transition
 	const active = focused ? current : (next ?? current);
+
+	// The screen NOT driving the transition
+	const inactive = focused ? previous : current;
+
 	const isActiveTransitioning = !!(
 		active.gesture.isDragging || active.animating
 	);
@@ -28,6 +34,7 @@ export const derivations = ({ current, next }: DerivationsParams) => {
 		progress,
 		focused,
 		active,
+		inactive,
 		isActiveTransitioning,
 		isDismissing,
 	};

package/src/shared/utils/bounds/helpers/interpolate-style.ts

@@ -0,0 +1,38 @@
+import { interpolate } from "react-native-reanimated";
+import { ENTER_RANGE, EXIT_RANGE } from "../../../constants";
+import type { BoundsLink } from "../../../types/bounds.types";
+
+type InterpolateStyleOptions = {
+	fallback?: number;
+};
+
+/**
+ * Interpolates a numeric style property between source and destination bounds.
+ *
+ * @param link - The bounds link containing source and destination styles
+ * @param property - The style property to interpolate (e.g., "borderRadius", "opacity")
+ * @param progress - Animation progress value
+ * @param entering - Whether the screen is entering (focused) or exiting (unfocused)
+ * @param options - Optional configuration
+ * @returns The interpolated value
+ */
+export function interpolateLinkStyle(
+	link: BoundsLink | null,
+	property: string,
+	progress: number,
+	entering: boolean,
+	options: InterpolateStyleOptions = {},
+): number {
+	"worklet";
+
+	const { fallback = 0 } = options;
+
+	const sourceValue =
+		(link?.source?.styles?.[property] as number | undefined) ?? fallback;
+	const destValue =
+		(link?.destination?.styles?.[property] as number | undefined) ?? fallback;
+
+	const range = entering ? ENTER_RANGE : EXIT_RANGE;
+
+	return interpolate(progress, range, [sourceValue, destValue], "clamp");
+}

package/src/shared/utils/bounds/index.ts

@@ -11,12 +11,13 @@ import type {
 	ScreenInterpolationProps,
 	ScreenTransitionState,
 } from "../../types/animation.types";
-import type { BoundsAccessor } from "../../types/bounds.types";
+import type { BoundsAccessor, BoundsLink } from "../../types/bounds.types";
 import type { Layout } from "../../types/core.types";
 import {
 	computeContentTransformGeometry,
 	computeRelativeGeometry,
 } from "./helpers/geometry";
+import { interpolateLinkStyle } from "./helpers/interpolate-style";
 import {
 	composeContentStyle,
 	composeSizeAbsolute,
@@ -207,7 +208,36 @@ export const createBounds = (
 		return BoundStore.getSnapshot(tag, key);
 	};
 
+	const getLink = (tag: string): BoundsLink | null => {
+		"worklet";
+		const link = BoundStore.getActiveLink(tag, props.current?.route.key);
+		if (!link) return null;
+		return {
+			source: link.source
+				? { bounds: link.source.bounds, styles: link.source.styles }
+				: null,
+			destination: link.destination
+				? { bounds: link.destination.bounds, styles: link.destination.styles }
+				: null,
+		};
+	};
+
+	const interpolateStyle = (
+		tag: string,
+		property: string,
+		fallback?: number,
+	): number => {
+		"worklet";
+		const link = getLink(tag);
+		const entering = !props.next;
+		return interpolateLinkStyle(link, property, props.progress, entering, {
+			fallback,
+		});
+	};
+
 	return Object.assign(boundsFunction, {
 		getSnapshot,
+		getLink,
+		interpolateStyle,
 	}) as BoundsAccessor;
 };

package/src/shared/utils/create-provider.tsx

@@ -9,8 +9,11 @@ import {
 	type ReactNode,
 	useContext,
 	useMemo,
+	useRef,
 } from "react";
 
+type InnerProviderComponent = (props: { children: ReactNode }) => ReactNode;
+
 export default function createProvider<
 	ProviderName extends string,
 	Guarded extends boolean = true,
@@ -19,7 +22,13 @@ export default function createProvider<
 		factory: (props: ProviderProps) => {
 			value?: ContextValue;
 			enabled?: boolean;
-			children?: ReactNode;
+			children?:
+				| ReactNode
+				| ((
+						innerProvider: {
+							[K in ProviderName as `${K}Provider`]: InnerProviderComponent;
+						},
+				  ) => ReactNode);
 		},
 	) => {
 		const { guarded = true } = options ?? {};
@@ -45,6 +54,27 @@ export default function createProvider<
 				[enabled, value],
 			);
 
+			// Per-instance ref ensures InnerProvider reads latest value while keeping
+			// a stable component reference.
+			const valueRef = useRef<ContextValue | null>(memoValue);
+			valueRef.current = memoValue;
+
+			const InnerProvider = useMemo(
+				(): InnerProviderComponent =>
+					({ children }) => (
+						<Context.Provider value={valueRef.current}>
+							{children}
+						</Context.Provider>
+					),
+				[],
+			);
+
+			if (typeof children === "function") {
+				return children({
+					[`${name}Provider`]: InnerProvider,
+				} as { [K in ProviderName as `${K}Provider`]: InnerProviderComponent });
+			}
+
 			return <Context.Provider value={memoValue}>{children}</Context.Provider>;
 		};
 

package/src/shared/utils/gesture/check-gesture-activation.ts

@@ -72,7 +72,7 @@ const DEFAULT_EDGE_DISTANCE_HORIZONTAL = 50;
 const DEFAULT_EDGE_DISTANCE_VERTICAL = 135;
 const DEFAULT_ACTIVATION_AREA = "screen" as const;
 
-function normalizeSides(area?: GestureActivationArea): NormalizedSides {
+export function normalizeSides(area?: GestureActivationArea): NormalizedSides {
 	"worklet";
 	if (!area || typeof area === "string") {
 		const mode: ActivationArea = area ?? DEFAULT_ACTIVATION_AREA;
@@ -88,7 +88,7 @@ function normalizeSides(area?: GestureActivationArea): NormalizedSides {
 	};
 }
 
-function computeEdgeConstraints(
+export function computeEdgeConstraints(
 	initialTouch: { x: number; y: number },
 	dimensions: Layout,
 	sides: NormalizedSides,
@@ -108,7 +108,7 @@ function computeEdgeConstraints(
 	return { horizontalRight, horizontalLeft, verticalDown, verticalUp } as const;
 }
 
-function calculateSwipeDirs(deltaX: number, deltaY: number) {
+export function calculateSwipeDirs(deltaX: number, deltaY: number) {
 	"worklet";
 
 	const isVerticalSwipe = Math.abs(deltaY) > Math.abs(deltaX);
@@ -129,7 +129,7 @@ function calculateSwipeDirs(deltaX: number, deltaY: number) {
 	};
 }
 
-function shouldActivateOrFail(params: ShouldActivateOrFailProps) {
+export function shouldActivateOrFail(params: ShouldActivateOrFailProps) {
 	"worklet";
 
 	const {