react-native-screen-transitions 4.0.0 → 4.1.0-beta.0

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

@@ -1,218 +0,0 @@
-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 {
-	GestureDirections,
-	ResolvedGestureActivationArea,
-	ScrollGestureAxis,
-	ScrollGestureAxisState,
-	ScrollGestureState,
-	ScrollMetadataState,
-	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 "./shared/snap-points";
-
-export type PanGesture = ReturnType<typeof Gesture.Pan>;
-export type PinchGesture = ReturnType<typeof Gesture.Pinch>;
-export type ComposedGesture = ReturnType<typeof Gesture.Simultaneous>;
-
-export type PanGestureEvent =
-	| GestureUpdateEvent<PanGestureHandlerEventPayload>
-	| GestureStateChangeEvent<PanGestureHandlerEventPayload>;
-
-export type PinchGestureEvent =
-	| GestureUpdateEvent<PinchGestureHandlerEventPayload>
-	| GestureStateChangeEvent<PinchGestureHandlerEventPayload>;
-
-/** Gesture that owns navigation release for the current simultaneous composition. */
-export type GestureCompositionOwner = "pan" | "pinch" | null;
-
-export type {
-	ScrollGestureAxis,
-	ScrollGestureAxisState,
-	ScrollGestureState,
-	ScrollMetadataState,
-};
-
-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_DIRECTION_CLAIMS: DirectionClaimMap = {
-	vertical: null,
-	"vertical-inverted": null,
-	horizontal: null,
-	"horizontal-inverted": null,
-};
-
-export interface ScreenGestureSource {
-	routeKey: string;
-	detectorGesture: ComposedGesture;
-	panGesture: PanGesture;
-	pinchGesture: PinchGesture;
-	scrollState: SharedValue<ScrollGestureState | null>;
-	claimedDirections: ClaimedDirections;
-	childDirectionClaims: SharedValue<DirectionClaimMap>;
-}
-
-export interface GestureContextType extends ScreenGestureSource {
-	ancestorGestures: readonly ScreenGestureSource[];
-}
-
-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;
-	gestureSensitivity: NonNullable<ScreenTransitionConfig["gestureSensitivity"]>;
-	gestureVelocityImpact: number;
-	gestureSnapVelocityImpact: number;
-	gestureReleaseVelocityScale: number;
-	gestureActivationArea: ResolvedGestureActivationArea;
-	gestureSnapLocked: boolean;
-	sheetSnapBehavior: NonNullable<ScreenTransitionConfig["sheetSnapBehavior"]>;
-	sheetScrollGestureBehavior: NonNullable<
-		ScreenTransitionConfig["sheetScrollGestureBehavior"]
-	>;
-	transitionSpec: TransitionSpec | undefined;
-}
-
-export interface PinchGesturePolicy {
-	enabled: boolean;
-	gestureDirection: NonNullable<ScreenTransitionConfig["gestureDirection"]>;
-	snapDirections: SnapPinchDirectionConfig;
-	pinchInEnabled: boolean;
-	pinchOutEnabled: boolean;
-	gestureSensitivity: NonNullable<ScreenTransitionConfig["gestureSensitivity"]>;
-	gestureSnapVelocityImpact: number;
-	gestureSnapLocked: boolean;
-	sheetSnapBehavior: NonNullable<ScreenTransitionConfig["sheetSnapBehavior"]>;
-	gestureReleaseVelocityScale: number;
-	transitionSpec: TransitionSpec | undefined;
-}
-
-export interface GestureRuntimeStores {
-	gestures: GestureStoreMap;
-	animations: AnimationStoreMap;
-	system: SystemStoreMap;
-}
-
-export type GesturePolicy = PanGesturePolicy | PinchGesturePolicy;
-
-export interface GestureRuntime<TPolicy extends GesturePolicy> {
-	participation: ScreenGestureParticipation;
-	policy: TPolicy;
-	stores: GestureRuntimeStores;
-}
-
-export type PanGestureRuntime = GestureRuntime<PanGesturePolicy>;
-
-export type PinchGestureRuntime = GestureRuntime<PinchGesturePolicy>;
-
-export interface GestureDimensions {
-	width: number;
-	height: number;
-}
-
-export interface PanTrackState {
-	x: number;
-	y: number;
-	normX: number;
-	normY: number;
-	velocity: number;
-}
-
-export interface PinchTrackState {
-	scale: number;
-	normScale: number;
-}
-
-export interface PanReleaseResult {
-	target: number;
-	shouldDismiss: boolean;
-	initialVelocity: number;
-	commitProgress?: number;
-	transitionSpec: TransitionSpec | undefined;
-	resetSpec: AnimationConfig | undefined;
-}
-
-export interface PanReleasePlan {
-	target: number;
-	shouldDismiss: boolean;
-	progressVelocity: number;
-	resetVelocityX: number;
-	resetVelocityY: number;
-	resetVelocityNormX: number;
-	resetVelocityNormY: number;
-	handoffVelocity: number;
-	commitProgress?: number;
-	transitionSpec: TransitionSpec | undefined;
-	resetSpec: AnimationConfig | undefined;
-}
-
-export interface PinchReleaseResult {
-	target: number;
-	shouldDismiss: boolean;
-	initialVelocity: number;
-	handoffVelocity: number;
-	commitProgress?: number;
-	resetValuesImmediately?: boolean;
-	transitionSpec: TransitionSpec | undefined;
-	resetSpec: AnimationConfig | undefined;
-}
-
-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;
-}

package/src/providers/screen/options/helpers.ts

@@ -1,351 +0,0 @@
-import {
-	DEFAULT_GESTURE_DIRECTION,
-	DEFAULT_GESTURE_RELEASE_VELOCITY_SCALE,
-	DEFAULT_GESTURE_SENSITIVITY,
-	DEFAULT_GESTURE_SNAP_LOCKED,
-	DEFAULT_GESTURE_SNAP_VELOCITY_IMPACT,
-	DEFAULT_GESTURE_TRACKING,
-	DEFAULT_GESTURE_VELOCITY_IMPACT,
-	DEFAULT_SHEET_SCROLL_GESTURE_BEHAVIOR,
-	DEFAULT_SHEET_SNAP_BEHAVIOR,
-} from "../../../constants";
-import type {
-	GestureDirection,
-	GestureDirectionActivationArea,
-	GestureDirectionEntry,
-	ScreenTransitionConfig,
-	TransitionInterpolatedStyle,
-} from "../../../types";
-import type { BackdropBehavior } from "../../../types/screen.types";
-import { resolveSheetScrollGestureBehavior } from "../../../utils/resolve-screen-transition-options";
-import type {
-	RequiredScreenOption,
-	ScreenOptionsContextValue,
-	ScreenOptionsSnapshot,
-	ScreenOptionsState,
-} from "./types";
-
-const resolveBooleanOption = <T extends boolean | undefined>(
-	value: unknown,
-	fallback: T,
-): T => {
-	"worklet";
-	return typeof value === "boolean" ? (value as T) : fallback;
-};
-
-const resolveNumberOption = <T extends number | undefined>(
-	value: unknown,
-	fallback: T,
-): T => {
-	"worklet";
-	return typeof value === "number" && Number.isFinite(value)
-		? (value as T)
-		: fallback;
-};
-
-const isGestureDirection = (value: unknown): value is GestureDirection => {
-	"worklet";
-	return (
-		value === "horizontal" ||
-		value === "horizontal-inverted" ||
-		value === "vertical" ||
-		value === "vertical-inverted" ||
-		value === "bidirectional" ||
-		value === "pinch-in" ||
-		value === "pinch-out"
-	);
-};
-
-const isGestureDirectionActivationArea = (
-	value: unknown,
-): value is GestureDirectionActivationArea => {
-	"worklet";
-	return (
-		value === "edge" ||
-		value === "screen" ||
-		(typeof value === "number" && Number.isFinite(value) && value >= 0)
-	);
-};
-
-const isGestureDirectionEntry = (
-	value: unknown,
-): value is GestureDirectionEntry => {
-	"worklet";
-	if (isGestureDirection(value)) {
-		return true;
-	}
-
-	if (typeof value !== "object" || value === null || Array.isArray(value)) {
-		return false;
-	}
-
-	const config = value as Record<string, unknown>;
-	return (
-		isGestureDirection(config.gesture) &&
-		(config.area === undefined || isGestureDirectionActivationArea(config.area))
-	);
-};
-
-const cloneGestureDirectionEntry = (
-	entry: GestureDirectionEntry,
-): GestureDirectionEntry => {
-	"worklet";
-	if (typeof entry === "string") {
-		return entry;
-	}
-
-	return entry.area === undefined
-		? { gesture: entry.gesture }
-		: { gesture: entry.gesture, area: entry.area };
-};
-
-const resolveGestureDirectionOption = (
-	value: unknown,
-	fallback: RequiredScreenOption<"gestureDirection">,
-): RequiredScreenOption<"gestureDirection"> => {
-	"worklet";
-	if (isGestureDirectionEntry(value)) {
-		return cloneGestureDirectionEntry(value);
-	}
-	if (Array.isArray(value)) {
-		const entries: GestureDirectionEntry[] = [];
-		for (const entry of value) {
-			if (!isGestureDirectionEntry(entry)) {
-				return fallback;
-			}
-			entries.push(cloneGestureDirectionEntry(entry));
-		}
-		return entries;
-	}
-	return fallback;
-};
-
-const resolveSheetScrollGestureBehaviorOption = (
-	value: unknown,
-	fallback: RequiredScreenOption<"sheetScrollGestureBehavior">,
-): RequiredScreenOption<"sheetScrollGestureBehavior"> => {
-	"worklet";
-	return value === "expand-and-collapse" || value === "collapse-only"
-		? value
-		: fallback;
-};
-
-const resolveSheetSnapBehaviorOption = (
-	value: unknown,
-	fallback: RequiredScreenOption<"sheetSnapBehavior">,
-): RequiredScreenOption<"sheetSnapBehavior"> => {
-	"worklet";
-	return value === "continuous" || value === "step" ? value : fallback;
-};
-
-const resolveGestureTrackingOption = (
-	value: unknown,
-	fallback: RequiredScreenOption<"gestureTracking">,
-): RequiredScreenOption<"gestureTracking"> => {
-	"worklet";
-	return value === "auto" || value === "never" || value === "always"
-		? value
-		: fallback;
-};
-
-const resolveBackdropBehaviorOption = (
-	value: unknown,
-	fallback: BackdropBehavior | undefined,
-): BackdropBehavior | undefined => {
-	"worklet";
-	return value === "block" ||
-		value === "passthrough" ||
-		value === "dismiss" ||
-		value === "collapse"
-		? value
-		: fallback;
-};
-
-const areGestureDirectionEntriesEqual = (
-	left: GestureDirectionEntry,
-	right: GestureDirectionEntry,
-) => {
-	"worklet";
-	if (left === right) return true;
-
-	if (typeof left === "string" || typeof right === "string") {
-		return false;
-	}
-
-	return left.gesture === right.gesture && left.area === right.area;
-};
-
-const areGestureDirectionsEqual = (
-	left: RequiredScreenOption<"gestureDirection">,
-	right: RequiredScreenOption<"gestureDirection">,
-) => {
-	"worklet";
-	if (
-		!Array.isArray(left) &&
-		!Array.isArray(right) &&
-		areGestureDirectionEntriesEqual(left, right)
-	) {
-		return true;
-	}
-	if (!Array.isArray(left) || !Array.isArray(right)) return false;
-	if (left.length !== right.length) return false;
-
-	for (let i = 0; i < left.length; i++) {
-		if (!areGestureDirectionEntriesEqual(left[i], right[i])) {
-			return false;
-		}
-	}
-
-	return true;
-};
-
-const areScreenOptionsEqual = (
-	left: ScreenOptionsState,
-	right: ScreenOptionsState,
-) => {
-	"worklet";
-	return (
-		left.navigationMaskEnabled === right.navigationMaskEnabled &&
-		left.gestureEnabled === right.gestureEnabled &&
-		left.gestureTracking === right.gestureTracking &&
-		areGestureDirectionsEqual(left.gestureDirection, right.gestureDirection) &&
-		left.gestureSensitivity === right.gestureSensitivity &&
-		left.gestureVelocityImpact === right.gestureVelocityImpact &&
-		left.gestureSnapVelocityImpact === right.gestureSnapVelocityImpact &&
-		left.gestureReleaseVelocityScale === right.gestureReleaseVelocityScale &&
-		left.gestureSnapLocked === right.gestureSnapLocked &&
-		left.sheetSnapBehavior === right.sheetSnapBehavior &&
-		left.sheetScrollGestureBehavior === right.sheetScrollGestureBehavior &&
-		left.backdropBehavior === right.backdropBehavior &&
-		left.transitionSpec === right.transitionSpec &&
-		left.baseOptions === right.baseOptions
-	);
-};
-
-export const resolveBaseScreenOptions = (
-	options: ScreenTransitionConfig,
-): ScreenOptionsSnapshot => {
-	return {
-		navigationMaskEnabled: resolveBooleanOption(
-			options.navigationMaskEnabled,
-			undefined,
-		),
-		gestureEnabled: resolveBooleanOption(options.gestureEnabled, undefined),
-		gestureTracking: resolveGestureTrackingOption(
-			options.gestureTracking,
-			DEFAULT_GESTURE_TRACKING,
-		),
-		gestureDirection: resolveGestureDirectionOption(
-			options.gestureDirection,
-			DEFAULT_GESTURE_DIRECTION,
-		),
-		gestureSensitivity: resolveNumberOption(
-			options.gestureSensitivity,
-			DEFAULT_GESTURE_SENSITIVITY,
-		),
-		gestureVelocityImpact: resolveNumberOption(
-			options.gestureVelocityImpact,
-			DEFAULT_GESTURE_VELOCITY_IMPACT,
-		),
-		gestureSnapVelocityImpact: resolveNumberOption(
-			options.gestureSnapVelocityImpact,
-			DEFAULT_GESTURE_SNAP_VELOCITY_IMPACT,
-		),
-		gestureReleaseVelocityScale: resolveNumberOption(
-			options.gestureReleaseVelocityScale,
-			DEFAULT_GESTURE_RELEASE_VELOCITY_SCALE,
-		),
-		gestureSnapLocked: resolveBooleanOption(
-			options.gestureSnapLocked,
-			DEFAULT_GESTURE_SNAP_LOCKED,
-		),
-		sheetSnapBehavior: resolveSheetSnapBehaviorOption(
-			options.sheetSnapBehavior,
-			DEFAULT_SHEET_SNAP_BEHAVIOR,
-		),
-		sheetScrollGestureBehavior: resolveSheetScrollGestureBehaviorOption(
-			resolveSheetScrollGestureBehavior(options),
-			DEFAULT_SHEET_SCROLL_GESTURE_BEHAVIOR,
-		),
-		backdropBehavior: resolveBackdropBehaviorOption(
-			options.backdropBehavior,
-			undefined,
-		),
-		transitionSpec: options.transitionSpec,
-	};
-};
-
-export const syncScreenOptionsBase = (
-	screenOptions: ScreenOptionsContextValue,
-	base: ScreenOptionsSnapshot,
-) => {
-	"worklet";
-	const next = {
-		...base,
-		baseOptions: base,
-	};
-
-	if (!areScreenOptionsEqual(screenOptions.get(), next)) {
-		screenOptions.set(next);
-	}
-};
-
-export const syncScreenOptionsOverrides = (
-	raw: TransitionInterpolatedStyle | undefined,
-	screenOptions: ScreenOptionsContextValue,
-) => {
-	"worklet";
-	const options = raw?.options;
-	const base = screenOptions.get().baseOptions;
-
-	const next: ScreenOptionsState = {
-		navigationMaskEnabled: base.navigationMaskEnabled,
-		gestureEnabled: resolveBooleanOption(
-			options?.gestureEnabled,
-			base.gestureEnabled,
-		),
-		gestureTracking: base.gestureTracking,
-		gestureDirection: resolveGestureDirectionOption(
-			options?.gestureDirection,
-			base.gestureDirection,
-		),
-		gestureSensitivity: resolveNumberOption(
-			options?.gestureSensitivity,
-			base.gestureSensitivity,
-		),
-		gestureVelocityImpact: resolveNumberOption(
-			options?.gestureVelocityImpact,
-			base.gestureVelocityImpact,
-		),
-		gestureSnapVelocityImpact: resolveNumberOption(
-			options?.gestureSnapVelocityImpact,
-			base.gestureSnapVelocityImpact,
-		),
-		gestureReleaseVelocityScale: resolveNumberOption(
-			options?.gestureReleaseVelocityScale,
-			base.gestureReleaseVelocityScale,
-		),
-		gestureSnapLocked: resolveBooleanOption(
-			options?.gestureSnapLocked,
-			base.gestureSnapLocked,
-		),
-		sheetSnapBehavior: resolveSheetSnapBehaviorOption(
-			options?.sheetSnapBehavior,
-			base.sheetSnapBehavior,
-		),
-		sheetScrollGestureBehavior: resolveSheetScrollGestureBehaviorOption(
-			options?.sheetScrollGestureBehavior,
-			base.sheetScrollGestureBehavior,
-		),
-		backdropBehavior: resolveBackdropBehaviorOption(
-			options?.backdropBehavior,
-			base.backdropBehavior,
-		),
-		transitionSpec: base.transitionSpec,
-		baseOptions: base,
-	};
-
-	if (!areScreenOptionsEqual(screenOptions.get(), next)) {
-		screenOptions.set(next);
-	}
-};

package/src/providers/screen/options/index.ts

@@ -1,6 +0,0 @@
-export { syncScreenOptionsOverrides } from "./helpers";
-export {
-	ScreenOptionsProvider,
-	useScreenOptionsStore,
-} from "./options.provider";
-export type { ScreenOptionsContextValue, ScreenOptionsSnapshot } from "./types";

package/src/providers/screen/options/options.provider.tsx

@@ -1,39 +0,0 @@
-import { useLayoutEffect, useMemo } from "react";
-import { useSharedValue } from "react-native-reanimated";
-import createProvider from "../../../utils/create-provider";
-import { useDescriptorsStore } from "../descriptors";
-import { resolveBaseScreenOptions, syncScreenOptionsBase } from "./helpers";
-import type {
-	ScreenOptionsContextValue,
-	ScreenOptionsProviderProps,
-	ScreenOptionsState,
-} from "./types";
-
-export const { ScreenOptionsProvider, useScreenOptionsStore } = createProvider(
-	"ScreenOptions",
-)<ScreenOptionsProviderProps, ScreenOptionsContextValue>(() => {
-	const options = useDescriptorsStore((store) => store.options);
-
-	const baseScreenOptions = useMemo(
-		() => resolveBaseScreenOptions(options),
-		[options],
-	);
-
-	const initialScreenOptions = useMemo<ScreenOptionsState>(
-		() => ({
-			...baseScreenOptions,
-			baseOptions: baseScreenOptions,
-		}),
-		[baseScreenOptions],
-	);
-
-	const value = useSharedValue(initialScreenOptions);
-
-	useLayoutEffect(() => {
-		syncScreenOptionsBase(value, baseScreenOptions);
-	}, [value, baseScreenOptions]);
-
-	return {
-		value,
-	};
-});

package/src/providers/screen/options/types.ts

@@ -1,35 +0,0 @@
-import type { ReactNode } from "react";
-import type { SharedValue } from "react-native-reanimated";
-import type { ScreenTransitionConfig } from "../../../types";
-
-export type RuntimeOption<T> = SharedValue<T>;
-export type RequiredScreenOption<K extends keyof ScreenTransitionConfig> =
-	NonNullable<ScreenTransitionConfig[K]>;
-export type OptionalScreenOption<K extends keyof ScreenTransitionConfig> =
-	ScreenTransitionConfig[K];
-
-export type ScreenOptionsSnapshot = {
-	navigationMaskEnabled: OptionalScreenOption<"navigationMaskEnabled">;
-	gestureEnabled: OptionalScreenOption<"gestureEnabled">;
-	gestureTracking: RequiredScreenOption<"gestureTracking">;
-	gestureDirection: RequiredScreenOption<"gestureDirection">;
-	gestureSensitivity: RequiredScreenOption<"gestureSensitivity">;
-	gestureVelocityImpact: RequiredScreenOption<"gestureVelocityImpact">;
-	gestureSnapVelocityImpact: RequiredScreenOption<"gestureSnapVelocityImpact">;
-	gestureReleaseVelocityScale: RequiredScreenOption<"gestureReleaseVelocityScale">;
-	gestureSnapLocked: RequiredScreenOption<"gestureSnapLocked">;
-	sheetSnapBehavior: RequiredScreenOption<"sheetSnapBehavior">;
-	sheetScrollGestureBehavior: RequiredScreenOption<"sheetScrollGestureBehavior">;
-	backdropBehavior: OptionalScreenOption<"backdropBehavior">;
-	transitionSpec: OptionalScreenOption<"transitionSpec">;
-};
-
-export type ScreenOptionsState = ScreenOptionsSnapshot & {
-	baseOptions: ScreenOptionsSnapshot;
-};
-
-export type ScreenOptionsContextValue = RuntimeOption<ScreenOptionsState>;
-
-export interface ScreenOptionsProviderProps {
-	children: ReactNode;
-}