react-native-screen-transitions 4.0.0-alpha.6 → 4.0.0-alpha.8

package/src/components/boundary/portal/components/boundary-portal/hooks/use-host-measurement.ts

@@ -1,61 +1,37 @@
-import { useLayoutEffect } from "react";
 import type { View } from "react-native";
 import {
 	cancelAnimation,
+	type MeasuredDimensions,
 	measure,
-	type SharedValue,
 	useAnimatedReaction,
 	useAnimatedRef,
 	useSharedValue,
 	withDelay,
 	withTiming,
 } from "react-native-reanimated";
-import { scheduleOnUI } from "react-native-worklets";
-import { ScrollStore } from "../../../../../../stores/scroll.store";
-import { getVisibilityBlockOffset } from "../../../../../../utils/visibility-block-offset";
-import {
-	adjustedMeasuredBoundsForOverscrollDeltas,
-	correctMeasuredBoundsForVisibilityGate,
-} from "../../../../utils/measured-bounds";
-import {
-	clearPortalHostBounds,
-	setPortalHostBounds,
-} from "../stores/host-bounds.store";
 
 const HOST_MEASUREMENT_RETRY_DELAY_MS = 16;
 
 type UseHostMeasurementParams = {
-	capturesScroll: boolean;
-	enabled: boolean;
-	hostKey: string;
-	screenKey: string;
-	visibilityBlocked: SharedValue<boolean>;
-	viewportHeight: number;
-	viewportWidth: number;
+	measurementKey: string | null;
 };
 
 export const useHostMeasurement = ({
-	capturesScroll,
-	enabled,
-	hostKey,
-	screenKey,
-	visibilityBlocked,
-	viewportHeight,
-	viewportWidth,
+	measurementKey,
 }: UseHostMeasurementParams) => {
 	const hostRef = useAnimatedRef<View>();
-	const scrollMetadata = ScrollStore.getValue(screenKey, "metadata");
-	const hasMeasuredHost = useSharedValue(false);
+	const hostBounds = useSharedValue<MeasuredDimensions | null>(null);
+	const measuredKey = useSharedValue<string | null>(null);
 	const retryToken = useSharedValue(0);
 
 	useAnimatedReaction(
 		() => {
 			"worklet";
-			if (!enabled) {
+			if (!measurementKey) {
 				return null;
 			}
 
-			return [hasMeasuredHost.get(), retryToken.get()] as const;
+			return [measurementKey, measuredKey.get(), retryToken.get()] as const;
 		},
 		(state) => {
 			"worklet";
@@ -64,9 +40,8 @@ export const useHostMeasurement = ({
 				return;
 			}
 
-			const [hasAlreadyMeasured] = state;
-
-			if (!enabled || hasAlreadyMeasured) {
+			const [requestedKey, completedKey] = state;
+			if (requestedKey === completedKey) {
 				return;
 			}
 
@@ -85,23 +60,7 @@ export const useHostMeasurement = ({
 
 			cancelAnimation(retryToken);
 
-			// A measurement taken mid rubber-band would bake the transient
-			// overscroll displacement into the host frame. Store the at-rest
-			// position instead; clamped scroll deltas share that basis.
-			const currentScroll = scrollMetadata.get();
-			const overscrollNormalized = capturesScroll
-				? adjustedMeasuredBoundsForOverscrollDeltas(measured, currentScroll)
-				: measured;
-
-			const correctedMeasured = correctMeasuredBoundsForVisibilityGate({
-				measured: overscrollNormalized,
-				visibilityBlocked: visibilityBlocked.get(),
-				visibilityBlockOffset: getVisibilityBlockOffset(viewportHeight),
-				viewportWidth,
-				viewportHeight,
-			});
-
-			if (correctedMeasured.width <= 0 || correctedMeasured.height <= 0) {
+			if (measured.width <= 0 || measured.height <= 0) {
 				cancelAnimation(retryToken);
 				retryToken.set(
 					withDelay(
@@ -112,27 +71,20 @@ export const useHostMeasurement = ({
 				return;
 			}
 
-			setPortalHostBounds(hostKey, {
-				x: correctedMeasured.x,
-				y: correctedMeasured.y,
-				width: correctedMeasured.width,
-				height: correctedMeasured.height,
-				pageX: correctedMeasured.pageX,
-				pageY: correctedMeasured.pageY,
-				scroll: capturesScroll ? currentScroll : null,
+			hostBounds.set({
+				x: measured.x,
+				y: measured.y,
+				width: measured.width,
+				height: measured.height,
+				pageX: measured.pageX,
+				pageY: measured.pageY,
 			});
-
-			hasMeasuredHost.set(true);
+			measuredKey.set(requestedKey);
 		},
 	);
-
-	useLayoutEffect(() => {
-		return () => {
-			scheduleOnUI(clearPortalHostBounds, hostKey);
-		};
-	}, [hostKey]);
-
 	return {
+		hostBounds,
 		hostRef,
+		measuredKey,
 	};
 };

package/src/components/boundary/portal/components/boundary-portal/index.tsx

@@ -5,7 +5,8 @@ import {
 	type ReactNode,
 } from "react";
 import type { View } from "react-native";
-import Animated, { type AnimatedRef, runOnUI } from "react-native-reanimated";
+import Animated, { type AnimatedRef } from "react-native-reanimated";
+import { scheduleOnUI } from "react-native-worklets";
 import { logger } from "../../../../../utils/logger";
 import {
 	isTeleportAvailable,
@@ -71,13 +72,14 @@ const EnabledBoundaryPortal = memo(function EnabledBoundaryPortal({
 	}
 
 	const { teleportProps } = useBoundaryPortalAttachment({ boundaryId });
+
 	const { handleOnLayout, placeholderStyle } = usePlaceholderStyles();
 
 	return (
 		<Animated.View
 			ref={placeholderRef}
 			onLayout={({ nativeEvent: { layout } }) =>
-				runOnUI(handleOnLayout)(layout)
+				scheduleOnUI(handleOnLayout, layout)
 			}
 			style={placeholderStyle}
 			pointerEvents={PORTAL_POINTER_EVENTS}

package/src/components/boundary/portal/components/boundary-portal/stores/portal-boundary-host.store.ts

@@ -1,14 +1,15 @@
 import { useSyncExternalStore } from "react";
 import type { SharedValue } from "react-native-reanimated";
 import type { NormalizedTransitionInterpolatedStyle } from "../../../../../../types/animation.types";
+import type { BoundaryLocalMeasurementValue } from "../../../../types";
 
 export type ActivePortalBoundaryHost = {
 	boundaryId: string;
 	hostKey: string;
+	localMeasurement: BoundaryLocalMeasurementValue;
 	pairKey: string;
 	portalHostName: string;
 	portalHostReady: SharedValue<boolean>;
-	screenKey: string;
 	slotsMap: SharedValue<NormalizedTransitionInterpolatedStyle>;
 };
 
@@ -54,10 +55,10 @@ const isSameHost = (
 	return (
 		a.boundaryId === b.boundaryId &&
 		a.hostKey === b.hostKey &&
+		a.localMeasurement === b.localMeasurement &&
 		a.pairKey === b.pairKey &&
 		a.portalHostName === b.portalHostName &&
 		a.portalHostReady === b.portalHostReady &&
-		a.screenKey === b.screenKey &&
 		a.slotsMap === b.slotsMap
 	);
 };

package/src/components/boundary/providers/boundary-root.provider.tsx

@@ -8,7 +8,7 @@ import {
 } from "react";
 import type { View } from "react-native";
 import type { AnimatedRef } from "react-native-reanimated";
-import { useAnimatedRef } from "react-native-reanimated";
+import { useAnimatedRef, useSharedValue } from "react-native-reanimated";
 import { useDescriptorsStore } from "../../../providers/screen/descriptors";
 import {
 	useComposedSlotStyles,
@@ -19,7 +19,7 @@ import { createBoundTag } from "../../../stores/bounds/helpers/link-pairs.helper
 import type { BoundTag } from "../../../stores/bounds/types";
 import createProvider from "../../../utils/create-provider";
 import { logger } from "../../../utils/logger";
-import { useBoundaryMeasurement } from "../hooks/use-boundary-measurement";
+import { BoundaryLifecycle } from "../components/boundary-lifecycle";
 import {
 	type BoundaryPortalRuntime,
 	resolveBoundaryPortal,
@@ -27,6 +27,8 @@ import {
 import type {
 	BoundaryConfigProps,
 	BoundaryId,
+	BoundaryLocalMeasurement,
+	BoundaryLocalMeasurementValue,
 	BoundaryOwnProps,
 } from "../types";
 
@@ -44,6 +46,7 @@ export type BoundaryRootRenderState = {
 	boundTag: BoundTag;
 	currentScreenKey: string;
 	handoffEnabled: boolean;
+	localMeasurement: BoundaryLocalMeasurementValue;
 	measurementRef: AnimatedRef<View>;
 	portalRuntime: BoundaryPortalRuntime;
 	ref: AnimatedRef<View>;
@@ -65,10 +68,14 @@ type BoundaryRootProviderProps = Pick<
 	targetStyle?: unknown;
 };
 
-export const { BoundaryRootProvider, useBoundaryRootStore } = createProvider(
-	"BoundaryRoot",
-	{ guarded: false },
-)<BoundaryRootProviderProps, BoundaryRootContextValue>(
+export const {
+	BoundaryRootProvider,
+	useBoundaryRootStore,
+	useOptionalBoundaryRootStore,
+} = createProvider("BoundaryRoot")<
+	BoundaryRootProviderProps,
+	BoundaryRootContextValue
+>(
 	({
 		children,
 		config,
@@ -96,7 +103,9 @@ export const { BoundaryRootProvider, useBoundaryRootStore } = createProvider(
 			(s) => s.derivations.currentScreenKey,
 		);
 		const isCurrentScreenClosing = useBlankStackStore(
-			(store) => store?.scenesByKey[currentScreenKey]?.activity === "closing",
+			(store) =>
+				portalRuntime.handoff &&
+				store.scenesByKey[currentScreenKey]?.activity === "closing",
 		);
 		const retainedBoundTagRef = useRef(requestedBoundTag);
 		const shouldRetainClosingBoundTag =
@@ -110,10 +119,6 @@ export const { BoundaryRootProvider, useBoundaryRootStore } = createProvider(
 		}
 
 		const boundTag = retainedBoundTagRef.current;
-		const hasConfiguredInterpolator = useDescriptorsStore(
-			(s) => s.derivations.hasConfiguredInterpolator,
-		);
-		const runtimeEnabled = enabled && hasConfiguredInterpolator;
 		// Associated slot styles attach whenever the boundary is enabled,
 		// independent of whether an interpolator is configured for this transition.
 		const shouldAttachAssociatedStyles = enabled;
@@ -123,6 +128,9 @@ export const { BoundaryRootProvider, useBoundaryRootStore } = createProvider(
 		const associatedStackingStyles = useSlotStackingStyles(boundTag.tag);
 		const rootRef = useAnimatedRef<View>();
 		const measurementRef = useAnimatedRef<View>();
+		const localMeasurement = useSharedValue<BoundaryLocalMeasurement | null>(
+			null,
+		);
 
 		useLayoutEffect(() => {
 			if (__DEV__ && targetCount > 1) {
@@ -137,18 +145,6 @@ export const { BoundaryRootProvider, useBoundaryRootStore } = createProvider(
 
 		useImperativeHandle(forwardedRef, () => rootRef.current as any, [rootRef]);
 
-		useBoundaryMeasurement({
-			boundTag,
-			enabled,
-			runtimeEnabled,
-			currentScreenKey,
-			measuredRef,
-			style: hasTarget ? targetStyle : style,
-			handoff: portalRuntime.handoff,
-			escapeClipping: portalRuntime.escapeClipping,
-			config,
-		});
-
 		const shouldRenderBoundaryRootThroughPortal =
 			shouldEscapeBoundaryRootToScreenHost && !hasTarget;
 		const handoffEnabled = enabled && portalRuntime.handoff;
@@ -173,6 +169,7 @@ export const { BoundaryRootProvider, useBoundaryRootStore } = createProvider(
 				boundTag,
 				currentScreenKey,
 				handoffEnabled,
+				localMeasurement,
 				measurementRef,
 				portalRuntime,
 				ref: rootRef,
@@ -185,6 +182,7 @@ export const { BoundaryRootProvider, useBoundaryRootStore } = createProvider(
 				currentScreenKey,
 				handoffEnabled,
 				hasTarget,
+				localMeasurement,
 				measurementRef,
 				portalRuntime,
 				rootRef,
@@ -194,7 +192,22 @@ export const { BoundaryRootProvider, useBoundaryRootStore } = createProvider(
 
 		return {
 			value,
-			children: children(value),
+			children: (
+				<>
+					{children(value)}
+					<BoundaryLifecycle
+						boundTag={boundTag}
+						config={config}
+						currentScreenKey={currentScreenKey}
+						enabled={enabled}
+						escapeClipping={portalRuntime.escapeClipping}
+						handoff={portalRuntime.handoff}
+						localMeasurement={localMeasurement}
+						measuredRef={measuredRef}
+						style={hasTarget ? targetStyle : style}
+					/>
+				</>
+			),
 		};
 	},
 );

package/src/components/boundary/types.ts

@@ -1,3 +1,4 @@
+import type { MeasuredDimensions, SharedValue } from "react-native-reanimated";
 import type { ScreenPairKey } from "../../stores/bounds/types";
 import type { BoundsOptions } from "../../utils/bounds/types/options";
 
@@ -60,3 +61,11 @@ export type MeasureTarget =
 	  };
 
 export type MeasureBoundary = (target: MeasureTarget) => void;
+
+export type BoundaryLocalMeasurement = {
+	bounds: MeasuredDimensions;
+	pairKey: ScreenPairKey;
+};
+
+export type BoundaryLocalMeasurementValue =
+	SharedValue<BoundaryLocalMeasurement | null>;

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

@@ -34,6 +34,7 @@ export const getRefreshBoundarySignal = (params: {
 	linkId: string;
 	group?: string;
 	shouldRefresh: boolean;
+	settled?: boolean;
 	closing: boolean;
 	linkState?: LinkPairsState;
 }): RefreshBoundarySignal | null => {
@@ -46,13 +47,14 @@ export const getRefreshBoundarySignal = (params: {
 		linkId,
 		group,
 		shouldRefresh,
+		settled = false,
 		closing,
 		linkState,
 	} = params;
 
 	if (!enabled) return null;
 
-	if (!shouldRefresh) {
+	if (!shouldRefresh && (!group || !settled)) {
 		return null;
 	}
 
@@ -95,16 +97,33 @@ 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("|"),
 		);
 	}
 
@@ -114,8 +133,9 @@ export const getRefreshBoundarySignal = (params: {
 
 	// 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.
@@ -123,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/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,
+	};
+}