react-native-screen-transitions 4.0.0-alpha.0 → 4.0.0-alpha.10

package/src/components/boundary/utils/refresh-signals.ts

@@ -31,15 +31,11 @@ export const getRefreshBoundarySignal = (params: {
 	currentScreenKey: string;
 	sourcePairKey?: ScreenPairKey;
 	destinationPairKey?: ScreenPairKey;
-	ancestorDestinationPairKey?: ScreenPairKey;
-	nextScreenKey?: string;
 	linkId: string;
 	group?: string;
 	shouldRefresh: boolean;
+	settled?: boolean;
 	closing: boolean;
-	entering: boolean;
-	animating: boolean;
-	progress: number;
 	linkState?: LinkPairsState;
 }): RefreshBoundarySignal | null => {
 	"worklet";
@@ -48,44 +44,49 @@ export const getRefreshBoundarySignal = (params: {
 		currentScreenKey,
 		sourcePairKey,
 		destinationPairKey,
-		ancestorDestinationPairKey,
-		nextScreenKey,
 		linkId,
 		group,
 		shouldRefresh,
+		settled = false,
 		closing,
-		entering,
-		animating,
-		progress,
 		linkState,
 	} = params;
 
 	if (!enabled) return null;
 
-	const canRefreshPreCloseDestination =
-		shouldRefresh && closing && !entering && !animating && progress >= 1;
-
-	const canRefreshSettledDestination = shouldRefresh && !closing && !entering;
-
-	// Guards:
-	// 1) A user may dismiss via back button, in this case, we should remeasure.
-	// 2) If a user drags during entering/closing animations we should NOT remeasure.
-	if (!canRefreshPreCloseDestination && !canRefreshSettledDestination) {
+	if (!shouldRefresh && (!group || !settled)) {
 		return null;
 	}
 
-	// Non group:
-	// Since in typical group flows we would need to know the src, we don't need to do that for
-	// single a->b flows. So we just trigger the destination refresh.
+	// A source may move while its destination is active, so refresh whichever
+	// side of the pair this boundary currently represents.
 	if (!group) {
-		const refreshDestinationPairKey =
-			destinationPairKey ??
-			(nextScreenKey ? undefined : ancestorDestinationPairKey);
+		if (sourcePairKey) {
+			const sourcePair = linkState?.[sourcePairKey];
+			const participates =
+				!!sourcePair?.links?.[linkId] || !!sourcePair?.sourceRequests?.[linkId];
+
+			if (!participates) {
+				return null;
+			}
+
+			return buildRefreshSignal(
+				"source",
+				sourcePairKey,
+				[currentScreenKey, closing ? "closing" : "settled"].join("|"),
+			);
+		}
+
+		const refreshDestinationPairKey = destinationPairKey;
 
 		if (!refreshDestinationPairKey) {
 			return null;
 		}
 
+		if (!linkState?.[refreshDestinationPairKey]?.links?.[linkId]) {
+			return null;
+		}
+
 		return buildRefreshSignal(
 			"destination",
 			refreshDestinationPairKey,
@@ -96,29 +97,45 @@ export const getRefreshBoundarySignal = (params: {
 	// Source side:
 	// When the activeId changes, trigger a refresh to ensure the source bounds are captured.
 	if (sourcePairKey) {
-		const activeId = linkState?.[sourcePairKey]?.groups?.[group]?.activeId;
+		const pair = linkState?.[sourcePairKey];
+		const groupState = pair?.groups?.[group];
+		const activeId = groupState?.activeId;
 
 		if (activeId !== linkId) {
 			return null;
 		}
 
+		// The opening member is captured by the initial handshake. A settled
+		// refresh is only needed after selection moves to another member.
+		if (
+			!shouldRefresh &&
+			(groupState?.initialId === undefined ||
+				activeId === groupState.initialId ||
+				!!pair?.links?.[linkId]?.source)
+		) {
+			return null;
+		}
+
 		return buildRefreshSignal(
 			"source",
 			sourcePairKey,
-			[group, linkId, closing ? "closing" : "settled"].join("|"),
+			[
+				group,
+				linkId,
+				shouldRefresh ? (closing ? "closing" : "settled") : "retarget",
+			].join("|"),
 		);
 	}
 
-	const refreshDestinationPairKey =
-		destinationPairKey ??
-		(nextScreenKey ? undefined : ancestorDestinationPairKey);
+	const refreshDestinationPairKey = destinationPairKey;
 
 	if (!refreshDestinationPairKey) return null;
 
 	// Destination side:
 	// When the activeId changes, trigger a refresh to ensure the destination bounds are captured.
-	const activeId =
-		linkState?.[refreshDestinationPairKey]?.groups?.[group]?.activeId;
+	const pair = linkState?.[refreshDestinationPairKey];
+	const groupState = pair?.groups?.[group];
+	const activeId = groupState?.activeId;
 
 	// Destination retargeting should only measure a concrete member that already
 	// participates in the pair. Missing members fall back to initialId at resolve.
@@ -126,9 +143,22 @@ export const getRefreshBoundarySignal = (params: {
 		return null;
 	}
 
+	if (
+		!shouldRefresh &&
+		(groupState?.initialId === undefined ||
+			activeId === groupState.initialId ||
+			!!pair?.links?.[linkId]?.destination)
+	) {
+		return null;
+	}
+
 	return buildRefreshSignal(
 		"destination",
 		refreshDestinationPairKey,
-		[group, linkId, closing ? "closing" : "settled"].join("|"),
+		[
+			group,
+			linkId,
+			shouldRefresh ? (closing ? "closing" : "settled") : "retarget",
+		].join("|"),
 	);
 };

package/src/components/boundary/utils/resolve-boundary-target.tsx

@@ -0,0 +1,39 @@
+import {
+	Children,
+	cloneElement,
+	Fragment,
+	isValidElement,
+	type ReactElement,
+	type ReactNode,
+} from "react";
+
+type ResolveBoundaryTargetOptions = {
+	isTarget: (element: ReactElement) => boolean;
+	mapTarget?: (element: ReactElement, selected: boolean) => ReactElement;
+};
+
+export const resolveBoundaryTarget = (
+	children: ReactNode,
+	options: ResolveBoundaryTargetOptions,
+): {
+	children: ReactNode;
+	target: ReactElement | null;
+	targetCount: number;
+} => {
+	let target: ReactElement | null = null;
+	let targetCount = 0;
+	const map = (nodes: ReactNode): ReactNode =>
+		Children.map(nodes, (node) => {
+			if (!isValidElement<{ children?: ReactNode }>(node)) return node;
+			if (node.type === Fragment) {
+				return cloneElement(node, undefined, map(node.props.children));
+			}
+			if (!options.isTarget(node)) return node;
+			target ??= node;
+			targetCount += 1;
+			return options.mapTarget?.(node, targetCount === 1) ?? node;
+		});
+
+	const mappedChildren = map(children);
+	return { children: target ? mappedChildren : children, target, targetCount };
+};

package/src/components/create-transition-aware-component.tsx

@@ -1,14 +1,8 @@
 /** biome-ignore-all lint/style/noNonNullAssertion: <This helper is usually being used inside a transitionable stack> */
 import type React from "react";
 import { type ComponentType, forwardRef, memo } from "react";
-import type { View } from "react-native";
 import { GestureDetector } from "react-native-gesture-handler";
-import Animated, {
-	useAnimatedRef,
-	useComposedEventHandler,
-} from "react-native-reanimated";
-import { scheduleOnUI } from "react-native-worklets";
-import { RegisterBoundsProvider } from "../providers/register-bounds.provider";
+import Animated, { useComposedEventHandler } from "react-native-reanimated";
 import {
 	ScrollMetadataOwnerProvider,
 	useScrollGestureCoordination,
@@ -36,7 +30,6 @@ export function createTransitionAwareComponent<P extends object>(
 		TransitionAwareProps<P>
 	>((props: any, ref) => {
 		const {
-			remeasureOnFocus: _remeasureOnFocus,
 			onScroll: userOnScroll,
 			onMomentumScrollEnd: userOnMomentumScrollEnd,
 			onScrollEndDrag: userOnScrollEndDrag,
@@ -112,45 +105,27 @@ export function createTransitionAwareComponent<P extends object>(
 	const Inner = forwardRef<
 		React.ComponentRef<typeof AnimatedComponent>,
 		TransitionAwareProps<P>
-	>((props, _) => {
+	>((props, ref) => {
 		const {
 			children,
 			style,
-			sharedBoundTag,
 			styleId,
-			onPress,
-			remeasureOnFocus,
 			animatedProps: userAnimatedProps,
 			...rest
 		} = props as any;
 
-		const animatedRef = useAnimatedRef<View>();
-		const associatedId = sharedBoundTag || styleId;
-		const associatedStyles = useSlotStyles(associatedId);
-		const associatedProps = useSlotProps(associatedId);
+		const associatedStyles = useSlotStyles(styleId);
+		const associatedProps = useSlotProps(styleId);
 
 		return (
-			<RegisterBoundsProvider
-				animatedRef={animatedRef}
-				style={style}
-				onPress={onPress}
-				sharedBoundTag={sharedBoundTag}
-				remeasureOnFocus={remeasureOnFocus}
+			<AnimatedComponent
+				{...(rest as any)}
+				ref={ref}
+				style={[style, associatedStyles]}
+				animatedProps={userAnimatedProps ?? associatedProps}
 			>
-				{({ captureActiveOnPress, handleInitialLayout }) => (
-					<AnimatedComponent
-						{...(rest as any)}
-						ref={animatedRef}
-						style={[style, associatedStyles]}
-						animatedProps={userAnimatedProps ?? associatedProps}
-						onPress={captureActiveOnPress}
-						onLayout={() => scheduleOnUI(handleInitialLayout)}
-						collapsable={!sharedBoundTag}
-					>
-						{children}
-					</AnimatedComponent>
-				)}
-			</RegisterBoundsProvider>
+				{children}
+			</AnimatedComponent>
 		);
 	});
 

package/src/components/overlay/helpers/create-overlay-interpolator-frame.ts

@@ -0,0 +1,41 @@
+import { updateDerivations } from "../../../providers/screen/animation/helpers/derivations";
+import type { ScreenInterpolatorFrame } from "../../../providers/screen/animation/helpers/pipeline";
+
+export const shouldUseOverlayGestureDriver = (
+	overlayFrame: ScreenInterpolatorFrame,
+	driverFrame: ScreenInterpolatorFrame,
+): boolean => {
+	"worklet";
+	const gesture = overlayFrame.current.gesture;
+
+	return (
+		driverFrame.current.route.key !== overlayFrame.current.route.key &&
+		!!(gesture.dragging || gesture.dismissing || gesture.settling)
+	);
+};
+
+export const createOverlayInterpolatorFrame = ({
+	overlayFrame,
+	driverFrame,
+	previousOverlayFrame,
+}: {
+	overlayFrame: ScreenInterpolatorFrame;
+	driverFrame: ScreenInterpolatorFrame;
+	previousOverlayFrame?: ScreenInterpolatorFrame;
+}): ScreenInterpolatorFrame => {
+	"worklet";
+	const current = overlayFrame.current;
+	const driverIsCurrent = driverFrame.current.route.key === current.route.key;
+	const frame: ScreenInterpolatorFrame = {
+		...overlayFrame,
+		previous: previousOverlayFrame?.current,
+		current,
+		next: driverIsCurrent ? undefined : driverFrame.current,
+		layouts: current.layouts,
+	};
+
+	updateDerivations(frame);
+	frame.stackProgress = overlayFrame.stackProgress;
+
+	return frame;
+};

package/src/components/overlay/helpers/get-active-overlay.ts

@@ -1,39 +1,109 @@
-import type { StackScene } from "../../../hooks/navigation/use-stack";
+import type { BaseStackScene } from "../../../types/stack.types";
+
+type StackScene = BaseStackScene;
+
 import { isOverlayVisible } from "../../../utils/overlay/visibility";
 
+export type FloatOverlayActivity = "active" | "inert" | "inactive" | "closing";
+
+export type FloatOverlayEntry = {
+	scene: StackScene;
+	overlayIndex: number;
+	activity: FloatOverlayActivity;
+};
+
+export type FloatOverlayTransitionEntry = FloatOverlayEntry & {
+	driverScene: StackScene;
+};
+
+type OverlayCandidate = Omit<FloatOverlayEntry, "activity">;
+
+const resolveOverlayActivity = (
+	scene: StackScene,
+	distanceFromTop: number,
+): FloatOverlayActivity => {
+	if (distanceFromTop === 0 && scene.activity === "closing") {
+		return "closing";
+	}
+
+	if (distanceFromTop === 0) {
+		return "active";
+	}
+
+	if (distanceFromTop === 1) {
+		return "inert";
+	}
+
+	return "inactive";
+};
+
 /**
- * Find the active float overlay from scenes.
- * Scans from the top of the stack downward to find the first screen
- * with a visible overlay.
+ * Finds every visible floating-overlay checkpoint in stack order.
+ *
+ * The newest checkpoint owns the active overlay. Its immediate predecessor
+ * remains visible and inert; all older checkpoints are retained but inactive.
+ * This mirrors the screen activity window without making plain screens create
+ * a new overlay checkpoint.
  */
-export function getActiveFloatOverlay(
+export function getFloatOverlayStack(
 	scenes: StackScene[],
-	index: number,
 	transitionsAlwaysOn: boolean,
-): { scene: StackScene; overlayIndex: number } | null {
-	if (scenes.length === 0) {
-		return null;
-	}
-
-	// When navigating back, closing scenes are kept at the top of the local stack
-	// while the focused index already points to the destination screen. We need to
-	// start scanning from the actual top of the stack so the overlay can animate
-	// out together with its closing screen instead of disappearing immediately.
-	const startIndex = Math.max(index, scenes.length - 1);
+): FloatOverlayEntry[] {
+	const candidates: OverlayCandidate[] = [];
 
-	for (let i = startIndex; i >= 0; i--) {
-		const scene = scenes[i];
+	for (let index = 0; index < scenes.length; index += 1) {
+		const scene = scenes[index];
 		const options = scene?.descriptor?.options;
 
-		// Skip screens without enableTransitions (native-stack only)
 		if (!transitionsAlwaysOn && !options?.enableTransitions) {
 			continue;
 		}
 
 		if (isOverlayVisible(options)) {
-			return { scene, overlayIndex: i };
+			candidates.push({ scene, overlayIndex: index });
 		}
 	}
 
-	return null;
+	const topIndex = candidates.length - 1;
+	return candidates.map((candidate, index) => ({
+		...candidate,
+		activity: resolveOverlayActivity(candidate.scene, topIndex - index),
+	}));
+}
+
+export function getFloatOverlayTransitions(
+	overlayStack: FloatOverlayEntry[],
+	scenes: StackScene[],
+): FloatOverlayTransitionEntry[] {
+	const topScene = scenes[scenes.length - 1];
+
+	return overlayStack.map((entry, index) => {
+		const nextEntry = overlayStack[index + 1];
+		let nextPresentedEntry: FloatOverlayEntry | undefined;
+
+		for (
+			let nextIndex = index + 1;
+			nextIndex < overlayStack.length;
+			nextIndex++
+		) {
+			const candidate = overlayStack[nextIndex];
+			if (candidate?.scene.activity !== "closing") {
+				nextPresentedEntry = candidate;
+				break;
+			}
+		}
+
+		const driverScene =
+			entry.scene.activity === "closing" && nextEntry
+				? entry.scene
+				: (nextPresentedEntry?.scene ??
+					nextEntry?.scene ??
+					topScene ??
+					entry.scene);
+
+		return {
+			...entry,
+			driverScene,
+		};
+	});
 }

package/src/components/overlay/helpers/retain-ready-overlay-resources.ts

@@ -0,0 +1,38 @@
+import type { ScreenAnimationContextValue } from "../../../providers/screen/animation/animation.provider";
+import type { ScreenSlotContextValue } from "../../../providers/screen/styles/slot.provider";
+import type { FloatOverlayEntry } from "./get-active-overlay";
+
+export type ReadyOverlayResources = {
+	overlayAnimationStore: ScreenAnimationContextValue;
+	driverScene: FloatOverlayEntry["scene"];
+	driverAnimationStore: ScreenAnimationContextValue;
+	driverSlots: ScreenSlotContextValue;
+};
+
+export function retainReadyOverlayResources(
+	previous: ReadyOverlayResources | null,
+	overlayAnimationStore: ScreenAnimationContextValue | null,
+	driverScene: FloatOverlayEntry["scene"],
+	driverAnimationStore: ScreenAnimationContextValue | null,
+	driverSlots: ScreenSlotContextValue | null,
+): ReadyOverlayResources | null {
+	if (!overlayAnimationStore || !driverAnimationStore || !driverSlots) {
+		return previous;
+	}
+
+	if (
+		previous?.overlayAnimationStore === overlayAnimationStore &&
+		previous.driverScene === driverScene &&
+		previous.driverAnimationStore === driverAnimationStore &&
+		previous.driverSlots === driverSlots
+	) {
+		return previous;
+	}
+
+	return {
+		overlayAnimationStore,
+		driverScene,
+		driverAnimationStore,
+		driverSlots,
+	};
+}

package/src/components/overlay/helpers/run-overlay-slot-interpolator.ts

@@ -0,0 +1,48 @@
+import type { ScreenInterpolatorFrame } from "../../../providers/screen/animation/helpers/pipeline";
+import { createInterpolatorScope } from "../../../providers/screen/styles/helpers/create-interpolator-scope";
+import { normalizeSlots } from "../../../providers/screen/styles/helpers/normalize-slots";
+import { selectInterpolatorFrame } from "../../../providers/screen/styles/helpers/select-interpolator-frame";
+import type {
+	NormalizedTransitionSlotStyle,
+	ScreenStyleInterpolator,
+	ScreenTransitionAccessor,
+} from "../../../types/animation.types";
+import { logger } from "../../../utils/logger";
+
+export const runOverlaySlotInterpolator = ({
+	frame,
+	interpolator,
+	transition,
+}: {
+	frame: ScreenInterpolatorFrame;
+	interpolator: ScreenStyleInterpolator | undefined;
+	transition: ScreenTransitionAccessor;
+}): NormalizedTransitionSlotStyle | undefined => {
+	"worklet";
+
+	if (!interpolator) {
+		return undefined;
+	}
+
+	try {
+		const raw = interpolator(
+			createInterpolatorScope({
+				frame,
+				selectedFrame: selectInterpolatorFrame(frame, false),
+				transition,
+			}),
+		);
+
+		if (!raw?.overlay) {
+			return undefined;
+		}
+
+		return normalizeSlots({ overlay: raw.overlay }).overlay;
+	} catch (_) {
+		if (__DEV__) {
+			logger.warn("screenStyleInterpolator must be a worklet");
+		}
+
+		return undefined;
+	}
+};

package/src/components/overlay/hooks/use-overlay-slot.ts

@@ -0,0 +1,121 @@
+import { useMemo } from "react";
+import { useWindowDimensions } from "react-native";
+import {
+	type SharedValue,
+	useAnimatedProps,
+	useAnimatedStyle,
+	useDerivedValue,
+} from "react-native-reanimated";
+import { NO_PROPS, NO_STYLES } from "../../../constants";
+import type { ScreenAnimationContextValue } from "../../../providers/screen/animation/animation.provider";
+import { useBuildTransitionAccessor } from "../../../providers/screen/animation/helpers/accessors/use-build-transition-accessor";
+import { collectInterpolatorSharedValues } from "../../../providers/screen/styles/helpers/collect-interpolator-shared-values";
+import type {
+	NormalizedTransitionSlotStyle,
+	ScreenStyleInterpolator,
+} from "../../../types/animation.types";
+import { getVisibilityBlockOffset } from "../../../utils/visibility-block-offset";
+import {
+	createOverlayInterpolatorFrame,
+	shouldUseOverlayGestureDriver,
+} from "../helpers/create-overlay-interpolator-frame";
+import { runOverlaySlotInterpolator } from "../helpers/run-overlay-slot-interpolator";
+
+export const useOverlaySlot = ({
+	overlayAnimationStore,
+	overlayInterpolator,
+	driverAnimationStore,
+	previousOverlayAnimationStore,
+	driverInterpolator,
+	interpolatorReady,
+	isIncoming,
+}: {
+	overlayAnimationStore: ScreenAnimationContextValue;
+	overlayInterpolator: ScreenStyleInterpolator | undefined;
+	driverAnimationStore: ScreenAnimationContextValue;
+	previousOverlayAnimationStore?: ScreenAnimationContextValue;
+	driverInterpolator: ScreenStyleInterpolator | undefined;
+	interpolatorReady: SharedValue<number>;
+	isIncoming: boolean;
+}) => {
+	const { height } = useWindowDimensions();
+	const overlayTransition = useBuildTransitionAccessor(overlayAnimationStore);
+	const driverTransition = useBuildTransitionAccessor(driverAnimationStore);
+
+	const interpolatorSharedValues = useMemo(
+		() =>
+			collectInterpolatorSharedValues([
+				overlayInterpolator,
+				driverInterpolator,
+			]),
+		[overlayInterpolator, driverInterpolator],
+	);
+
+	const overlaySlot = useDerivedValue<
+		NormalizedTransitionSlotStyle | undefined
+	>(() => {
+		"worklet";
+		overlayAnimationStore.screenInterpolatorPropsRevision.get();
+		driverAnimationStore.screenInterpolatorPropsRevision.get();
+		previousOverlayAnimationStore?.screenInterpolatorPropsRevision.get();
+
+		for (let index = 0; index < interpolatorSharedValues.length; index++) {
+			interpolatorSharedValues[index]?.get();
+		}
+
+		const overlayFrame = overlayAnimationStore.screenInterpolatorProps.get();
+		const driverFrame = driverAnimationStore.screenInterpolatorProps.get();
+		const overlayOwnsGesture = shouldUseOverlayGestureDriver(
+			overlayFrame,
+			driverFrame,
+		);
+		const frame = createOverlayInterpolatorFrame({
+			overlayFrame,
+			driverFrame: overlayOwnsGesture ? overlayFrame : driverFrame,
+			previousOverlayFrame:
+				previousOverlayAnimationStore?.screenInterpolatorProps.get(),
+		});
+
+		return runOverlaySlotInterpolator({
+			frame,
+			interpolator: overlayOwnsGesture
+				? overlayInterpolator
+				: driverInterpolator,
+			transition: overlayOwnsGesture ? overlayTransition : driverTransition,
+		});
+	});
+
+	const animatedStyle = useAnimatedStyle(() => {
+		"worklet";
+		const slot = overlaySlot.get();
+		if (!slot) {
+			return NO_STYLES;
+		}
+
+		if (isIncoming && !interpolatorReady.get()) {
+			return {
+				transform: [{ translateY: getVisibilityBlockOffset(height) }],
+			};
+		}
+
+		return slot.style ?? NO_STYLES;
+	});
+
+	const animatedProps = useAnimatedProps(() => {
+		"worklet";
+		const slotProps = overlaySlot.get()?.props;
+		if (!slotProps) {
+			return NO_PROPS;
+		}
+
+		const {
+			pointerEvents: _pointerEvents,
+			teleport: _teleport,
+			...props
+		} = slotProps;
+
+		return props;
+	});
+
+	return { animatedProps, animatedStyle };
+};