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

package/src/shared/providers/screen/gestures/pan/pan-lifecycle.ts

@@ -0,0 +1,129 @@
+import { clamp } from "react-native-reanimated";
+import { EPSILON, FALSE, TRUE } from "../../../../constants";
+import { animateToProgress } from "../../../../utils/animation/animate-to-progress";
+import { emit } from "../../../../utils/animation/emit";
+import { normalizeGestureTranslation } from "../shared/physics";
+import type {
+	GestureDimensions,
+	PanGestureEvent,
+	PanGestureRuntime,
+	PanReleaseResult,
+	PanTrackState,
+} from "../types";
+import { buildPanReleasePlan } from "./pan-release";
+import { resetPanGestureValues } from "./pan-reset";
+
+export const startPanBase = (runtime: PanGestureRuntime) => {
+	"worklet";
+	const {
+		stores: { gestures, animations },
+		gestureProgressBaseline,
+	} = runtime;
+
+	const wasSettling = gestures.settling.get();
+	const hasResidualGesture =
+		Math.abs(gestures.normX.get()) > EPSILON ||
+		Math.abs(gestures.normY.get()) > EPSILON;
+
+	if (!wasSettling || !hasResidualGesture) {
+		emit(animations.willAnimate, TRUE, FALSE);
+	}
+
+	gestures.dragging.set(TRUE);
+	gestures.dismissing.set(0);
+	gestures.settling.set(0);
+	gestures.x.set(0);
+	gestures.y.set(0);
+	gestures.normX.set(0);
+	gestures.normY.set(0);
+	gestures.raw.x.set(0);
+	gestures.raw.y.set(0);
+	gestures.raw.normX.set(0);
+	gestures.raw.normY.set(0);
+	gestureProgressBaseline.set(animations.progress.get());
+};
+
+export const trackPanGesture = (
+	event: PanGestureEvent,
+	rawEvent: PanGestureEvent,
+	gestures: PanGestureRuntime["stores"]["gestures"],
+	dimensions: GestureDimensions,
+): PanTrackState => {
+	"worklet";
+	const { translationX: x, translationY: y } = event;
+	const { translationX: rawX, translationY: rawY } = rawEvent;
+	const { width, height } = dimensions;
+
+	const normX = clamp(normalizeGestureTranslation(x, width), -1, 1);
+	const normY = clamp(normalizeGestureTranslation(y, height), -1, 1);
+	const rawNormX = clamp(normalizeGestureTranslation(rawX, width), -1, 1);
+	const rawNormY = clamp(normalizeGestureTranslation(rawY, height), -1, 1);
+
+	gestures.x.set(x);
+	gestures.y.set(y);
+	gestures.normX.set(normX);
+	gestures.normY.set(normY);
+	gestures.raw.x.set(rawX);
+	gestures.raw.y.set(rawY);
+	gestures.raw.normX.set(rawNormX);
+	gestures.raw.normY.set(rawNormY);
+
+	return {
+		x,
+		y,
+		normX,
+		normY,
+	};
+};
+
+export const finalizePanRelease = (
+	release: PanReleaseResult,
+	runtime: PanGestureRuntime,
+	dismissScreen: (() => void) | undefined,
+	dimensions: GestureDimensions,
+	rawEvent: PanGestureEvent,
+) => {
+	"worklet";
+	const {
+		stores: { gestures, animations, system },
+	} = runtime;
+	const plan = buildPanReleasePlan(release, runtime, dimensions, rawEvent);
+
+	if (typeof plan.commitProgress === "number") {
+		animations.progress.set(plan.commitProgress);
+		system.targetProgress.set(plan.commitProgress);
+	}
+
+	resetPanGestureValues({
+		spec: plan.resetSpec,
+		gestures,
+		shouldDismiss: plan.shouldDismiss,
+		velocityX: plan.resetVelocityX,
+		velocityY: plan.resetVelocityY,
+		velocityNormX: plan.resetVelocityNormX,
+		velocityNormY: plan.resetVelocityNormY,
+		resetNormalizedValues: plan.resetNormalizedValues,
+		resetNormalizedValuesImmediately: plan.resetNormalizedValuesImmediately,
+		preserveRawValues: plan.preserveRawValues,
+	});
+
+	const progressAlreadyAtTarget =
+		Math.abs(animations.progress.get() - plan.target) <= EPSILON;
+
+	if (!plan.shouldDismiss && progressAlreadyAtTarget) {
+		system.targetProgress.set(plan.target);
+		animations.progressAnimating.set(FALSE);
+		return;
+	}
+
+	animateToProgress({
+		target: plan.target,
+		onAnimationFinish: plan.shouldDismiss ? dismissScreen : undefined,
+		spec: plan.transitionSpec,
+		emitWillAnimate: false,
+		markEntering: false,
+		targetProgress: system.targetProgress,
+		animations,
+		initialVelocity: plan.progressVelocity,
+	});
+};

package/src/shared/providers/screen/gestures/pan/pan-release.ts

@@ -0,0 +1,246 @@
+import { clamp } from "react-native-reanimated";
+import {
+	getPanSnapAxisConfigForDirection,
+	isResolvedPanGestureDirection,
+} from "../shared/directions";
+import {
+	getPanReleaseHandoffVelocity,
+	getPanReleaseProgressVelocity,
+} from "../shared/physics";
+import {
+	getProgressVelocityTowardTarget,
+	resolveGestureSnapTransitionSpec,
+} from "../shared/release";
+import {
+	primeRuntimeSnapPoint,
+	resolveRuntimeGestureSnapPoints,
+} from "../shared/snap-points";
+import { determineDismissal, determineSnapTarget } from "../shared/targets";
+import type {
+	GestureDimensions,
+	PanGestureEvent,
+	PanGestureRuntime,
+	PanReleasePlan,
+	PanReleaseResult,
+} from "../types";
+
+const resolveActivePanSnapAxis = (runtime: PanGestureRuntime) => {
+	"worklet";
+	const activeGesture = runtime.stores.gestures.active.get();
+
+	return isResolvedPanGestureDirection(activeGesture)
+		? getPanSnapAxisConfigForDirection(
+				runtime.policy.snapAxisDirections,
+				activeGesture,
+			)
+		: null;
+};
+
+const getPanSnapAxisMotion = (
+	event: PanGestureEvent,
+	dimensions: GestureDimensions,
+	activeAxis: NonNullable<ReturnType<typeof resolveActivePanSnapAxis>>,
+) => {
+	"worklet";
+	const isHorizontal = activeAxis.axis === "horizontal";
+	const axisVelocity = isHorizontal ? event.velocityX : event.velocityY;
+	const axisDimension = isHorizontal ? dimensions.width : dimensions.height;
+	const snapVelocity = activeAxis.config.inverted
+		? -axisVelocity
+		: axisVelocity;
+
+	return { axisVelocity, axisDimension, snapVelocity };
+};
+
+const getPanSnapReleaseProgress = ({
+	runtime,
+	event,
+	dimensions,
+	activeAxis,
+	minSnapPoint,
+	maxSnapPoint,
+}: {
+	runtime: PanGestureRuntime;
+	event: PanGestureEvent;
+	dimensions: GestureDimensions;
+	activeAxis: NonNullable<ReturnType<typeof resolveActivePanSnapAxis>>;
+	minSnapPoint: number;
+	maxSnapPoint: number;
+}) => {
+	"worklet";
+	const isHorizontal = activeAxis.axis === "horizontal";
+	const axisTranslation = isHorizontal
+		? event.translationX
+		: event.translationY;
+	const axisDimension = isHorizontal ? dimensions.width : dimensions.height;
+	const axisProgress = axisTranslation / Math.max(1, axisDimension);
+	const progress =
+		runtime.gestureProgressBaseline.get() +
+		activeAxis.config.progressSign * axisProgress;
+
+	return clamp(progress, minSnapPoint, maxSnapPoint);
+};
+
+const buildInactivePanSnapRelease = (
+	runtime: PanGestureRuntime,
+): PanReleaseResult => {
+	"worklet";
+	const { policy, stores } = runtime;
+
+	return {
+		target: stores.animations.progress.get(),
+		shouldDismiss: false,
+		initialVelocity: 0,
+		transitionSpec: policy.transitionSpec,
+		resetSpec: policy.transitionSpec?.open,
+	};
+};
+
+export const primeSnapPanRelease = (runtime: PanGestureRuntime) => {
+	"worklet";
+	primeRuntimeSnapPoint(runtime);
+};
+
+export const resolvePanRelease = (
+	event: PanGestureEvent,
+	runtime: PanGestureRuntime,
+	dimensions: GestureDimensions,
+): PanReleaseResult => {
+	"worklet";
+	const {
+		participation,
+		policy,
+		stores: { animations },
+	} = runtime;
+
+	const result = determineDismissal({
+		event,
+		directions: policy.panActivationDirections,
+		dimensions,
+		gestureVelocityImpact: policy.gestureVelocityImpact,
+	});
+
+	const shouldDismiss = participation.canDismiss && result.shouldDismiss;
+
+	return {
+		target: shouldDismiss ? 0 : 1,
+		shouldDismiss,
+		initialVelocity: getPanReleaseProgressVelocity({
+			animations,
+			shouldDismiss,
+			event,
+			dimensions,
+			directions: policy.panActivationDirections,
+			gestureReleaseVelocityScale: policy.gestureReleaseVelocityScale,
+		}),
+		transitionSpec: policy.transitionSpec,
+		resetSpec: shouldDismiss
+			? policy.transitionSpec?.close
+			: policy.transitionSpec?.open,
+	};
+};
+
+export const resolveSnapPanRelease = (
+	event: PanGestureEvent,
+	runtime: PanGestureRuntime,
+	dimensions: GestureDimensions,
+): PanReleaseResult => {
+	"worklet";
+	const { participation, policy, lockedSnapPoint } = runtime;
+	const activeAxis = resolveActivePanSnapAxis(runtime);
+
+	if (!activeAxis) {
+		return buildInactivePanSnapRelease(runtime);
+	}
+
+	const { axisVelocity, axisDimension, snapVelocity } = getPanSnapAxisMotion(
+		event,
+		dimensions,
+		activeAxis,
+	);
+	const { resolvedSnapPoints, resolvedMinSnapPoint, resolvedMaxSnapPoint } =
+		resolveRuntimeGestureSnapPoints(runtime);
+	const currentProgress = getPanSnapReleaseProgress({
+		runtime,
+		event,
+		dimensions,
+		activeAxis,
+		minSnapPoint: resolvedMinSnapPoint,
+		maxSnapPoint: resolvedMaxSnapPoint,
+	});
+	const result = determineSnapTarget({
+		currentProgress,
+		snapPoints: policy.gestureSnapLocked
+			? [lockedSnapPoint.get()]
+			: resolvedSnapPoints,
+		velocity: snapVelocity,
+		dimension: axisDimension,
+		velocityFactor: policy.gestureSnapVelocityImpact,
+		canDismiss: participation.canDismiss,
+	});
+
+	const shouldDismiss = participation.canDismiss && result.shouldDismiss;
+	const target = shouldDismiss ? 0 : result.targetProgress;
+
+	return {
+		target,
+		shouldDismiss,
+		initialVelocity: getProgressVelocityTowardTarget({
+			handoffVelocity: getPanReleaseHandoffVelocity(
+				axisVelocity,
+				axisDimension,
+				policy.gestureReleaseVelocityScale,
+			),
+			target,
+			currentProgress,
+		}),
+		commitProgress: currentProgress,
+		resetNormalizedValuesImmediately:
+			policy.gestureProgressMode === "progress-driven",
+		transitionSpec: resolveGestureSnapTransitionSpec({
+			transitionSpec: policy.transitionSpec,
+			shouldDismiss,
+			target,
+			currentProgress,
+		}),
+		resetSpec: shouldDismiss
+			? policy.transitionSpec?.close
+			: policy.transitionSpec?.open,
+	};
+};
+
+export const buildPanReleasePlan = (
+	release: PanReleaseResult,
+	runtime: PanGestureRuntime,
+	dimensions: GestureDimensions,
+	rawEvent: PanGestureEvent,
+): PanReleasePlan => {
+	"worklet";
+	const { policy } = runtime;
+	const progressDriven = policy.gestureProgressMode === "progress-driven";
+	const releaseVelocityScale = Math.max(0, policy.gestureReleaseVelocityScale);
+	const resetUsesReleaseVelocity = !release.shouldDismiss || !progressDriven;
+	const resetVelocityFactor = resetUsesReleaseVelocity ? 1 : 0;
+	const resetVelocityScale = releaseVelocityScale * resetVelocityFactor;
+	const resetVelocityX =
+		resetVelocityScale === 0 ? 0 : rawEvent.velocityX * resetVelocityScale;
+	const resetVelocityY =
+		resetVelocityScale === 0 ? 0 : rawEvent.velocityY * resetVelocityScale;
+
+	return {
+		target: release.target,
+		shouldDismiss: release.shouldDismiss,
+		progressVelocity: progressDriven ? release.initialVelocity : 0,
+		resetVelocityX,
+		resetVelocityY,
+		resetVelocityNormX: resetVelocityX / Math.max(1, dimensions.width),
+		resetVelocityNormY: resetVelocityY / Math.max(1, dimensions.height),
+		resetNormalizedValues: !release.shouldDismiss || progressDriven,
+		resetNormalizedValuesImmediately:
+			release.resetNormalizedValuesImmediately === true,
+		preserveRawValues: release.shouldDismiss,
+		commitProgress: release.commitProgress,
+		transitionSpec: release.transitionSpec,
+		resetSpec: release.resetSpec,
+	};
+};

package/src/shared/providers/screen/gestures/pan/pan-reset.ts

@@ -0,0 +1,92 @@
+import { EPSILON, FALSE, TRUE } from "../../../../constants";
+import type { GestureStoreMap } from "../../../../stores/gesture.store";
+import type { AnimationConfig } from "../../../../types/animation.types";
+import {
+	animateResetValue,
+	clearGestureSettlingIfResting,
+	getGestureResetSpec,
+} from "../shared/reset";
+
+interface ResetPanGestureValuesProps {
+	spec?: AnimationConfig;
+	gestures: GestureStoreMap;
+	shouldDismiss: boolean;
+	velocityX?: number;
+	velocityY?: number;
+	velocityNormX?: number;
+	velocityNormY?: number;
+	resetNormalizedValues?: boolean;
+	resetNormalizedValuesImmediately?: boolean;
+	preserveRawValues?: boolean;
+}
+
+const clearPanSettlingIfResting = (gestures: GestureStoreMap) => {
+	"worklet";
+
+	clearGestureSettlingIfResting(
+		gestures,
+		!gestures.dragging.get() &&
+			!gestures.dismissing.get() &&
+			Math.abs(gestures.x.get()) <= EPSILON &&
+			Math.abs(gestures.y.get()) <= EPSILON &&
+			Math.abs(gestures.normX.get()) <= EPSILON &&
+			Math.abs(gestures.normY.get()) <= EPSILON,
+	);
+};
+
+export const resetPanGestureValues = ({
+	spec,
+	gestures,
+	shouldDismiss,
+	velocityX,
+	velocityY,
+	velocityNormX,
+	velocityNormY,
+	resetNormalizedValues = true,
+	resetNormalizedValuesImmediately = false,
+	preserveRawValues = shouldDismiss,
+}: ResetPanGestureValuesProps) => {
+	"worklet";
+
+	if (!preserveRawValues) {
+		gestures.raw.x.set(0);
+		gestures.raw.y.set(0);
+		gestures.raw.normX.set(0);
+		gestures.raw.normY.set(0);
+	}
+
+	gestures.dragging.set(FALSE);
+	gestures.dismissing.set(shouldDismiss ? TRUE : FALSE);
+	gestures.settling.set(shouldDismiss ? FALSE : TRUE);
+
+	animateResetValue(gestures.x, 0, getGestureResetSpec(spec, velocityX), () =>
+		clearPanSettlingIfResting(gestures),
+	);
+	animateResetValue(gestures.y, 0, getGestureResetSpec(spec, velocityY), () =>
+		clearPanSettlingIfResting(gestures),
+	);
+
+	if (!resetNormalizedValues) {
+		return;
+	}
+
+	if (resetNormalizedValuesImmediately) {
+		gestures.normX.set(0);
+		gestures.normY.set(0);
+		clearPanSettlingIfResting(gestures);
+		return;
+	}
+
+	animateResetValue(
+		gestures.normX,
+		0,
+		getGestureResetSpec(spec, velocityNormX),
+		() => clearPanSettlingIfResting(gestures),
+	);
+	animateResetValue(
+		gestures.normY,
+		0,
+		getGestureResetSpec(spec, velocityNormY),
+		() => clearPanSettlingIfResting(gestures),
+	);
+};

package/src/shared/providers/screen/gestures/pan/use-pan-behavior.ts

@@ -0,0 +1,89 @@
+import { useCallback } from "react";
+import type { SharedValue } from "react-native-reanimated";
+import { useNavigationHelpers } from "../../../../hooks/navigation/use-navigation-helpers";
+import type { ScreenOptionsContextValue } from "../../options";
+import { usePanGestureSensitivity } from "../hooks/use-gesture-sensitivity";
+import { resolvePanRuntime } from "../shared/runtime";
+import type {
+	GestureDimensions,
+	PanBehavior,
+	PanGestureEvent,
+	PanGestureRuntime,
+} from "../types";
+import {
+	finalizePanRelease,
+	startPanBase,
+	trackPanGesture,
+} from "./pan-lifecycle";
+import {
+	primeSnapPanRelease,
+	resolvePanRelease,
+	resolveSnapPanRelease,
+} from "./pan-release";
+
+export const usePanBehavior = (
+	runtime: SharedValue<PanGestureRuntime>,
+	screenOptions: ScreenOptionsContextValue,
+	dimensions: GestureDimensions,
+): PanBehavior => {
+	const { dismissScreen } = useNavigationHelpers();
+	const { withSensitivity, resetSensitivity } =
+		usePanGestureSensitivity(screenOptions);
+
+	const onStart = useCallback(() => {
+		"worklet";
+		const latestRuntime = resolvePanRuntime(runtime.get(), screenOptions.get());
+		if (latestRuntime.participation.effectiveSnapPoints.hasSnapPoints) {
+			primeSnapPanRelease(latestRuntime);
+		}
+		startPanBase(latestRuntime);
+		resetSensitivity();
+	}, [runtime, screenOptions, resetSensitivity]);
+
+	const onUpdate = useCallback(
+		(rawEvent: PanGestureEvent) => {
+			"worklet";
+			const latestRuntime = resolvePanRuntime(
+				runtime.get(),
+				screenOptions.get(),
+			);
+			const event = withSensitivity(rawEvent);
+			trackPanGesture(
+				event,
+				rawEvent,
+				latestRuntime.stores.gestures,
+				dimensions,
+			);
+		},
+		[runtime, screenOptions, dimensions, withSensitivity],
+	);
+
+	const onEnd = useCallback(
+		(rawEvent: PanGestureEvent) => {
+			"worklet";
+			const latestRuntime = resolvePanRuntime(
+				runtime.get(),
+				screenOptions.get(),
+			);
+			const event = withSensitivity(rawEvent);
+			const release = latestRuntime.participation.effectiveSnapPoints
+				.hasSnapPoints
+				? resolveSnapPanRelease(event, latestRuntime, dimensions)
+				: resolvePanRelease(event, latestRuntime, dimensions);
+			finalizePanRelease(
+				release,
+				latestRuntime,
+				dismissScreen,
+				dimensions,
+				rawEvent,
+			);
+		},
+		[runtime, screenOptions, dimensions, dismissScreen, withSensitivity],
+	);
+
+	return {
+		onStart,
+		onUpdate,
+		onEnd,
+	};
+};

package/src/shared/providers/screen/gestures/pinch/build-pinch-gesture.ts

@@ -0,0 +1,48 @@
+import { useMemo } from "react";
+import { Gesture } from "react-native-gesture-handler";
+import { useScreenOptionsContext } from "../../options";
+import { useGestureBuilderState } from "../hooks/use-gesture-builder-state";
+import { useStableRuntimeConfig } from "../hooks/use-stable-runtime-config";
+import type { PinchGesture, ScreenGestureConfig } from "../types";
+import { usePinchActivation } from "./pinch-activation";
+import { usePinchBehavior } from "./use-pinch-behavior";
+
+interface BuildPinchGestureHookProps {
+	gestureConfig: ScreenGestureConfig;
+}
+
+export const useBuildPinchGesture = ({
+	gestureConfig,
+}: BuildPinchGestureHookProps): PinchGesture => {
+	const { participation, pinch: policy } = gestureConfig;
+	const screenOptions = useScreenOptionsContext();
+	const { gestureProgressBaseline, lockedSnapPoint } =
+		useGestureBuilderState(participation);
+
+	const runtime = useStableRuntimeConfig({
+		participation,
+		policy,
+		gestureProgressBaseline,
+		lockedSnapPoint,
+	});
+
+	const activation = usePinchActivation({
+		runtime,
+		screenOptions,
+	});
+
+	const behavior = usePinchBehavior(runtime, screenOptions);
+
+	const pinchGesture = useMemo(() => {
+		return Gesture.Pinch()
+			.enabled(true)
+			.manualActivation(true)
+			.onTouchesDown(activation.onTouchesDown)
+			.onTouchesMove(activation.onTouchesMove)
+			.onStart(behavior.onStart)
+			.onUpdate(behavior.onUpdate)
+			.onEnd(behavior.onEnd);
+	}, [activation, behavior]);
+
+	return pinchGesture;
+};

package/src/shared/providers/screen/gestures/pinch/pinch-activation.ts

@@ -0,0 +1,72 @@
+import { useCallback } from "react";
+import type {
+	GestureStateManager,
+	GestureTouchEvent,
+} from "react-native-gesture-handler";
+import type { SharedValue } from "react-native-reanimated";
+import type { ScreenOptionsContextValue } from "../../options";
+import { resolvePinchRuntime } from "../shared/runtime";
+import type { PinchGestureRuntime } from "../types";
+
+interface UsePinchActivationProps {
+	runtime: SharedValue<PinchGestureRuntime>;
+	screenOptions: ScreenOptionsContextValue;
+}
+
+export const usePinchActivation = ({
+	runtime,
+	screenOptions,
+}: UsePinchActivationProps) => {
+	const onTouchesDown = useCallback(
+		(
+			event: GestureTouchEvent,
+			stateManager: GestureStateManager | undefined,
+		) => {
+			"worklet";
+			const { participation, policy } = resolvePinchRuntime(
+				runtime.get(),
+				screenOptions.get(),
+			);
+
+			if (!participation.canTrackGesture || !policy.enabled) {
+				stateManager?.fail();
+				return;
+			}
+
+			if (event.numberOfTouches === 2) {
+				stateManager?.activate();
+				return;
+			}
+
+			if (event.numberOfTouches > 2) {
+				stateManager?.fail();
+			}
+		},
+		[runtime, screenOptions],
+	);
+
+	const onTouchesMove = useCallback(
+		(event: GestureTouchEvent, stateManager: GestureStateManager) => {
+			"worklet";
+			const { participation, policy } = resolvePinchRuntime(
+				runtime.get(),
+				screenOptions.get(),
+			);
+
+			if (!participation.canTrackGesture || !policy.enabled) {
+				stateManager.fail();
+				return;
+			}
+
+			if (event.numberOfTouches === 2) {
+				stateManager.activate();
+				return;
+			}
+
+			stateManager.fail();
+		},
+		[runtime, screenOptions],
+	);
+
+	return { onTouchesDown, onTouchesMove };
+};