react-native-screen-transitions 3.5.2 → 3.6.0-alpha.0

package/src/shared/providers/screen/gestures/hooks/use-stable-runtime-config.ts

@@ -0,0 +1,53 @@
+import { useLayoutEffect, useMemo } from "react";
+import { type SharedValue, useSharedValue } from "react-native-reanimated";
+import { AnimationStore } from "../../../../stores/animation.store";
+import { GestureStore } from "../../../../stores/gesture.store";
+import { SystemStore } from "../../../../stores/system.store";
+import { useDescriptorDerivations } from "../../descriptors";
+import type { PanGestureRuntime, PinchGestureRuntime } from "../types";
+
+type StableRuntimeConfig = PanGestureRuntime | PinchGestureRuntime;
+type PanRuntimeConfigInput = Omit<PanGestureRuntime, "stores">;
+type PinchRuntimeConfigInput = Omit<PinchGestureRuntime, "stores">;
+type StableRuntimeConfigInput = PanRuntimeConfigInput | PinchRuntimeConfigInput;
+
+export function useStableRuntimeConfig(
+	runtimeConfigInput: PanRuntimeConfigInput,
+): SharedValue<PanGestureRuntime>;
+export function useStableRuntimeConfig(
+	runtimeConfigInput: PinchRuntimeConfigInput,
+): SharedValue<PinchGestureRuntime>;
+export function useStableRuntimeConfig(
+	runtimeConfigInput: StableRuntimeConfigInput,
+): SharedValue<PanGestureRuntime> | SharedValue<PinchGestureRuntime> {
+	const { currentScreenKey } = useDescriptorDerivations();
+	const { participation, policy, gestureProgressBaseline, lockedSnapPoint } =
+		runtimeConfigInput;
+
+	const stores = useMemo(() => {
+		return {
+			gestures: GestureStore.getBag(currentScreenKey),
+			animations: AnimationStore.getBag(currentScreenKey),
+			system: SystemStore.getBag(currentScreenKey),
+		};
+	}, [currentScreenKey]);
+
+	const runtimeConfig = useMemo<StableRuntimeConfig>(() => {
+		return {
+			participation,
+			policy,
+			stores,
+			gestureProgressBaseline,
+			lockedSnapPoint,
+		} as StableRuntimeConfig;
+	}, [participation, policy, stores, gestureProgressBaseline, lockedSnapPoint]);
+	const stableRuntimeConfig = useSharedValue(runtimeConfig);
+
+	useLayoutEffect(() => {
+		stableRuntimeConfig.set(runtimeConfig);
+	}, [stableRuntimeConfig, runtimeConfig]);
+
+	return stableRuntimeConfig as
+		| SharedValue<PanGestureRuntime>
+		| SharedValue<PinchGestureRuntime>;
+}

package/src/shared/providers/{gestures → screen/gestures}/index.tsx

@@ -6,5 +6,7 @@ export type {
 	DirectionClaim,
 	DirectionClaimMap,
 	GestureContextType,
-	ScrollConfig,
+	ScrollGestureAxis,
+	ScrollGestureAxisState,
+	ScrollGestureState,
 } from "./types";

package/src/shared/{utils/gesture → providers/screen/gestures/ownership}/compute-claimed-directions.ts

@@ -1,42 +1,51 @@
-import type { GestureDirection } from "../../types/gesture.types";
+import { DEFAULT_GESTURE_DIRECTION } from "../../../../constants";
+import type {
+	GestureDirection,
+	PanGestureDirection,
+} from "../../../../types/gesture.types";
 import {
 	type ClaimedDirections,
 	type Direction,
 	NO_CLAIMS,
-} from "../../types/ownership.types";
+} from "../../../../types/ownership.types";
 
 /**
  * Computes which directions a screen claims ownership of.
  *
  * A screen claims a direction when:
- * 1. gestureEnabled is true AND
+ * 1. direction claiming is enabled AND
  * 2. gestureDirection includes that direction
  *
- * For snap points, both directions on the axis are claimed automatically.
- * This is because a snap point sheet handles both expand (inverse) and collapse (primary) gestures.
+ * For snap points, both directions on each configured pan axis are claimed.
+ * The first direction on an axis collapses; its inverse expands.
  *
- * @param gestureEnabled - Whether gestures are enabled for this screen
+ * @param canClaimDirections - Whether this screen can own gesture directions
  * @param gestureDirection - The gesture direction(s) configured for this screen
  * @param hasSnapPoints - Whether this screen has snap points configured
  * @returns The claimed directions for this screen
  */
 export function computeClaimedDirections(
-	gestureEnabled: boolean,
+	canClaimDirections: boolean,
 	gestureDirection: GestureDirection | GestureDirection[] | undefined,
 	hasSnapPoints: boolean,
 ): ClaimedDirections {
-	// If gestures are not enabled, claim nothing
-	if (!gestureEnabled) {
+	if (!canClaimDirections) {
 		return NO_CLAIMS;
 	}
 
-	// Default to vertical if no direction specified
-	const direction = gestureDirection ?? "vertical";
+	const direction = gestureDirection ?? DEFAULT_GESTURE_DIRECTION;
 
 	// Normalize to array
-	const directions: GestureDirection[] = Array.isArray(direction)
-		? direction
-		: [direction];
+	const directions: PanGestureDirection[] = (
+		Array.isArray(direction) ? direction : [direction]
+	).filter(
+		(dir): dir is PanGestureDirection =>
+			dir !== "pinch-in" && dir !== "pinch-out",
+	);
+
+	if (directions.length === 0) {
+		return NO_CLAIMS;
+	}
 
 	// Start with no claims
 	const claims: ClaimedDirections = {
@@ -60,8 +69,7 @@ export function computeClaimedDirections(
 		}
 	}
 
-	// For snap points, claim both directions on the axis
-	// This enables both expand (inverse) and collapse/dismiss (primary) gestures
+	// Snap points own both directions on every configured pan axis.
 	if (hasSnapPoints) {
 		const hasVerticalAxis = claims.vertical || claims["vertical-inverted"];
 		const hasHorizontalAxis =
@@ -79,15 +87,3 @@ export function computeClaimedDirections(
 
 	return claims;
 }
-
-/**
- * Checks if any direction is claimed.
- */
-export function claimsAnyDirection(claims: ClaimedDirections): boolean {
-	return (
-		claims.vertical ||
-		claims["vertical-inverted"] ||
-		claims.horizontal ||
-		claims["horizontal-inverted"]
-	);
-}

package/src/shared/{utils/gesture → providers/screen/gestures/ownership}/resolve-ownership.ts

@@ -1,10 +1,13 @@
-import type { ClaimedDirections, Direction } from "../../types/ownership.types";
+import type {
+	ClaimedDirections,
+	Direction,
+} from "../../../../types/ownership.types";
 import {
 	DIRECTIONS,
 	type DirectionOwnership,
 	NO_OWNERSHIP,
 	type OwnershipStatus,
-} from "../../types/ownership.types";
+} from "../../../../types/ownership.types";
 
 /**
  * Minimal interface for ancestor context needed for ownership resolution.
@@ -12,7 +15,7 @@ import {
  */
 interface AncestorClaimsContext {
 	claimedDirections: ClaimedDirections;
-	ancestorContext: AncestorClaimsContext | null;
+	gestureContext: AncestorClaimsContext | null;
 }
 
 /**
@@ -27,12 +30,12 @@ interface AncestorClaimsContext {
  * used in worklets since it's a plain object.
  *
  * @param selfClaims - The directions claimed by the current screen
- * @param ancestorContext - The ancestor context chain (can be null if no ancestors)
+ * @param gestureContext - The gesture context chain (can be null if no ancestors)
  * @returns Ownership status for all four directions
  */
 export function resolveOwnership(
 	selfClaims: ClaimedDirections,
-	ancestorContext: AncestorClaimsContext | null,
+	gestureContext: AncestorClaimsContext | null,
 ): DirectionOwnership {
 	const result: DirectionOwnership = { ...NO_OWNERSHIP };
 
@@ -40,7 +43,7 @@ export function resolveOwnership(
 		result[direction] = resolveDirectionOwnership(
 			direction,
 			selfClaims,
-			ancestorContext,
+			gestureContext,
 		);
 	}
 
@@ -53,7 +56,7 @@ export function resolveOwnership(
 function resolveDirectionOwnership(
 	direction: Direction,
 	selfClaims: ClaimedDirections,
-	ancestorContext: AncestorClaimsContext | null,
+	gestureContext: AncestorClaimsContext | null,
 ): OwnershipStatus {
 	// Check self first
 	if (selfClaims[direction]) {
@@ -61,12 +64,12 @@ function resolveDirectionOwnership(
 	}
 
 	// Walk ancestors looking for a claim
-	let ancestor = ancestorContext;
+	let ancestor = gestureContext;
 	while (ancestor) {
 		if (ancestor.claimedDirections?.[direction]) {
 			return "ancestor";
 		}
-		ancestor = ancestor.ancestorContext;
+		ancestor = ancestor.gestureContext;
 	}
 
 	// No one claims this direction

package/src/shared/providers/screen/gestures/ownership/should-defer-to-child-claim.ts

@@ -0,0 +1,15 @@
+import type { DirectionClaim } from "../types";
+
+/**
+ * Returns true when the current screen should fail and defer to a child claim.
+ */
+export function shouldDeferToChildClaim(
+	childClaim: DirectionClaim,
+	selfRouteKey: string,
+): boolean {
+	"worklet";
+	if (!childClaim) return false;
+	if (childClaim.routeKey === selfRouteKey) return false;
+	if (childClaim.isDismissing.get()) return false;
+	return true;
+}

package/src/shared/providers/screen/gestures/ownership/use-walk-up-and-register-shadowing-claims.ts

@@ -0,0 +1,93 @@
+import { useEffect, useMemo } from "react";
+import { GestureStore } from "../../../../stores/gesture.store";
+import {
+	type ClaimedDirections,
+	DIRECTIONS,
+	type Direction,
+} from "../../../../types/ownership.types";
+import { useDescriptorDerivations } from "../../../screen/descriptors";
+import { useGestureContext } from "../gestures.provider";
+import { walkGestureAncestors } from "../helpers/walk-gesture-ancestors";
+import type { GestureContextType } from "../types";
+
+type ShadowedAncestor = {
+	ancestor: GestureContextType;
+	directions: Direction[];
+};
+
+const NO_SHADOWED_ANCESTORS: ShadowedAncestor[] = [];
+
+/**
+ * Registers this screen with ancestors that claim the same direction.
+ *
+ * Example, when C is top-most:
+ * A claims vertical
+ * └─ B claims horizontal
+ *    └─ C claims vertical
+ *
+ * C walks up the tree and writes itself into A.childDirectionClaims.vertical.
+ * B is skipped because it does not claim vertical.
+ */
+export function useWalkUpAndRegisterShadowingClaims(
+	claimedDirections: ClaimedDirections,
+): void {
+	const parentContext = useGestureContext();
+	const { isTopMostScreen, currentScreenKey } = useDescriptorDerivations();
+
+	const shadowedAncestors = useMemo(() => {
+		if (!parentContext) return NO_SHADOWED_ANCESTORS;
+
+		const ancestors: ShadowedAncestor[] = [];
+		for (const ancestor of walkGestureAncestors(parentContext)) {
+			const shadowedDirections: Direction[] = [];
+
+			for (const dir of DIRECTIONS) {
+				if (claimedDirections[dir] && ancestor.claimedDirections?.[dir]) {
+					shadowedDirections.push(dir);
+				}
+			}
+
+			if (shadowedDirections.length > 0) {
+				ancestors.push({ ancestor, directions: shadowedDirections });
+			}
+		}
+
+		return ancestors.length ? ancestors : NO_SHADOWED_ANCESTORS;
+	}, [parentContext, claimedDirections]);
+
+	useEffect(() => {
+		if (!isTopMostScreen || !shadowedAncestors.length) {
+			return;
+		}
+
+		const isDismissing = GestureStore.getValue(currentScreenKey, "dismissing");
+
+		for (const { ancestor, directions } of shadowedAncestors) {
+			const newClaims = { ...ancestor.childDirectionClaims.get() };
+			for (const dir of directions) {
+				newClaims[dir] = { routeKey: currentScreenKey, isDismissing };
+			}
+			ancestor.childDirectionClaims.set(newClaims);
+		}
+
+		return () => {
+			for (const { ancestor, directions } of shadowedAncestors) {
+				const currentClaims = ancestor.childDirectionClaims.get();
+				const newClaims = { ...currentClaims };
+				let needsUpdate = false;
+
+				for (const dir of directions) {
+					// Only remove claims written by this screen; a newer descendant may own it now.
+					if (currentClaims[dir]?.routeKey === currentScreenKey) {
+						newClaims[dir] = null;
+						needsUpdate = true;
+					}
+				}
+
+				if (needsUpdate) {
+					ancestor.childDirectionClaims.set(newClaims);
+				}
+			}
+		};
+	}, [shadowedAncestors, currentScreenKey, isTopMostScreen]);
+}

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

@@ -0,0 +1,222 @@
+import type {
+	Gesture,
+	GestureStateChangeEvent,
+	GestureUpdateEvent,
+	PanGestureHandlerEventPayload,
+	PinchGestureHandlerEventPayload,
+} from "react-native-gesture-handler";
+import type { SharedValue } from "react-native-reanimated";
+import type { AnimationStoreMap } from "../../../stores/animation.store";
+import type { GestureStoreMap } from "../../../stores/gesture.store";
+import type { SystemStoreMap } from "../../../stores/system.store";
+import type {
+	AnimationConfig,
+	TransitionSpec,
+} from "../../../types/animation.types";
+import type {
+	GestureActivationArea,
+	GestureDirections,
+	ScrollGestureAxis,
+	ScrollGestureAxisState,
+	ScrollGestureState,
+	SnapPanDirectionConfig,
+	SnapPinchDirectionConfig,
+} from "../../../types/gesture.types";
+import type {
+	ClaimedDirections,
+	DirectionOwnership,
+} from "../../../types/ownership.types";
+import type { ScreenTransitionConfig } from "../../../types/screen.types";
+import type { EffectiveSnapPointsResult } from "./helpers/validate-snap-points";
+
+export type PanGesture = ReturnType<typeof Gesture.Pan>;
+export type PinchGesture = ReturnType<typeof Gesture.Pinch>;
+export type ComposedGesture = ReturnType<typeof Gesture.Race>;
+
+export type PanGestureEvent =
+	| GestureUpdateEvent<PanGestureHandlerEventPayload>
+	| GestureStateChangeEvent<PanGestureHandlerEventPayload>;
+
+export type PinchGestureEvent =
+	| GestureUpdateEvent<PinchGestureHandlerEventPayload>
+	| GestureStateChangeEvent<PinchGestureHandlerEventPayload>;
+
+export type { ScrollGestureAxis, ScrollGestureAxisState, ScrollGestureState };
+
+export type DirectionClaim = {
+	routeKey: string;
+	isDismissing: SharedValue<number>;
+} | null;
+
+export type DirectionClaimMap = {
+	vertical: DirectionClaim;
+	"vertical-inverted": DirectionClaim;
+	horizontal: DirectionClaim;
+	"horizontal-inverted": DirectionClaim;
+};
+
+export const NO_CLAIMS: DirectionClaimMap = {
+	vertical: null,
+	"vertical-inverted": null,
+	horizontal: null,
+	"horizontal-inverted": null,
+};
+
+export interface GestureContextType {
+	routeKey: string;
+	detectorGesture: ComposedGesture;
+	panGesture: PanGesture;
+	pinchGesture: PinchGesture;
+	scrollState: SharedValue<ScrollGestureState | null>;
+	gestureContext: GestureContextType | null;
+	claimedDirections: ClaimedDirections;
+	childDirectionClaims: SharedValue<DirectionClaimMap>;
+}
+
+export interface ScreenGestureParticipation {
+	/** Whether this route is the first route in its stack. First routes never track gestures. */
+	isFirstKey: boolean;
+	/** Whether this route can dismiss to progress 0 from a gesture release. */
+	canDismiss: boolean;
+	/** Whether recognizers can activate to expose gesture values to interpolators. */
+	canTrackGesture: boolean;
+	effectiveSnapPoints: EffectiveSnapPointsResult;
+	claimedDirections: ClaimedDirections;
+	ownershipStatus: DirectionOwnership;
+}
+
+export interface ScreenGestureConfig {
+	participation: ScreenGestureParticipation;
+	pan: PanGesturePolicy;
+	pinch: PinchGesturePolicy;
+}
+
+export interface PanGesturePolicy {
+	enabled: boolean;
+	gestureDirection: NonNullable<ScreenTransitionConfig["gestureDirection"]>;
+	panActivationDirections: GestureDirections;
+	snapAxisDirections: SnapPanDirectionConfig;
+	gestureDrivesProgress: boolean;
+	gestureSensitivity: NonNullable<ScreenTransitionConfig["gestureSensitivity"]>;
+	gestureVelocityImpact: number;
+	gestureSnapVelocityImpact: number;
+	gestureReleaseVelocityScale: number;
+	/** @deprecated v3 compatibility only. Removed in the next gesture runtime. */
+	gestureReleaseVelocityMax: number;
+	gestureActivationArea: GestureActivationArea;
+	gestureSnapLocked: boolean;
+	sheetScrollGestureBehavior: NonNullable<
+		ScreenTransitionConfig["sheetScrollGestureBehavior"]
+	>;
+	gestureResponseDistance: ScreenTransitionConfig["gestureResponseDistance"];
+	transitionSpec: TransitionSpec | undefined;
+}
+
+export interface PinchGesturePolicy {
+	enabled: boolean;
+	gestureDirection: NonNullable<ScreenTransitionConfig["gestureDirection"]>;
+	snapDirections: SnapPinchDirectionConfig;
+	pinchInEnabled: boolean;
+	pinchOutEnabled: boolean;
+	gestureDrivesProgress: boolean;
+	gestureSensitivity: NonNullable<ScreenTransitionConfig["gestureSensitivity"]>;
+	gestureSnapVelocityImpact: number;
+	gestureSnapLocked: boolean;
+	gestureReleaseVelocityScale: number;
+	/** @deprecated v3 compatibility only. Removed in the next gesture runtime. */
+	gestureReleaseVelocityMax: number;
+	transitionSpec: TransitionSpec | undefined;
+}
+
+export interface GestureRuntimeStores {
+	gestures: GestureStoreMap;
+	animations: AnimationStoreMap;
+	system: SystemStoreMap;
+}
+
+export interface PanGestureRuntime {
+	participation: ScreenGestureParticipation;
+	policy: PanGesturePolicy;
+	stores: GestureRuntimeStores;
+	gestureProgressBaseline: SharedValue<number>;
+	lockedSnapPoint: SharedValue<number>;
+}
+
+export interface PinchGestureRuntime {
+	participation: ScreenGestureParticipation;
+	policy: PinchGesturePolicy;
+	stores: GestureRuntimeStores;
+	gestureProgressBaseline: SharedValue<number>;
+	lockedSnapPoint: SharedValue<number>;
+}
+
+export interface GestureDimensions {
+	width: number;
+	height: number;
+}
+
+export interface PanTrackState {
+	x: number;
+	y: number;
+	normX: number;
+	normY: number;
+}
+
+export interface PinchTrackState {
+	scale: number;
+	normScale: number;
+}
+
+export interface PanReleaseResult {
+	target: number;
+	shouldDismiss: boolean;
+	initialVelocity: number;
+	transitionSpec: TransitionSpec | undefined;
+	resetSpec: AnimationConfig | undefined;
+}
+
+export interface PinchReleaseResult {
+	target: number;
+	shouldDismiss: boolean;
+	initialVelocity: number;
+	transitionSpec: TransitionSpec | undefined;
+	resetSpec: AnimationConfig | undefined;
+}
+
+export interface PanBehaviorStrategy {
+	primeStart: (runtime: PanGestureRuntime) => void;
+	resolveProgress: (
+		runtime: PanGestureRuntime,
+		dimensions: GestureDimensions,
+		track: PanTrackState,
+	) => number;
+	resolveRelease: (
+		event: PanGestureEvent,
+		runtime: PanGestureRuntime,
+		dimensions: GestureDimensions,
+	) => PanReleaseResult;
+}
+
+export interface PinchBehaviorStrategy {
+	primeStart: (runtime: PinchGestureRuntime) => void;
+	resolveProgress: (
+		runtime: PinchGestureRuntime,
+		track: PinchTrackState,
+	) => number;
+	resolveRelease: (
+		event: PinchGestureEvent,
+		runtime: PinchGestureRuntime,
+	) => PinchReleaseResult;
+}
+
+export interface PanBehavior {
+	onStart: () => void;
+	onUpdate: (event: PanGestureEvent) => void;
+	onEnd: (event: PanGestureEvent) => void;
+}
+
+export interface PinchBehavior {
+	onStart: (event: PinchGestureEvent) => void;
+	onUpdate: (event: PinchGestureEvent) => void;
+	onEnd: (event: PinchGestureEvent) => void;
+}