react-native-screen-transitions 2.0.6 → 2.1.0

package/src/utils/bounds/index.ts

@@ -1,8 +1,26 @@
 import type { ScaledSize } from "react-native";
-import type { ScreenPhase } from "../../types/core";
+import type { MeasuredDimensions } from "react-native-reanimated";
 import type { ScreenTransitionState } from "../../types/animation";
-import { buildBoundStyles } from "./build-bound-styles";
-import { getBounds } from "./get-bounds";
+import type { BoundsAccessor, BoundsBuilder } from "../../types/bounds";
+import type { ScreenPhase } from "../../types/core";
+import type {
+	BoundsBuilderInitParams,
+	BoundsBuilderOptions,
+} from "./_types/builder";
+import {
+	computeContentTransformGeometry,
+	computeRelativeGeometry,
+} from "./_utils/geometry";
+import { getBounds } from "./_utils/get-bounds";
+import {
+	composeContentStyle,
+	composeSizeAbsolute,
+	composeSizeRelative,
+	composeTransformAbsolute,
+	composeTransformRelative,
+	type ElementComposeParams,
+} from "./_utils/style-composers";
+import { DEFAULT_BUILDER_OPTIONS, FULLSCREEN_DIMENSIONS } from "./constants";
 
 export interface BuildBoundsAccessorParams {
 	activeBoundId: string | null;
@@ -13,34 +31,266 @@ export interface BuildBoundsAccessorParams {
 	dimensions: ScaledSize;
 }
 
-export const buildBoundsAccessor = ({
+const EMPTY_STYLE = Object.freeze({});
+const EMPTY_STYLE_RAW = Object.freeze({
+	scaleX: 1,
+	scaleY: 1,
+	scale: 1,
+	translateX: 0,
+	translateY: 0,
+	width: 0,
+	height: 0,
+});
+
+const ENTER_RANGE = [0, 1] as const;
+const EXIT_RANGE = [1, 2] as const;
+
+const resolveBounds = (props: {
+	id: string;
+	previous?: ScreenTransitionState;
+	current?: ScreenTransitionState;
+	next?: ScreenTransitionState;
+	toRect?: Partial<MeasuredDimensions>;
+	dimensions: ScaledSize;
+	computeOptions: BoundsBuilderOptions;
+}) => {
+	"worklet";
+	const entering = !props.next;
+
+	const fullscreen = FULLSCREEN_DIMENSIONS(props.dimensions);
+
+	const startPhase: ScreenPhase = entering ? "previous" : "current";
+	const endPhase: ScreenPhase = entering ? "current" : "next";
+
+	const getPhaseBounds = (phase?: ScreenPhase) => {
+		"worklet";
+		switch (phase) {
+			case "previous":
+				return props.previous?.bounds?.[props.id]?.bounds;
+			case "current":
+				return props.current?.bounds?.[props.id]?.bounds;
+			case "next":
+				return props.next?.bounds?.[props.id]?.bounds;
+			default:
+				return null;
+		}
+	};
+
+	const start = getPhaseBounds(startPhase);
+	let end = getPhaseBounds(endPhase);
+
+	const isFullscreen =
+		props.computeOptions.target === "fullscreen" ||
+		props.computeOptions.toFullscreen;
+
+	if (isFullscreen) {
+		end = fullscreen;
+	}
+
+	const customTarget = props.computeOptions.target;
+
+	if (typeof customTarget === "object") {
+		end = customTarget;
+	}
+
+	return {
+		start,
+		end,
+		entering,
+	};
+};
+
+const computeBoundStyles = (
+	{
+		id,
+		previous,
+		current,
+		next,
+		progress,
+		dimensions,
+	}: BoundsBuilderInitParams,
+	computeOptions: BoundsBuilderOptions = {},
+) => {
+	"worklet";
+	if (!id) {
+		if (computeOptions.raw) {
+			return EMPTY_STYLE_RAW;
+		}
+		return EMPTY_STYLE;
+	}
+
+	const { start, end, entering } = resolveBounds({
+		id,
+		previous,
+		current,
+		next,
+		computeOptions,
+		dimensions,
+	});
+
+	if (!start || !end) {
+		if (computeOptions.raw) {
+			return EMPTY_STYLE_RAW;
+		}
+		return EMPTY_STYLE;
+	}
+
+	const ranges: readonly [number, number] = entering ? ENTER_RANGE : EXIT_RANGE;
+
+	if (computeOptions.method === "content") {
+		const geometry = computeContentTransformGeometry({
+			start,
+			end,
+			entering,
+			dimensions,
+			anchor: computeOptions.anchor,
+			scaleMode: computeOptions.scaleMode,
+		});
+
+		return composeContentStyle({
+			start,
+			progress,
+			ranges,
+			end,
+			geometry,
+			computeOptions,
+		});
+	}
+
+	const geometry = computeRelativeGeometry({
+		start,
+		end,
+		entering,
+		anchor: computeOptions.anchor,
+		scaleMode: computeOptions.scaleMode,
+	});
+
+	const common: ElementComposeParams = {
+		start,
+		end,
+		progress,
+		ranges,
+		geometry,
+		computeOptions,
+	};
+
+	const isSize = computeOptions.method === "size";
+	const isAbs =
+		computeOptions.space === "absolute" || !!computeOptions.absolute;
+
+	return isSize
+		? isAbs
+			? composeSizeAbsolute(common)
+			: composeSizeRelative(common)
+		: isAbs
+			? composeTransformAbsolute(common)
+			: composeTransformRelative(common);
+};
+
+/**
+ * @deprecated Use `createBounds` instead. We'll avoid using the builder pattern for this type of function.
+ */
+const buildBoundStyles = (params: BoundsBuilderInitParams): BoundsBuilder => {
+	"worklet";
+
+	const cfg: { options: BoundsBuilderOptions } = {
+		options: { ...DEFAULT_BUILDER_OPTIONS },
+	};
+
+	const builder = (): BoundsBuilder => ({
+		gestures: (options) => {
+			cfg.options.gestures = options;
+			return builder();
+		},
+		toFullscreen: () => {
+			cfg.options.toFullscreen = true;
+			return builder();
+		},
+		absolute: () => {
+			cfg.options.absolute = true;
+			cfg.options.relative = false;
+			return builder();
+		},
+		relative: () => {
+			cfg.options.relative = true;
+			cfg.options.absolute = false;
+			return builder();
+		},
+		transform: () => {
+			cfg.options.method = "transform";
+			return builder();
+		},
+		size: () => {
+			cfg.options.method = "size";
+			return builder();
+		},
+		content: () => {
+			cfg.options.method = "content";
+			return builder();
+		},
+		contentFill: () => {
+			cfg.options.contentScaleMode = "aspectFill";
+			return builder();
+		},
+		contentFit: () => {
+			cfg.options.contentScaleMode = "aspectFit";
+			return builder();
+		},
+
+		build: () => {
+			return computeBoundStyles(params, cfg.options);
+		},
+	});
+
+	return builder();
+};
+
+export const createBounds = ({
 	activeBoundId,
 	current,
 	previous,
 	next,
 	progress,
 	dimensions,
-}: BuildBoundsAccessorParams) => {
+}: BuildBoundsAccessorParams): BoundsAccessor => {
 	"worklet";
 
-	const bounds = (id?: string) =>
-		buildBoundStyles({
-			id: id ?? activeBoundId,
-			previous,
+	const bounds: BoundsAccessor = ((params?: string | BoundsBuilderOptions) => {
+		if (typeof params === "object") {
+			const id = params.id ?? activeBoundId;
+
+			return computeBoundStyles(
+				{
+					id,
+					current,
+					previous,
+					next,
+					progress,
+					dimensions,
+				},
+				params,
+			);
+		}
+
+		const id = typeof params === "string" ? params : activeBoundId;
+		return buildBoundStyles({
+			id,
 			current,
+			previous,
 			next,
 			progress,
 			dimensions,
 		});
+	}) as BoundsAccessor;
 
-	return Object.assign(bounds, {
-		get: (id?: string, phase?: ScreenPhase) =>
-			getBounds({
-				id: id ?? activeBoundId,
-				phase,
-				current,
-				previous,
-				next,
-			}),
-	});
+	bounds.get = (id?: string, phase?: ScreenPhase) =>
+		getBounds({
+			id: id ?? activeBoundId,
+			phase,
+			current,
+			previous,
+			next,
+		});
+
+	return bounds;
 };

package/src/utils/gesture/apply-offset-rules.ts

@@ -0,0 +1,314 @@
+import type { ScaledSize } from "react-native";
+import type { GestureStateManagerType } from "react-native-gesture-handler/lib/typescript/handlers/gestures/gestureStateManager";
+import type { SharedValue } from "react-native-reanimated";
+import {
+	type ActivationArea,
+	type GestureActivationArea,
+	GestureOffsetState,
+	type SideActivation,
+} from "../../types/gesture";
+
+type Directions = {
+	vertical: boolean;
+	verticalInverted: boolean;
+	horizontal: boolean;
+	horizontalInverted: boolean;
+};
+
+interface CheckGestureActivationProps {
+	initialTouch: { x: number; y: number };
+	touch: { x: number; y: number };
+	directions: Directions;
+	manager?: GestureStateManagerType;
+	gestureOffsetState: SharedValue<GestureOffsetState>;
+	activationArea?: GestureActivationArea;
+	dimensions: ScaledSize;
+	responseDistance?: number;
+}
+
+type NormalizedSides = {
+	left: ActivationArea;
+	right: ActivationArea;
+	top: ActivationArea;
+	bottom: ActivationArea;
+};
+
+interface ShouldActivateOrFailProps {
+	deltaX: number;
+	deltaY: number;
+	hasHorizontal: boolean;
+	hasVertical: boolean;
+	isHorizontalSwipe: boolean;
+	isVerticalSwipe: boolean;
+	allowedRight: boolean;
+	allowedLeft: boolean;
+	allowedUp: boolean;
+	allowedDown: boolean;
+	horizontalGateRight: boolean;
+	horizontalGateLeft: boolean;
+	verticalGateUp: boolean;
+	verticalGateDown: boolean;
+	isSwipingRight: boolean;
+	isSwipingLeft: boolean;
+	isSwipingUp: boolean;
+	isSwipingDown: boolean;
+}
+
+interface ReturnValues {
+	isSwipingDown: boolean;
+	isSwipingUp: boolean;
+	isSwipingRight: boolean;
+	isSwipingLeft: boolean;
+}
+
+/**
+ * 10 seems like the correct threshold for compatability with nested gestures outside of our package.
+ */
+const GESTURE_ACTIVATION_THRESHOLD_X = 10;
+const GESTURE_ACTIVATION_THRESHOLD_Y = 10;
+const GESTURE_FAIL_TOLERANCE_X = 15;
+const GESTURE_FAIL_TOLERANCE_Y = 20;
+const DEFAULT_EDGE_DISTANCE_HORIZONTAL = 50;
+const DEFAULT_EDGE_DISTANCE_VERTICAL = 135;
+const DEFAULT_ACTIVATION_AREA = "screen" as const;
+
+function normalizeSides(area?: GestureActivationArea): NormalizedSides {
+	"worklet";
+	if (!area || typeof area === "string") {
+		const mode: ActivationArea = area ?? DEFAULT_ACTIVATION_AREA;
+		return { left: mode, right: mode, top: mode, bottom: mode };
+	}
+
+	const s: SideActivation = area as SideActivation;
+	return {
+		left: s.left ?? DEFAULT_ACTIVATION_AREA,
+		right: s.right ?? DEFAULT_ACTIVATION_AREA,
+		top: s.top ?? DEFAULT_ACTIVATION_AREA,
+		bottom: s.bottom ?? DEFAULT_ACTIVATION_AREA,
+	};
+}
+
+function computeEdgeConstraints(
+	initialTouch: { x: number; y: number },
+	dimensions: ScaledSize,
+	sides: NormalizedSides,
+	responseDistance?: number,
+) {
+	"worklet";
+	const xDist = responseDistance ?? DEFAULT_EDGE_DISTANCE_HORIZONTAL;
+	const yDist = responseDistance ?? DEFAULT_EDGE_DISTANCE_VERTICAL;
+
+	const horizontalRight = sides.left === "screen" || initialTouch.x <= xDist; // right swipe checks left edge
+	const horizontalLeft =
+		sides.right === "screen" || initialTouch.x >= dimensions.width - xDist; // left swipe checks right edge
+	const verticalDown = sides.top === "screen" || initialTouch.y <= yDist; // down swipe checks top edge
+	const verticalUp =
+		sides.bottom === "screen" || initialTouch.y >= dimensions.height - yDist; // up swipe checks bottom edge
+
+	return { horizontalRight, horizontalLeft, verticalDown, verticalUp } as const;
+}
+
+function calculateSwipeDirs(deltaX: number, deltaY: number) {
+	"worklet";
+
+	const isVerticalSwipe = Math.abs(deltaY) > Math.abs(deltaX);
+	const isHorizontalSwipe = Math.abs(deltaX) > Math.abs(deltaY);
+
+	const isSwipingDown = isVerticalSwipe && deltaY > 0;
+	const isSwipingUp = isVerticalSwipe && deltaY < 0;
+	const isSwipingRight = isHorizontalSwipe && deltaX > 0;
+	const isSwipingLeft = isHorizontalSwipe && deltaX < 0;
+
+	return {
+		isSwipingDown,
+		isSwipingUp,
+		isSwipingRight,
+		isSwipingLeft,
+		isVerticalSwipe,
+		isHorizontalSwipe,
+	};
+}
+
+function shouldActivateOrFail(params: ShouldActivateOrFailProps) {
+	"worklet";
+
+	const {
+		deltaX,
+		deltaY,
+		hasHorizontal,
+		hasVertical,
+		isHorizontalSwipe,
+		isVerticalSwipe,
+		allowedRight,
+		allowedLeft,
+		allowedUp,
+		allowedDown,
+		horizontalGateRight,
+		horizontalGateLeft,
+		verticalGateUp,
+		verticalGateDown,
+		isSwipingRight,
+		isSwipingLeft,
+		isSwipingUp,
+		isSwipingDown,
+	} = params;
+
+	let shouldActivate = false;
+	let shouldFail = false;
+
+	if (hasHorizontal && isHorizontalSwipe) {
+		const hasEnoughHorizontalMovement =
+			Math.abs(deltaX) >= GESTURE_ACTIVATION_THRESHOLD_X;
+
+		const hasAcceptableVerticalDeviation =
+			Math.abs(deltaY) <= GESTURE_FAIL_TOLERANCE_X;
+
+		if (hasEnoughHorizontalMovement && hasAcceptableVerticalDeviation) {
+			const rightOk = isSwipingRight && allowedRight && horizontalGateRight;
+			const leftOk = isSwipingLeft && allowedLeft && horizontalGateLeft;
+			if (rightOk || leftOk) {
+				shouldActivate = true;
+			}
+		} else if (!hasAcceptableVerticalDeviation) {
+			shouldFail = true;
+		}
+	}
+
+	if (hasVertical && isVerticalSwipe) {
+		const hasEnoughVerticalMovement =
+			Math.abs(deltaY) >= GESTURE_ACTIVATION_THRESHOLD_Y;
+		const hasAcceptableHorizontalDeviation =
+			Math.abs(deltaX) <= GESTURE_FAIL_TOLERANCE_Y;
+
+		if (hasEnoughVerticalMovement && hasAcceptableHorizontalDeviation) {
+			const upOk = isSwipingUp && allowedUp && verticalGateUp;
+			const downOk = isSwipingDown && allowedDown && verticalGateDown;
+			if (upOk || downOk) {
+				shouldActivate = true;
+			}
+		} else if (!hasAcceptableHorizontalDeviation) {
+			shouldFail = true;
+		}
+	}
+
+	if (hasHorizontal && isHorizontalSwipe) {
+		if ((isSwipingLeft && !allowedLeft) || (isSwipingRight && !allowedRight)) {
+			shouldFail = true;
+		}
+		// If gating prohibits the dominant horizontal swipe, fail early
+		if (
+			(isSwipingRight && allowedRight && !horizontalGateRight) ||
+			(isSwipingLeft && allowedLeft && !horizontalGateLeft)
+		) {
+			shouldFail = true;
+		}
+	}
+
+	if (hasVertical && isVerticalSwipe) {
+		if ((isSwipingUp && !allowedUp) || (isSwipingDown && !allowedDown)) {
+			shouldFail = true;
+		}
+		// If gating prohibits the dominant vertical swipe, fail early
+		if (
+			(isSwipingUp && allowedUp && !verticalGateUp) ||
+			(isSwipingDown && allowedDown && !verticalGateDown)
+		) {
+			shouldFail = true;
+		}
+	}
+
+	return { shouldActivate, shouldFail };
+}
+
+/**
+ * Since we're using onTouchesMove to activate our pan, faillOffset and activateOffset don't actually work. In that case we'll create this function to use in onTouchesMove which acts simarly to the original functionality.
+ */
+export const applyOffsetRules = ({
+	initialTouch,
+	touch,
+	directions,
+	manager,
+	gestureOffsetState,
+	activationArea,
+	dimensions,
+	responseDistance,
+}: CheckGestureActivationProps): ReturnValues => {
+	"worklet";
+
+	const deltaX = touch.x - initialTouch.x;
+	const deltaY = touch.y - initialTouch.y;
+
+	const allowedDown = directions.vertical;
+	const allowedUp = directions.verticalInverted;
+	const allowedRight = directions.horizontal;
+	const allowedLeft = directions.horizontalInverted;
+
+	const hasHorizontal = allowedLeft || allowedRight;
+	const hasVertical = allowedUp || allowedDown;
+
+	const {
+		isSwipingDown,
+		isSwipingUp,
+		isSwipingRight,
+		isSwipingLeft,
+		isVerticalSwipe,
+		isHorizontalSwipe,
+	} = calculateSwipeDirs(deltaX, deltaY);
+
+	// avoid re-running the function if the activation state is already set
+	if (
+		gestureOffsetState.value === GestureOffsetState.PASSED ||
+		gestureOffsetState.value === GestureOffsetState.FAILED
+	) {
+		return {
+			isSwipingDown,
+			isSwipingUp,
+			isSwipingRight,
+			isSwipingLeft,
+		};
+	}
+
+	const sides = normalizeSides(activationArea);
+
+	const {
+		horizontalRight: horizontalGateRight,
+		horizontalLeft: horizontalGateLeft,
+		verticalDown: verticalGateDown,
+		verticalUp: verticalGateUp,
+	} = computeEdgeConstraints(initialTouch, dimensions, sides, responseDistance);
+
+	const { shouldActivate, shouldFail } = shouldActivateOrFail({
+		deltaX,
+		deltaY,
+		hasHorizontal,
+		hasVertical,
+		isHorizontalSwipe,
+		isVerticalSwipe,
+		allowedRight,
+		allowedLeft,
+		allowedUp,
+		allowedDown,
+		horizontalGateRight,
+		horizontalGateLeft,
+		verticalGateUp,
+		verticalGateDown,
+		isSwipingRight,
+		isSwipingLeft,
+		isSwipingUp,
+		isSwipingDown,
+	});
+
+	if (shouldActivate) {
+		gestureOffsetState.value = GestureOffsetState.PASSED;
+	} else if (shouldFail) {
+		gestureOffsetState.value = GestureOffsetState.FAILED;
+		manager?.fail();
+	}
+
+	return {
+		isSwipingDown,
+		isSwipingUp,
+		isSwipingRight,
+		isSwipingLeft,
+	};
+};