react-native-screen-transitions 4.0.0-alpha.7 → 4.0.0-alpha.9

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

@@ -5,9 +5,9 @@ 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 type { BoundaryLocalMeasurementValue } from "../../../types";
 import {
 	isTeleportAvailable,
 	PORTAL_POINTER_EVENTS,
@@ -36,7 +36,6 @@ type BoundaryPortalProps = {
 	boundaryId: string;
 	children: ReactNode;
 	enabled: boolean;
-	localMeasurement?: BoundaryLocalMeasurementValue;
 	placeholderRef?: AnimatedRef<View>;
 };
 
@@ -44,22 +43,15 @@ export const BoundaryPortal = memo(function BoundaryPortal({
 	boundaryId,
 	children,
 	enabled,
-	localMeasurement,
 	placeholderRef,
 }: BoundaryPortalProps) {
-	if (
-		!enabled ||
-		!localMeasurement ||
-		!isTeleportAvailable ||
-		!AnimatedNativePortal
-	) {
+	if (!enabled || !isTeleportAvailable || !AnimatedNativePortal) {
 		return children;
 	}
 
 	return (
 		<EnabledBoundaryPortal
 			boundaryId={boundaryId}
-			localMeasurement={localMeasurement}
 			placeholderRef={placeholderRef}
 		>
 			{children}
@@ -70,11 +62,8 @@ export const BoundaryPortal = memo(function BoundaryPortal({
 const EnabledBoundaryPortal = memo(function EnabledBoundaryPortal({
 	boundaryId,
 	children,
-	localMeasurement,
 	placeholderRef,
-}: Omit<BoundaryPortalProps, "enabled" | "localMeasurement"> & {
-	localMeasurement: BoundaryLocalMeasurementValue;
-}) {
+}: Omit<BoundaryPortalProps, "enabled">) {
 	if (__DEV__ && !boundaryId) {
 		logger.warnOnce(
 			"portal:missing-id",
@@ -82,10 +71,7 @@ const EnabledBoundaryPortal = memo(function EnabledBoundaryPortal({
 		);
 	}
 
-	const { teleportProps } = useBoundaryPortalAttachment({
-		boundaryId,
-		localMeasurement,
-	});
+	const { teleportProps } = useBoundaryPortalAttachment({ boundaryId });
 
 	const { handleOnLayout, placeholderStyle } = usePlaceholderStyles();
 
@@ -93,7 +79,7 @@ const EnabledBoundaryPortal = memo(function EnabledBoundaryPortal({
 		<Animated.View
 			ref={placeholderRef}
 			onLayout={({ nativeEvent: { layout } }) =>
-				runOnUI(handleOnLayout)(layout)
+				scheduleOnUI(handleOnLayout, layout)
 			}
 			style={placeholderStyle}
 			pointerEvents={PORTAL_POINTER_EVENTS}

package/src/components/boundary/portal/teleport.ts

@@ -1,4 +1,4 @@
-import { type ComponentType, createElement, type ReactNode } from "react";
+import type { ComponentType, ReactNode } from "react";
 
 /**
  * `react-native-teleport` is an optional peer dependency. The require sits in a
@@ -9,33 +9,12 @@ import { type ComponentType, createElement, type ReactNode } from "react";
  * inline rendering; everything else keeps working.
  */
 let mod: any = null;
-let managerMod: any = null;
-let providerViewMod: any = null;
 try {
 	mod = require("react-native-teleport");
-	managerMod = require("react-native-teleport/lib/module/contexts/PortalManager");
-	providerViewMod = require("react-native-teleport/lib/module/views/PortalProvider");
 } catch {}
 
-const NativePortalProviderView: ComponentType<{ children: ReactNode }> | null =
-	providerViewMod?.default ?? null;
-const PortalManagerProvider: ComponentType<{ children: ReactNode }> | null =
-	managerMod?.PortalManagerProvider ?? null;
-
 const SafeNativePortalProvider: ComponentType<{ children: ReactNode }> | null =
-	PortalManagerProvider
-		? ({ children }: { children: ReactNode }) => {
-				const managedChildren = createElement(
-					PortalManagerProvider,
-					null,
-					children,
-				);
-
-				return NativePortalProviderView
-					? createElement(NativePortalProviderView, null, managedChildren)
-					: managedChildren;
-			}
-		: null;
+	mod?.PortalProvider ?? null;
 
 export const isTeleportAvailable =
 	mod !== null && SafeNativePortalProvider !== null;

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

@@ -68,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,
@@ -101,7 +105,7 @@ export const { BoundaryRootProvider, useBoundaryRootStore } = createProvider(
 		const isCurrentScreenClosing = useBlankStackStore(
 			(store) =>
 				portalRuntime.handoff &&
-				store?.scenesByKey[currentScreenKey]?.activity === "closing",
+				store.scenesByKey[currentScreenKey]?.activity === "closing",
 		);
 		const retainedBoundTagRef = useRef(requestedBoundTag);
 		const shouldRetainClosingBoundTag =

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 };
+};

package/src/components/overlay/variations/float-overlay.tsx

@@ -1,14 +1,10 @@
-import { useMemo } from "react";
-import { snapDescriptorToIndex } from "../../../animation/snap-to";
-import { useStack } from "../../../hooks/navigation/use-stack";
-import { ScreenAnimationProvider } from "../../../providers/screen/animation";
-import type { BaseDescriptor } from "../../../providers/screen/descriptors";
-import { DescriptorsProvider } from "../../../providers/screen/descriptors";
-import { ScreenOptionsProvider } from "../../../providers/screen/options";
-import { ScreenSlotProvider } from "../../../providers/screen/styles";
-import type { OverlayScreenState } from "../../../types/overlay.types";
+import { useBlankStackStore } from "../../../providers/stack/blank-stack.provider";
+import { useStackCoreStore } from "../../../providers/stack/core.provider";
 
-import { getActiveFloatOverlay } from "../helpers/get-active-overlay";
+import {
+	getFloatOverlayStack,
+	getFloatOverlayTransitions,
+} from "../helpers/get-active-overlay";
 import { OverlayHost } from "./overlay-host";
 
 /**
@@ -16,65 +12,28 @@ import { OverlayHost } from "./overlay-host";
  * Gets routes and descriptors from stack context.
  */
 export function FloatOverlay() {
-	const { scenes, focusedIndex, flags, routes, routeKeys } = useStack();
-
-	const activeOverlay = useMemo(
-		() =>
-			getActiveFloatOverlay(scenes, focusedIndex, flags.TRANSITIONS_ALWAYS_ON),
-		[scenes, focusedIndex, flags.TRANSITIONS_ALWAYS_ON],
+	const scenes = useBlankStackStore((store) => store.scenes);
+	const transitionsAlwaysOn = useStackCoreStore(
+		(store) => store.flags.TRANSITIONS_ALWAYS_ON,
 	);
 
-	const overlayData = useMemo(() => {
-		if (!activeOverlay) return null;
-
-		const { scene, overlayIndex } = activeOverlay;
-		const previous = scenes[overlayIndex - 1]?.descriptor;
-		const current = scene.descriptor;
-		const next = scenes[overlayIndex + 1]?.descriptor;
-		const focusedScene = scenes[focusedIndex] ?? scenes[scenes.length - 1];
-		const focusedDescriptor = focusedScene?.descriptor;
-
-		const overlayScreenState: OverlayScreenState<BaseDescriptor["navigation"]> =
-			{
-				index: routeKeys.indexOf(current.route.key),
-				options: focusedDescriptor?.options ?? {},
-				routes,
-				focusedRoute: focusedScene?.route ?? current.route,
-				focusedIndex,
-				meta: focusedDescriptor?.options?.meta,
-				navigation: current.navigation,
-				snapTo: (index: number) => {
-					snapDescriptorToIndex(current, index);
-				},
-			};
-
-		return {
-			scene,
-			previous,
-			current,
-			next,
-			overlayScreenState,
-		};
-	}, [activeOverlay, scenes, focusedIndex, routeKeys, routes]);
-
-	if (!overlayData) {
+	const overlayStack = getFloatOverlayStack(scenes, transitionsAlwaysOn);
+	if (overlayStack.length === 0) {
 		return null;
 	}
 
-	const { scene, previous, current, next, overlayScreenState } = overlayData;
-
-	return (
-		<DescriptorsProvider current={current} previous={previous} next={next}>
-			<ScreenOptionsProvider>
-				<ScreenAnimationProvider>
-					<ScreenSlotProvider isFloatingOverlay>
-						<OverlayHost
-							scene={scene}
-							overlayScreenState={overlayScreenState}
-						/>
-					</ScreenSlotProvider>
-				</ScreenAnimationProvider>
-			</ScreenOptionsProvider>
-		</DescriptorsProvider>
+	const overlayTransitions = getFloatOverlayTransitions(overlayStack, scenes);
+
+	return overlayTransitions.map(
+		({ scene, activity, driverScene }, layerIndex) => (
+			<OverlayHost
+				key={scene.route.key}
+				scene={scene}
+				driverScene={driverScene}
+				previousOverlayScene={overlayTransitions[layerIndex - 1]?.scene}
+				activity={activity}
+				layerIndex={layerIndex}
+			/>
+		),
 	);
 }