@react-navigation/native 7.0.0-alpha.8 → 7.0.0-rc.0

package/lib/typescript/src/useLinking.d.ts

@@ -1,37 +1,14 @@
-import { type NavigationContainerRef, type ParamListBase } from '@react-navigation/core';
+import { getStateFromPath as getStateFromPathDefault, type NavigationContainerRef, type ParamListBase } from '@react-navigation/core';
 import * as React from 'react';
 import type { LinkingOptions } from './types';
+type ResultState = ReturnType<typeof getStateFromPathDefault>;
 /**
  * Run async function in series as it's called.
  */
 export declare const series: (cb: () => Promise<void>) => () => void;
 type Options = LinkingOptions<ParamListBase>;
 export declare function useLinking(ref: React.RefObject<NavigationContainerRef<ParamListBase>>, { enabled, config, getStateFromPath, getPathFromState, getActionFromState, }: Options, onUnhandledLinking: (lastUnhandledLining: string | undefined) => void): {
-    getInitialState: () => PromiseLike<(Partial<Omit<Readonly<{
-        key: string;
-        index: number;
-        routeNames: string[];
-        history?: unknown[] | undefined;
-        routes: import("@react-navigation/core").NavigationRoute<ParamListBase, string>[];
-        type: string;
-        stale: false;
-    }>, "stale" | "routes">> & Readonly<{
-        stale?: true | undefined;
-        routes: import("@react-navigation/core").PartialRoute<import("@react-navigation/core").Route<string, object | undefined>>[];
-    }> & {
-        state?: (Partial<Omit<Readonly<{
-            key: string;
-            index: number;
-            routeNames: string[];
-            history?: unknown[] | undefined;
-            routes: import("@react-navigation/core").NavigationRoute<ParamListBase, string>[];
-            type: string;
-            stale: false;
-        }>, "stale" | "routes">> & Readonly<{
-            stale?: true | undefined;
-            routes: import("@react-navigation/core").PartialRoute<import("@react-navigation/core").Route<string, object | undefined>>[];
-        }> & any) | undefined;
-    }) | undefined>;
+    getInitialState: () => PromiseLike<ResultState | undefined>;
 };
 export {};
 //# sourceMappingURL=useLinking.d.ts.map

package/lib/typescript/src/useLinking.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useLinking.d.ts","sourceRoot":"","sources":["../../../src/useLinking.tsx"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,sBAAsB,EAE3B,KAAK,aAAa,EAEnB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AA4C9C;;GAEG;AACH,eAAO,MAAM,MAAM,OAAQ,MAAM,QAAQ,IAAI,CAAC,eAO7C,CAAC;AAIF,KAAK,OAAO,GAAG,cAAc,CAAC,aAAa,CAAC,CAAC;AAE7C,wBAAgB,UAAU,CACxB,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC,EAC3D,EACE,OAAc,EACd,MAAM,EACN,gBAA0C,EAC1C,gBAA0C,EAC1C,kBAA8C,GAC/C,EAAE,OAAO,EACV,kBAAkB,EAAE,CAAC,mBAAmB,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;EA2UtE"}
+{"version":3,"file":"useLinking.d.ts","sourceRoot":"","sources":["../../../src/useLinking.tsx"],"names":[],"mappings":"AAAA,OAAO,EAIL,gBAAgB,IAAI,uBAAuB,EAC3C,KAAK,sBAAsB,EAE3B,KAAK,aAAa,EAEnB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,KAAK,WAAW,GAAG,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC;AA0C9D;;GAEG;AACH,eAAO,MAAM,MAAM,OAAQ,MAAM,OAAO,CAAC,IAAI,CAAC,eAO7C,CAAC;AAIF,KAAK,OAAO,GAAG,cAAc,CAAC,aAAa,CAAC,CAAC;AAE7C,wBAAgB,UAAU,CACxB,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC,EAC3D,EACE,OAAc,EACd,MAAM,EACN,gBAA0C,EAC1C,gBAA0C,EAC1C,kBAA8C,GAC/C,EAAE,OAAO,EACV,kBAAkB,EAAE,CAAC,mBAAmB,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI;2BAmGhD,WAAW,CAAC,WAAW,GAAG,SAAS,CAAC;EAkQ1D"}

package/lib/typescript/src/useLinking.native.d.ts

@@ -7,26 +7,26 @@ export declare function useLinking(ref: React.RefObject<NavigationContainerRef<P
         key: string;
         index: number;
         routeNames: string[];
-        history?: unknown[] | undefined;
+        history?: unknown[];
         routes: import("@react-navigation/core").NavigationRoute<ParamListBase, string>[];
         type: string;
         stale: false;
     }>, "stale" | "routes">> & Readonly<{
-        stale?: true | undefined;
+        stale?: true;
         routes: import("@react-navigation/core").PartialRoute<import("@react-navigation/core").Route<string, object | undefined>>[];
     }> & {
-        state?: (Partial<Omit<Readonly<{
+        state?: Partial<Omit<Readonly<{
             key: string;
             index: number;
             routeNames: string[];
-            history?: unknown[] | undefined;
+            history?: unknown[];
             routes: import("@react-navigation/core").NavigationRoute<ParamListBase, string>[];
             type: string;
             stale: false;
         }>, "stale" | "routes">> & Readonly<{
-            stale?: true | undefined;
+            stale?: true;
             routes: import("@react-navigation/core").PartialRoute<import("@react-navigation/core").Route<string, object | undefined>>[];
-        }> & any) | undefined;
+        }> & any;
     }) | undefined>;
 };
 export {};

package/lib/typescript/src/useScrollToTop.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useScrollToTop.d.ts","sourceRoot":"","sources":["../../../src/useScrollToTop.tsx"],"names":[],"mappings":"AAMA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,KAAK,aAAa,GAAG;IAAE,CAAC,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAEpE,KAAK,cAAc,GACf;IAAE,WAAW,IAAI,IAAI,CAAA;CAAE,GACvB;IAAE,QAAQ,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAA;CAAE,GAC1C;IAAE,cAAc,CAAC,OAAO,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAA;CAAE,GAC1E;IAAE,uBAAuB,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAA;CAAE,CAAC;AAE9D,KAAK,iBAAiB,GAClB;IAAE,kBAAkB,IAAI,KAAK,CAAC,SAAS,GAAG,UAAU,CAAA;CAAE,GACtD;IAAE,OAAO,IAAI,cAAc,CAAA;CAAE,GAC7B,cAAc,CAAC;AA8BnB,wBAAgB,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,QA+DrE"}
+{"version":3,"file":"useScrollToTop.d.ts","sourceRoot":"","sources":["../../../src/useScrollToTop.tsx"],"names":[],"mappings":"AAOA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,KAAK,aAAa,GAAG;IAAE,CAAC,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAEpE,KAAK,cAAc,GACf;IAAE,WAAW,IAAI,IAAI,CAAA;CAAE,GACvB;IAAE,QAAQ,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAA;CAAE,GAC1C;IAAE,cAAc,CAAC,OAAO,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAA;CAAE,GAC1E;IAAE,uBAAuB,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAA;CAAE,CAAC;AAE9D,KAAK,iBAAiB,GAClB;IAAE,kBAAkB,IAAI,KAAK,CAAC,SAAS,GAAG,UAAU,CAAA;CAAE,GACtD;IAAE,OAAO,IAAI,cAAc,CAAA;CAAE,GAC7B,cAAc,CAAC;AA8BnB,wBAAgB,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,QAoErE"}

package/lib/typescript/src/useUnhandledLinking.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useUnhandledLinking.d.ts","sourceRoot":"","sources":["../../../src/useUnhandledLinking.tsx"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,eAAe,EACpB,KAAK,YAAY,EAClB,MAAM,wBAAwB,CAAC;AA2BhC,wBAAgB,4BAA4B;;gDAU1B,eAAe,KAC5B,aAAa,eAAe,CAAC,GAAG,SAAS;;EA+C7C"}
+{"version":3,"file":"useUnhandledLinking.d.ts","sourceRoot":"","sources":["../../../src/useUnhandledLinking.tsx"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,eAAe,EACpB,KAAK,YAAY,EAClB,MAAM,wBAAwB,CAAC;AA2BhC,wBAAgB,4BAA4B;;gDAU1B,eAAe,KAC5B,YAAY,CAAC,eAAe,CAAC,GAAG,SAAS;;EA+C7C"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@react-navigation/native",
   "description": "React Native integration for React Navigation",
-  "version": "7.0.0-alpha.8",
+  "version": "7.0.0-rc.0",
   "keywords": [
     "react-native",
     "react-navigation",
@@ -37,7 +37,7 @@
     "clean": "del lib"
   },
   "dependencies": {
-    "@react-navigation/core": "^7.0.0-alpha.8",
+    "@react-navigation/core": "^7.0.0-rc.0",
     "escape-string-regexp": "^4.0.0",
     "fast-deep-equal": "^3.1.3",
     "nanoid": "3.3.7",
@@ -45,18 +45,18 @@
   },
   "devDependencies": {
     "@testing-library/react-native": "^12.4.3",
-    "@types/react": "~18.2.45",
-    "@types/react-dom": "~18.0.11",
+    "@types/react": "~18.2.79",
+    "@types/react-dom": "~18.2.25",
     "del-cli": "^5.1.0",
     "react": "18.2.0",
     "react-dom": "18.2.0",
-    "react-native": "0.73.2",
+    "react-native": "0.74.2",
     "react-native-builder-bob": "^0.23.2",
-    "typescript": "^5.3.3"
+    "typescript": "^5.5.2"
   },
   "peerDependencies": {
-    "react": "*",
-    "react-native": "0.73.2"
+    "react": ">= 18.2.0",
+    "react-native": ">= 0.72.0"
   },
   "react-native-builder-bob": {
     "source": "src",
@@ -72,5 +72,5 @@
       ]
     ]
   },
-  "gitHead": "e4e445810a3a958c35cc34486b5499baa595500e"
+  "gitHead": "2a1d67089eea2a3d87e38a870ccee35a79c55d7d"
 }

package/src/NavigationContainer.tsx

@@ -35,7 +35,7 @@ declare global {
   >;
 }
 
-global.REACT_NAVIGATION_DEVTOOLS = new WeakMap();
+globalThis.REACT_NAVIGATION_DEVTOOLS = new WeakMap();
 
 type Props<ParamList extends {}> = NavigationContainerProps & {
   direction?: LocaleDirection;

package/src/__stubs__/createStackNavigator.tsx

@@ -1,11 +1,25 @@
 import {
   createNavigatorFactory,
+  type DefaultNavigatorOptions,
+  type NavigationListBase,
+  type ParamListBase,
+  type StackNavigationState,
   StackRouter,
+  type TypedNavigator,
   useNavigationBuilder,
 } from '@react-navigation/core';
 import * as React from 'react';
 
-export const createStackNavigator = createNavigatorFactory((props) => {
+const StackNavigator = (
+  props: DefaultNavigatorOptions<
+    ParamListBase,
+    string | undefined,
+    StackNavigationState<ParamListBase>,
+    {},
+    {},
+    unknown
+  >
+) => {
   const { state, descriptors, NavigationContent } = useNavigationBuilder(
     StackRouter,
     props
@@ -16,4 +30,18 @@ export const createStackNavigator = createNavigatorFactory((props) => {
       {descriptors[state.routes[state.index].key].render()}
     </NavigationContent>
   );
-});
+};
+
+export function createStackNavigator<
+  ParamList extends ParamListBase,
+>(): TypedNavigator<{
+  ParamList: ParamList;
+  NavigatorID: string | undefined;
+  State: StackNavigationState<ParamList>;
+  ScreenOptions: {};
+  EventMap: {};
+  NavigationList: NavigationListBase<ParamList>;
+  Navigator: typeof StackNavigator;
+}> {
+  return createNavigatorFactory(StackNavigator)();
+}

package/src/createMemoryHistory.tsx

@@ -87,6 +87,7 @@ export function createMemoryHistory() {
       // Need to keep the hash part of the path if there was no previous history entry
       // or the previous history entry had the same path
       let pathWithHash = path;
+      const hash = pathWithHash.includes('#') ? '' : location.hash;
 
       if (!items.length || items.findIndex((item) => item.id === id) < 0) {
         // There are two scenarios for creating an array with only one history record:
@@ -95,12 +96,13 @@ export function createMemoryHistory() {
         //   the page when navigating forward in history.
         // - This is the first time any state modifications are done
         //   So we need to push the entry as there's nothing to replace
-        pathWithHash = pathWithHash + location.hash;
+
+        pathWithHash = pathWithHash + hash;
         items = [{ path: pathWithHash, state, id }];
         index = 0;
       } else {
         if (items[index].path === path) {
-          pathWithHash = pathWithHash + location.hash;
+          pathWithHash = pathWithHash + hash;
         }
         items[index] = { path, state, id };
       }

package/src/createStaticNavigation.tsx

@@ -1,6 +1,7 @@
 import {
   createComponentForStaticNavigation,
   createPathConfigForStaticNavigation,
+  type NavigationContainerRef,
   type ParamListBase,
   type StaticNavigation,
 } from '@react-navigation/core';
@@ -16,7 +17,24 @@ type Props = Omit<
   /**
    * Options for deep linking.
    */
-  linking?: Omit<LinkingOptions<ParamListBase>, 'config'>;
+  linking?: Omit<LinkingOptions<ParamListBase>, 'config' | 'enabled'> & {
+    /**
+     * Whether deep link handling should be enabled.
+     * Defaults to `true` if any `linking` options are specified, `false` otherwise.
+     *
+     * When 'auto' is specified, all leaf screens will get a autogenerated path.
+     * The generated path will be a kebab-case version of the screen name.
+     * This can be overridden for specific screens by specifying `linking` for the screen.
+     */
+    enabled?: 'auto' | true | false;
+    /**
+     * Additional configuration
+     */
+    config?: Omit<
+      NonNullable<LinkingOptions<ParamListBase>['config']>,
+      'screens'
+    >;
+  };
 };
 
 /**
@@ -28,17 +46,49 @@ type Props = Omit<
  */
 export function createStaticNavigation(tree: StaticNavigation<any, any, any>) {
   const Component = createComponentForStaticNavigation(tree, 'RootNavigator');
-  const linkingConfig = {
-    screens: tree.config.screens
-      ? createPathConfigForStaticNavigation(tree)
-      : {},
-  };
 
-  function Navigation({ linking, ...rest }: Props) {
+  function Navigation(
+    { linking, ...rest }: Props,
+    ref: React.Ref<NavigationContainerRef<ParamListBase>>
+  ) {
+    const screens = React.useMemo(() => {
+      if (tree.config.screens) {
+        return createPathConfigForStaticNavigation(
+          tree,
+          { initialRouteName: linking?.config?.initialRouteName },
+          linking?.enabled === 'auto'
+        );
+      }
+
+      return undefined;
+    }, [linking?.config, linking?.enabled]);
+
+    if (linking?.enabled === true && screens == null) {
+      throw new Error(
+        'Linking is enabled but no linking configuration was found for the screens.\n\n' +
+          'To solve this:\n' +
+          "- Specify a 'linking' property for the screens you want to link to.\n" +
+          "- Or set 'linking.enabled' to 'auto' to generate paths automatically.\n\n" +
+          'See usage guide: https://reactnavigation.org/docs/7.x/static-configuration#linking'
+      );
+    }
+
     return (
       <NavigationContainer
         {...rest}
-        linking={linking ? { ...linking, config: linkingConfig } : undefined}
+        ref={ref}
+        linking={
+          linking
+            ? {
+                ...linking,
+                enabled:
+                  typeof linking.enabled === 'boolean'
+                    ? linking.enabled
+                    : screens != null,
+                config: screens ? { ...linking.config, screens } : undefined,
+              }
+            : undefined
+        }
       >
         <Component />
       </NavigationContainer>

package/src/types.tsx

@@ -9,28 +9,10 @@ import type {
 declare global {
   // eslint-disable-next-line @typescript-eslint/no-namespace
   namespace ReactNavigation {
-    interface Theme {
-      dark: boolean;
-      colors: {
-        primary: string;
-        background: string;
-        card: string;
-        text: string;
-        border: string;
-        notification: string;
-      };
-      fonts: {
-        regular: FontStyle;
-        medium: FontStyle;
-        bold: FontStyle;
-        heavy: FontStyle;
-      };
-    }
+    interface Theme extends NativeTheme {}
   }
 }
 
-export type LocaleDirection = 'ltr' | 'rtl';
-
 type FontStyle = {
   fontFamily: string;
   fontWeight:
@@ -47,7 +29,27 @@ type FontStyle = {
     | '900';
 };
 
-export type Theme = ReactNavigation.Theme;
+interface NativeTheme {
+  dark: boolean;
+  colors: {
+    primary: string;
+    background: string;
+    card: string;
+    text: string;
+    border: string;
+    notification: string;
+  };
+  fonts: {
+    regular: FontStyle;
+    medium: FontStyle;
+    bold: FontStyle;
+    heavy: FontStyle;
+  };
+}
+
+export type Theme = NativeTheme;
+
+export type LocaleDirection = 'ltr' | 'rtl';
 
 export type LinkingOptions<ParamList extends {}> = {
   /**

package/src/useLinking.tsx

@@ -280,6 +280,8 @@ export function useLinking(
       route: ReturnType<typeof findFocusedRoute>,
       state: NavigationState
     ): string => {
+      let path;
+
       // If the `route` object contains a `path`, use that path as long as `route.name` and `params` still match
       // This makes sure that we preserve the original URL for wildcard routes
       if (route?.path) {
@@ -296,12 +298,31 @@ export function useLinking(
             focusedRoute.name === route.name &&
             isEqual(focusedRoute.params, route.params)
           ) {
-            return route.path;
+            path = route.path;
           }
         }
       }
 
-      return getPathFromStateRef.current(state, configRef.current);
+      if (path == null) {
+        path = getPathFromStateRef.current(state, configRef.current);
+      }
+
+      const previousRoute = previousStateRef.current
+        ? findFocusedRoute(previousStateRef.current)
+        : undefined;
+
+      // Preserve the hash if the route didn't change
+      if (
+        previousRoute &&
+        route &&
+        'key' in previousRoute &&
+        'key' in route &&
+        previousRoute.key === route.key
+      ) {
+        path = path + location.hash;
+      }
+
+      return path;
     };
 
     if (ref.current) {
@@ -378,7 +399,12 @@ export function useLinking(
           const currentIndex = history.index;
 
           try {
-            if (nextIndex !== -1 && nextIndex < currentIndex) {
+            if (
+              nextIndex !== -1 &&
+              nextIndex < currentIndex &&
+              // We should only go back if the entry exists and it's less than current index
+              history.get(nextIndex - currentIndex)
+            ) {
               // An existing entry for this path exists and it's less than current index, go back to that
               await history.go(nextIndex - currentIndex);
             } else {

package/src/useScrollToTop.tsx

@@ -1,7 +1,8 @@
 import {
   type EventArg,
+  NavigationContext,
   type NavigationProp,
-  useNavigation,
+  type ParamListBase,
   useRoute,
 } from '@react-navigation/core';
 import * as React from 'react';
@@ -38,7 +39,7 @@ function getScrollableNode(ref: React.RefObject<ScrollableWrapper>) {
     // We need to use `getScrollResponder` to get access to the scroll responder
     return ref.current.getScrollResponder();
   } else if ('getNode' in ref.current) {
-    // When a `ScrollView` is wraped in `Animated.createAnimatedComponent`
+    // When a `ScrollView` is wrapped in `Animated.createAnimatedComponent`
     // we need to use `getNode` to get the ref to the actual scrollview.
     // Note that `getNode` is deprecated in newer versions of react-native
     // this is why we check if we already have a scrollable node above.
@@ -49,13 +50,18 @@ function getScrollableNode(ref: React.RefObject<ScrollableWrapper>) {
 }
 
 export function useScrollToTop(ref: React.RefObject<ScrollableWrapper>) {
-  const navigation = useNavigation();
+  const navigation = React.useContext(NavigationContext);
   const route = useRoute();
 
+  if (navigation === undefined) {
+    throw new Error(
+      "Couldn't find a navigation object. Is your component inside NavigationContainer?"
+    );
+  }
+
   React.useEffect(() => {
-    const tabNavigations: NavigationProp<ReactNavigation.RootParamList>[] = [];
+    const tabNavigations: NavigationProp<ParamListBase>[] = [];
     let currentNavigation = navigation;
-
     // If the screen is nested inside multiple tab navigators, we should scroll to top for any of them
     // So we need to find all the parent tab navigators and add the listeners there
     while (currentNavigation) {