react-native-screen-transitions 3.10.0 → 3.11.0

package/src/shared/providers/stack/blank-stack.provider.tsx

@@ -1,51 +1,70 @@
 import type { Route } from "@react-navigation/native";
-import * as React from "react";
-import { useMemo } from "react";
+import { type ReactNode, useMemo } from "react";
 import {
 	type StackContextValue,
 	StackProvider,
 } from "../../hooks/navigation/use-stack";
 import type {
-	BlankStackProviderContextValue,
 	BlankStackProviderProps,
-	BlankStackProviderRenderProps,
-	BlankStackProviderResult,
+	BlankStackStoreValue,
 } from "../../types/providers/blank-stack-provider.types";
 import type {
 	BaseStackDescriptor,
 	BaseStackNavigation,
 	BaseStackScene,
 } from "../../types/stack.types";
+import createProvider from "../../utils/create-provider";
 import { useBlankStackState } from "./blank-stack-state";
-import { useStackCoreContext } from "./core.provider";
+import { useStackCoreStore } from "./core.provider";
 
-const BlankStackProviderContext =
-	React.createContext<BlankStackProviderContextValue | null>(null);
-BlankStackProviderContext.displayName = "BlankStackProvider";
+type InternalBlankStackProviderProps = BlankStackProviderProps<
+	BaseStackDescriptor,
+	BaseStackNavigation
+> & {
+	children: ReactNode;
+};
+
+const createScenesByKey = <TDescriptor extends BaseStackDescriptor>(
+	scenes: BaseStackScene<TDescriptor>[],
+) => {
+	const scenesByKey: Record<string, BaseStackScene<TDescriptor>> = {};
 
-function useBlankStackContext(): BlankStackProviderContextValue {
-	const context = React.useContext(BlankStackProviderContext);
-	if (!context) {
-		throw new Error(
-			"useBlankStackContext must be used within BlankStackProvider",
-		);
+	for (const scene of scenes) {
+		scenesByKey[scene.route.key] = scene;
 	}
-	return context;
-}
 
-function useBlankStackProviderValue<
-	TDescriptor extends BaseStackDescriptor,
-	TNavigation extends BaseStackNavigation,
->(
-	props: BlankStackProviderProps<TDescriptor, TNavigation>,
-): BlankStackProviderResult<TDescriptor> {
-	const { flags } = useStackCoreContext();
-	const { state, handleCloseRoute, requestDismiss } = useBlankStackState(props);
-	const navigatorKey = props.state.key;
+	return scenesByKey;
+};
 
-	const focusedIndex = props.state.index;
+type BlankStackStoreProviderProps = {
+	children: ReactNode;
+	value: BlankStackStoreValue<BaseStackDescriptor>;
+};
 
-	const stackContextValue = useMemo<StackContextValue>(
+const { BlankStackProvider: BlankStackStoreProvider, useBlankStackStore } =
+	createProvider("BlankStack", { guarded: false })<
+		BlankStackStoreProviderProps,
+		BlankStackStoreValue<BaseStackDescriptor>
+	>(({ children, value }) => ({ children, value }));
+
+function BlankStackProvider({
+	state: stackState,
+	children,
+	...props
+}: InternalBlankStackProviderProps) {
+	const flags = useStackCoreStore((store) => store.flags);
+	const { state, handleCloseRoute, requestDismiss } = useBlankStackState({
+		...props,
+		state: stackState,
+	});
+	const navigatorKey = stackState.key;
+	const focusedIndex = stackState.index;
+	const scenesByKey = useMemo(
+		() => createScenesByKey(state.scenes),
+		[state.scenes],
+	);
+
+	const stackValue = useMemo<StackContextValue>(
 		() => ({
 			flags,
 			navigatorKey,
@@ -65,54 +84,26 @@ function useBlankStackProviderValue<
 			requestDismiss,
 		],
 	);
+	const blankStackValue = {
+		navigatorKey,
+		routeKeys: state.routeKeys,
+		routes: state.routes,
+		scenes: state.scenes,
+		scenesByKey,
+		focusedIndex,
+		requestDismiss,
+		shouldShowFloatOverlay: state.shouldShowFloatOverlay,
+		handleCloseRoute,
+	};
 
-	const blankStackProviderContextValue =
-		useMemo<BlankStackProviderContextValue>(
-			() => ({
-				handleCloseRoute,
-			}),
-			[handleCloseRoute],
-		);
-
-	const renderProps = useMemo<BlankStackProviderRenderProps<TDescriptor>>(
-		() => ({
-			scenes: state.scenes,
-			focusedIndex,
-			shouldShowFloatOverlay: state.shouldShowFloatOverlay,
-		}),
-		[state.scenes, focusedIndex, state.shouldShowFloatOverlay],
+	return (
+		<StackProvider value={stackValue}>
+			<BlankStackStoreProvider value={blankStackValue}>
+				{children}
+			</BlankStackStoreProvider>
+		</StackProvider>
 	);
-
-	return { stackContextValue, blankStackProviderContextValue, renderProps };
-}
-
-function withBlankStack<
-	TDescriptor extends BaseStackDescriptor = BaseStackDescriptor,
-	TNavigation extends BaseStackNavigation = BaseStackNavigation,
->(
-	Component: React.ComponentType<BlankStackProviderRenderProps<TDescriptor>>,
-): React.FC<BlankStackProviderProps<TDescriptor, TNavigation>> {
-	return function BlankStackProvider(
-		props: BlankStackProviderProps<TDescriptor, TNavigation>,
-	) {
-		const { stackContextValue, blankStackProviderContextValue, renderProps } =
-			useBlankStackProviderValue<TDescriptor, TNavigation>(props);
-
-		return (
-			<StackProvider value={stackContextValue}>
-				<BlankStackProviderContext.Provider
-					value={blankStackProviderContextValue}
-				>
-					<Component {...renderProps} />
-				</BlankStackProviderContext.Provider>
-			</StackProvider>
-		);
-	};
 }
 
-export type {
-	BlankStackProviderContextValue,
-	BlankStackProviderProps,
-	BlankStackProviderRenderProps,
-};
-export { useBlankStackContext, withBlankStack };
+export type { BlankStackProviderProps, BlankStackStoreValue };
+export { BlankStackProvider, useBlankStackStore };

package/src/shared/providers/stack/core.provider.tsx

@@ -1,6 +1,5 @@
 import { SafeAreaProviderCompat } from "@react-navigation/elements";
-import type * as React from "react";
-import { useMemo } from "react";
+import { memo, type ReactNode, useMemo } from "react";
 import { StyleSheet } from "react-native";
 import { GestureHandlerRootView } from "react-native-gesture-handler";
 import { StackType } from "../../types/stack.types";
@@ -15,7 +14,7 @@ export interface StackCoreConfig {
 
 interface StackCoreProviderProps {
 	config: StackCoreConfig;
-	children: React.ReactNode;
+	children: ReactNode;
 }
 
 export interface StackCoreContextValue {
@@ -27,84 +26,55 @@ export interface StackCoreContextValue {
 	};
 }
 
-const { StackCoreProvider: InternalStackCoreProvider, useStackCoreContext } =
-	createProvider("StackCore", { guarded: true })<
-		StackCoreProviderProps,
-		StackCoreContextValue
-	>(({ config, children }) => {
-		const {
-			TRANSITIONS_ALWAYS_ON = false,
-			DISABLE_NATIVE_SCREENS = false,
-			DISABLE_NATIVE_SCREEN_CONTAINER = false,
-			STACK_TYPE = StackType.BLANK,
-		} = config;
+const StackCoreRoot = memo(function StackCoreRoot({
+	children,
+	stackType,
+}: {
+	children: ReactNode;
+	stackType: StackType;
+}) {
+	return (
+		<GestureHandlerRootView
+			style={styles.container}
+			pointerEvents={stackType === StackType.COMPONENT ? "box-none" : undefined}
+		>
+			<SafeAreaProviderCompat>{children}</SafeAreaProviderCompat>
+		</GestureHandlerRootView>
+	);
+});
 
-		const flags = useMemo(
-			() => ({
-				TRANSITIONS_ALWAYS_ON,
-				STACK_TYPE,
-				DISABLE_NATIVE_SCREENS,
-				DISABLE_NATIVE_SCREEN_CONTAINER,
-			}),
-			[
-				TRANSITIONS_ALWAYS_ON,
-				STACK_TYPE,
-				DISABLE_NATIVE_SCREENS,
-				DISABLE_NATIVE_SCREEN_CONTAINER,
-			],
-		);
+export const { StackCoreProvider, useStackCoreStore } = createProvider(
+	"StackCore",
+	{ guarded: true },
+)<StackCoreProviderProps, StackCoreContextValue>(({ config, children }) => {
+	const {
+		TRANSITIONS_ALWAYS_ON = false,
+		DISABLE_NATIVE_SCREENS = false,
+		DISABLE_NATIVE_SCREEN_CONTAINER = false,
+		STACK_TYPE = StackType.BLANK,
+	} = config;
 
-		return {
-			value: { flags },
-			children: (
-				<GestureHandlerRootView
-					style={styles.container}
-					pointerEvents={
-						STACK_TYPE === StackType.COMPONENT ? "box-none" : undefined
-					}
-				>
-					<SafeAreaProviderCompat>{children}</SafeAreaProviderCompat>
-				</GestureHandlerRootView>
-			),
-		};
-	});
+	const flags = useMemo(
+		() => ({
+			TRANSITIONS_ALWAYS_ON,
+			STACK_TYPE,
+			DISABLE_NATIVE_SCREENS,
+			DISABLE_NATIVE_SCREEN_CONTAINER,
+		}),
+		[
+			TRANSITIONS_ALWAYS_ON,
+			STACK_TYPE,
+			DISABLE_NATIVE_SCREENS,
+			DISABLE_NATIVE_SCREEN_CONTAINER,
+		],
+	);
 
-/**
- * HOC that wraps a component with the StackCore provider.
- * Just a simple open gate
- */
-export function withStackCore<TProps extends object>(
-	defaultConfig: StackCoreConfig,
-	Component: React.ComponentType<TProps>,
-): React.FC<TProps & StackCoreConfig> {
-	return function StackCoreWrapper({
-		DISABLE_NATIVE_SCREENS,
-		DISABLE_NATIVE_SCREEN_CONTAINER,
-		TRANSITIONS_ALWAYS_ON,
-		STACK_TYPE,
-		...props
-	}: TProps & StackCoreConfig) {
-		// Start from defaults, then apply explicit overrides from the caller.
-		const config: StackCoreConfig = {
-			TRANSITIONS_ALWAYS_ON:
-				TRANSITIONS_ALWAYS_ON ?? defaultConfig.TRANSITIONS_ALWAYS_ON,
-			STACK_TYPE: STACK_TYPE ?? defaultConfig.STACK_TYPE,
-			DISABLE_NATIVE_SCREENS:
-				DISABLE_NATIVE_SCREENS ?? defaultConfig.DISABLE_NATIVE_SCREENS,
-			DISABLE_NATIVE_SCREEN_CONTAINER:
-				DISABLE_NATIVE_SCREEN_CONTAINER ??
-				defaultConfig.DISABLE_NATIVE_SCREEN_CONTAINER,
-		};
-		return (
-			<InternalStackCoreProvider config={config}>
-				<Component {...(props as TProps)} />
-			</InternalStackCoreProvider>
-		);
+	return {
+		value: { flags },
+		children: <StackCoreRoot stackType={STACK_TYPE}>{children}</StackCoreRoot>,
 	};
-}
+});
 
 const styles = StyleSheet.create({
 	container: { flex: 1 },
 });
-
-export { useStackCoreContext };

package/src/shared/providers/stack/direct.provider.tsx

@@ -1,5 +1,4 @@
-import type * as React from "react";
-import { useMemo } from "react";
+import { type ReactNode, useMemo } from "react";
 import type { NativeStackDescriptorMap } from "../../../native-stack/types";
 import {
 	type StackContextValue,
@@ -10,16 +9,34 @@ import type {
 	DirectStackProps,
 	DirectStackScene,
 } from "../../types/providers/direct-stack.types";
+import createProvider from "../../utils/create-provider";
 import { isOverlayVisible } from "../../utils/overlay/visibility";
-import { useStackCoreContext } from "./core.provider";
+import { useStackCoreStore } from "./core.provider";
 
-function useDirectStackValue(
-	props: DirectStackProps,
-): DirectStackContextValue & { stackContextValue: StackContextValue } {
-	const { state, navigation, descriptors, describe } = props;
-	const { flags } = useStackCoreContext();
-	const navigatorKey = state.key;
+type DirectStackProviderProps = DirectStackProps & {
+	children: ReactNode;
+};
+
+type DirectStackStoreProviderProps = {
+	children: ReactNode;
+	value: DirectStackContextValue;
+};
 
+const { DirectStackProvider: DirectStackStoreProvider, useDirectStackStore } =
+	createProvider("DirectStack", { guarded: true })<
+		DirectStackStoreProviderProps,
+		DirectStackContextValue
+	>(({ children, value }) => ({ children, value }));
+
+function DirectStackProvider({
+	state,
+	navigation,
+	descriptors,
+	describe,
+	children,
+}: DirectStackProviderProps) {
+	const flags = useStackCoreStore((store) => store.flags);
+	const navigatorKey = state.key;
 	const preloadedDescriptors = useMemo(() => {
 		return state.preloadedRoutes.reduce<NativeStackDescriptorMap>(
 			(acc, route) => {
@@ -41,23 +58,41 @@ function useDirectStackValue(
 			};
 			let shouldShowFloatOverlay = false;
 
-			for (const route of allRoutes) {
+			for (let index = 0; index < allRoutes.length; index++) {
+				const route = allRoutes[index];
+				if (!route) {
+					throw new Error(`Missing native stack route at index ${index}.`);
+				}
 				const descriptor = allDescriptors[route.key];
 				const isPreloaded =
 					preloadedDescriptors[route.key] !== undefined &&
 					descriptors[route.key] === undefined;
 
-				scenes.push({ route, descriptor, isPreloaded });
+				if (!descriptor) {
+					throw new Error(
+						`Missing native descriptor for route "${route.key}".`,
+					);
+				}
+
+				scenes.push({
+					activity:
+						index === state.index
+							? "active"
+							: index === state.index - 1
+								? "inert"
+								: "inactive",
+					route,
+					descriptor,
+					isPreloaded,
+				});
 				routeKeys.push(route.key);
 
-				if (!shouldShowFloatOverlay && descriptor) {
-					const options = descriptor.options;
-					if (
-						options?.enableTransitions === true &&
-						isOverlayVisible(options)
-					) {
-						shouldShowFloatOverlay = true;
-					}
+				if (
+					!shouldShowFloatOverlay &&
+					descriptor.options?.enableTransitions === true &&
+					isOverlayVisible(descriptor.options)
+				) {
+					shouldShowFloatOverlay = true;
 				}
 			}
 
@@ -70,13 +105,13 @@ function useDirectStackValue(
 		}, [
 			state.routes,
 			state.preloadedRoutes,
+			state.index,
 			preloadedDescriptors,
 			descriptors,
 		]);
 
 	const focusedIndex = state.index;
-
-	const stackContextValue = useMemo<StackContextValue>(
+	const stackValue = useMemo<StackContextValue>(
 		() => ({
 			flags,
 			navigatorKey,
@@ -87,43 +122,28 @@ function useDirectStackValue(
 		}),
 		[flags, navigatorKey, routeKeys, allRoutes, scenes, focusedIndex],
 	);
+	const directStackValue = {
+		state,
+		navigation,
+		descriptors,
+		scenes,
+		focusedIndex,
+		shouldShowFloatOverlay,
+	};
 
-	// DirectStack context value
-	const lifecycleValue = useMemo<DirectStackContextValue>(
-		() => ({
-			state,
-			navigation,
-			descriptors,
-			scenes,
-			focusedIndex,
-			shouldShowFloatOverlay,
-		}),
-		[
-			state,
-			navigation,
-			descriptors,
-			scenes,
-			focusedIndex,
-			shouldShowFloatOverlay,
-		],
+	return (
+		<StackProvider value={stackValue}>
+			<DirectStackStoreProvider value={directStackValue}>
+				{children}
+			</DirectStackStoreProvider>
+		</StackProvider>
 	);
-
-	return { ...lifecycleValue, stackContextValue };
 }
 
-function withDirectStack<TProps extends DirectStackProps>(
-	Component: React.ComponentType<DirectStackContextValue>,
-): React.FC<TProps> {
-	return function DirectStackProvider(props: TProps) {
-		const { stackContextValue, ...lifecycleValue } = useDirectStackValue(props);
-
-		return (
-			<StackProvider value={stackContextValue}>
-				<Component {...lifecycleValue} />
-			</StackProvider>
-		);
-	};
-}
-
-export type { DirectStackContextValue, DirectStackProps, DirectStackScene };
-export { withDirectStack };
+export type {
+	DirectStackContextValue,
+	DirectStackProps,
+	DirectStackProviderProps,
+	DirectStackScene,
+};
+export { DirectStackProvider, useDirectStackStore };

package/src/shared/stores/animation.store.ts

@@ -3,6 +3,8 @@ import {
 	makeMutable,
 	type SharedValue,
 } from "react-native-reanimated";
+import { FALSE, TRUE } from "../constants";
+import { emit } from "../utils/animation/emit";
 import { createStore } from "../utils/create-store";
 
 export type AnimationStoreMap = {
@@ -16,6 +18,23 @@ export type AnimationStoreMap = {
 	entering: SharedValue<number>;
 };
 
+export const emitMotionStart = (animations: AnimationStoreMap) => {
+	"worklet";
+
+	animations.progressSettled.set(FALSE);
+
+	if (animations.progressAnimating.get()) {
+		return false;
+	}
+
+	emit(animations.willAnimate, TRUE, FALSE);
+	requestAnimationFrame(() => {
+		"worklet";
+		animations.progressAnimating.set(TRUE);
+	});
+	return true;
+};
+
 function createAnimationBag(): AnimationStoreMap {
 	return {
 		transitionProgress: makeMutable(0),

package/src/shared/types/gesture.types.ts

@@ -222,8 +222,14 @@ export type GestureValues = {
 	raw: RawGestureValues;
 	/**
 	 * The gesture that is currently active.
+	 *
+	 * @deprecated Use `initiator` for the accepted activation identity.
 	 */
 	active: ActiveGesture | null;
+	/**
+	 * The accepted activation identity for the current gesture attempt.
+	 */
+	initiator: ActiveGesture | "none";
 	/**
 	 * The initial pan direction that activated the gesture.
 	 *
@@ -240,6 +246,9 @@ export type GestureValues = {
 	handoff: GestureHandoffValues;
 	/**
 	 * A flag indicating if the screen is in the process of dismissing (0 or 1).
+	 *
+	 * @deprecated Use `closing` for public screen lifecycle state. Release handoff
+	 * details do not have a public replacement.
 	 */
 	dismissing: number;
 	/**
@@ -248,6 +257,8 @@ export type GestureValues = {
 	dragging: number;
 	/**
 	 * A flag indicating if released gesture values are animating back to neutral.
+	 *
+	 * @deprecated Use `animating` or `settled` for public motion state.
 	 */
 	settling: number;
 	/** @deprecated Use `normX` instead. */

package/src/shared/types/providers/blank-stack-provider.types.ts

@@ -1,4 +1,3 @@
-import type { StackContextValue } from "../../hooks/navigation/use-stack";
 import type {
 	BaseStackDescriptor,
 	BaseStackNavigation,
@@ -10,7 +9,7 @@ import type {
 
 /**
  * Props for blank stack - generic over descriptor and navigation types.
- * Defaults to base types for backward compatibility.
+ * Defaults to the shared base types.
  */
 export interface BlankStackProviderProps<
 	TDescriptor extends BaseStackDescriptor = BaseStackDescriptor,
@@ -29,29 +28,16 @@ export interface BlankStackProviderProps<
  * Context value for blank stack — only fields unique to blank stack lifecycle.
  * Shared fields (routes, scenes, etc.) live in StackContext.
  */
-export interface BlankStackProviderContextValue {
-	handleCloseRoute: (payload: { route: BaseStackRoute }) => void;
-}
-
-/**
- * Props passed to the render child of `withBlankStack`.
- * Only the fields that stack-view components actually consume.
- */
-export interface BlankStackProviderRenderProps<
+export interface BlankStackStoreValue<
 	TDescriptor extends BaseStackDescriptor = BaseStackDescriptor,
 > {
+	navigatorKey: string;
+	routeKeys: string[];
+	routes: TDescriptor["route"][];
 	scenes: BaseStackScene<TDescriptor>[];
+	scenesByKey: Record<string, BaseStackScene<TDescriptor>>;
 	focusedIndex: number;
+	requestDismiss: (payload: { route: BaseStackRoute }) => boolean;
 	shouldShowFloatOverlay: boolean;
-}
-
-/**
- * Internal result shape returned by useBlankStackProviderValue.
- */
-export interface BlankStackProviderResult<
-	TDescriptor extends BaseStackDescriptor = BaseStackDescriptor,
-> {
-	stackContextValue: StackContextValue;
-	blankStackProviderContextValue: BlankStackProviderContextValue;
-	renderProps: BlankStackProviderRenderProps<TDescriptor>;
+	handleCloseRoute: (payload: { route: BaseStackRoute }) => void;
 }

package/src/shared/types/providers/direct-stack.types.ts

@@ -8,8 +8,10 @@ import type {
 	NativeStackDescriptorMap,
 	NativeStackNavigationHelpers,
 } from "../../../native-stack/types";
+import type { StackSceneActivity } from "../stack.types";
 
 export interface DirectStackScene {
+	activity: StackSceneActivity;
 	route: StackNavigationState<ParamListBase>["routes"][number];
 	descriptor: NativeStackDescriptor;
 	isPreloaded: boolean;

package/src/shared/types/screen.types.ts

@@ -169,38 +169,6 @@ export type TransitionAwareProps<T extends object> = AnimatedProps<T> & {
 	 * }
 	 */
 	styleId?: string;
-
-	/**
-	 * Marks this component for measurement to enable shared element transitions.
-	 * Components with the same tag across different screens will animate between each other.
-	 *
-	 * @example
-	 * // Screen A:
-	 * <Transition.View sharedBoundTag="profile-avatar">
-	 *   <Avatar size="small" />
-	 * </Transition.View>
-	 *
-	 * // Screen B:
-	 * <Transition.View sharedBoundTag="profile-avatar">
-	 *   <Avatar size="large" />
-	 * </Transition.View>
-	 *
-	 * @deprecated Use `Transition.Boundary` with `id` instead.
-	 */
-	sharedBoundTag?: string;
-
-	/**
-	 * Re-measures this component when the screen regains focus and updates
-	 * any matching shared-bound source link in place.
-	 *
-	 * Useful when layout can change while unfocused (for example, programmatic
-	 * ScrollView/FlatList scrolling triggered from another screen).
-	 *
-	 * @deprecated Legacy `sharedBoundTag` refresh option. The boundary
-	 * measurement pipeline refreshes layout through `Transition.Boundary`.
-	 * @default false
-	 */
-	remeasureOnFocus?: boolean;
 };
 
 export type ScreenTransitionConfig = {