@react-navigation/core 7.3.1 → 7.5.0

package/src/types.tsx

@@ -6,6 +6,7 @@ import type {
   ParamListBase,
   PartialState,
   Route,
+  Router,
 } from '@react-navigation/routers';
 import type * as React from 'react';
 
@@ -108,11 +109,15 @@ export type DefaultNavigatorOptions<
   }) => React.ReactElement;
 
   /**
-   A function returning a state, which may be set after modifying the routes name.
+   * A function returning overrides for the underlying router used by the navigator.
+   * The overrides will be shallow merged into the original router.
+   * It receives the original router as an argument to the function.
+   *
+   * This must be a pure function and cannot reference outside dynamic variables.
    */
-  UNSTABLE_getStateForRouteNamesChange?: (
-    state: NavigationState
-  ) => PartialState<NavigationState> | undefined;
+  UNSTABLE_router?: <Action extends NavigationAction>(
+    original: Router<State, Action>
+  ) => Partial<Router<State, Action>>;
 } & (NavigatorID extends string
     ? {
         /**
@@ -271,7 +276,11 @@ type NavigationHelpersCommon<
   /**
    * Navigate to a route in current navigation tree.
    *
-   * @param options Object with `name` for the route to navigate to, and a `params` object.
+   * @param options.name Name of the route to navigate to.
+   * @param [options.params] Params object for the route.
+   * @param [options.path] Path to associate the route with (e.g. for deep links).
+   * @param [options.merge] Whether to merge the params onto the route.
+   * @param [options.pop] Whether to pop routes in a stack to go back to the matching route.
    */
   navigate<RouteName extends keyof ParamList>(
     options: {
@@ -280,6 +289,7 @@ type NavigationHelpersCommon<
         params: ParamList[Screen];
         path?: string;
         merge?: boolean;
+        pop?: boolean;
       };
     }[RouteName]
   ): void;
@@ -950,6 +960,7 @@ export type NavigatorScreenParams<ParamList extends {}> =
       screen?: never;
       params?: never;
       initial?: never;
+      pop?: never;
       path?: string;
       state: PartialState<NavigationState> | NavigationState | undefined;
     }
@@ -960,6 +971,7 @@ export type NavigatorScreenParams<ParamList extends {}> =
             params?: ParamList[RouteName];
             initial?: boolean;
             path?: string;
+            pop?: boolean;
             state?: never;
           }
         : {
@@ -967,6 +979,7 @@ export type NavigatorScreenParams<ParamList extends {}> =
             params: ParamList[RouteName];
             initial?: boolean;
             path?: string;
+            pop?: boolean;
             state?: never;
           };
     }[keyof ParamList];

package/src/useNavigationBuilder.tsx

@@ -254,7 +254,7 @@ export function useNavigationBuilder<
   ScreenOptions extends {},
   EventMap extends Record<string, any>,
 >(
-  createRouter: RouterFactory<State, any, RouterOptions>,
+  createRouter: RouterFactory<State, NavigationAction, RouterOptions>,
   options: DefaultNavigatorOptions<
     ParamListBase,
     string | undefined,
@@ -277,6 +277,7 @@ export function useNavigationBuilder<
     screenOptions,
     screenLayout,
     screenListeners,
+    UNSTABLE_router,
     ...rest
   } = options;
 
@@ -298,7 +299,18 @@ export function useNavigationBuilder<
       );
     }
 
-    return createRouter(rest as unknown as RouterOptions);
+    const original = createRouter(rest as unknown as RouterOptions);
+
+    if (UNSTABLE_router != null) {
+      const overrides = UNSTABLE_router(original);
+
+      return {
+        ...original,
+        ...overrides,
+      };
+    }
+
+    return original;
   });
 
   const screens = routeConfigs.reduce<
@@ -488,26 +500,17 @@ export function useNavigationBuilder<
     !isArrayEqual(state.routeNames, routeNames) ||
     !isRecordEqual(routeKeyList, previousRouteKeyList)
   ) {
-    const navigatorStateForNextRouteNamesChange =
-      options.UNSTABLE_getStateForRouteNamesChange?.(state);
     // When the list of route names change, the router should handle it to remove invalid routes
-    nextState = navigatorStateForNextRouteNamesChange
-      ? // @ts-expect-error this is ok
-        router.getRehydratedState(navigatorStateForNextRouteNamesChange, {
-          routeNames,
-          routeParamList,
-          routeGetIdList,
-        })
-      : router.getStateForRouteNamesChange(state, {
-          routeNames,
-          routeParamList,
-          routeGetIdList,
-          routeKeyChanges: Object.keys(routeKeyList).filter(
-            (name) =>
-              name in previousRouteKeyList &&
-              routeKeyList[name] !== previousRouteKeyList[name]
-          ),
-        });
+    nextState = router.getStateForRouteNamesChange(state, {
+      routeNames,
+      routeParamList,
+      routeGetIdList,
+      routeKeyChanges: Object.keys(routeKeyList).filter(
+        (name) =>
+          name in previousRouteKeyList &&
+          routeKeyList[name] !== previousRouteKeyList[name]
+      ),
+    });
   }
 
   const previousNestedParamsRef = React.useRef(route?.params);
@@ -538,6 +541,7 @@ export function useNavigationBuilder<
         name: route.params.screen,
         params: route.params.params,
         path: route.params.path,
+        pop: route.params.pop,
       });
     }