@react-navigation/core 7.0.5 → 7.1.0

package/src/types.tsx

@@ -248,19 +248,30 @@ type NavigationHelpersCommon<
   ): void;
 
   /**
-   * Navigate to a route in current navigation tree.
+   * Navigate to a screen in the current or parent navigator.
+   * If we're already on the screen, update the params instead.
    *
    * @param name Name of the route to navigate to.
    * @param [params] Params object for the route.
+   * @param [merge] Whether to merge the params onto the route.
    */
   navigate<RouteName extends keyof ParamList>(
-    ...args: ScreenParamsPair<ParamList, RouteName>
+    ...args: {
+      [Screen in keyof ParamList]: undefined extends ParamList[Screen]
+        ?
+            | [screen: Screen]
+            | [screen: Screen, params: ParamList[Screen]]
+            | [screen: Screen, params: ParamList[Screen], merge: boolean]
+        :
+            | [screen: Screen, params: ParamList[Screen]]
+            | [screen: Screen, params: ParamList[Screen], merge: boolean];
+    }[RouteName]
   ): void;
 
   /**
    * Navigate to a route in current navigation tree.
    *
-   * @param route Object with `name` for the route to navigate to, and a `params` object.
+   * @param options Object with `name` for the route to navigate to, and a `params` object.
    */
   navigate<RouteName extends keyof ParamList>(
     options: {
@@ -278,7 +289,7 @@ type NavigationHelpersCommon<
    *
    * @deprecated Use `navigate` instead.
    *
-   * @param name Route name of the route.
+   * @param name Name of the route to navigate to.
    * @param [params] Params object for the route.
    */
   navigateDeprecated<RouteName extends keyof ParamList>(
@@ -290,7 +301,7 @@ type NavigationHelpersCommon<
    *
    * @deprecated Use `navigate` instead.
    *
-   * @param route Object with `name` for the route to navigate to, and a `params` object.
+   * @param options Object with `name` for the route to navigate to, and a `params` object.
    */
   navigateDeprecated<RouteName extends keyof ParamList>(
     options: {

package/src/useNavigationBuilder.tsx

@@ -612,10 +612,6 @@ export function useNavigationBuilder<
   });
 
   const getState = useLatestCallback((): State => {
-    if (stateRef.current != null) {
-      return stateRef.current;
-    }
-
     const currentState = getCurrentState();
 
     return deepFreeze(
@@ -721,6 +717,7 @@ export function useNavigationBuilder<
     getState,
     emitter,
     router,
+    stateRef,
   });
 
   useFocusedListenersChildrenAdapter({

package/src/useNavigationCache.tsx

@@ -217,7 +217,7 @@ export function useNavigationCache<
           }));
         },
         isFocused: () => {
-          const state = getState();
+          const state = base.getState();
 
           if (state.routes[state.index].key !== route.key) {
             return false;

package/src/useNavigationHelpers.tsx

@@ -21,6 +21,7 @@ type Options<State extends NavigationState, Action extends NavigationAction> = {
   getState: () => State;
   emitter: NavigationEventEmitter<any>;
   router: Router<State, Action>;
+  stateRef: React.RefObject<State | null>;
 };
 
 /**
@@ -38,6 +39,7 @@ export function useNavigationHelpers<
   getState,
   emitter,
   router,
+  stateRef,
 }: Options<State, Action>) {
   const onUnhandledAction = React.useContext(UnhandledActionContext);
   const parentNavigationHelpers = React.useContext(NavigationContext);
@@ -99,17 +101,29 @@ export function useNavigationHelpers<
 
         return parentNavigationHelpers;
       },
-      getState,
+      getState: (): State => {
+        // FIXME: Workaround for when the state is read during render
+        // By this time, we haven't committed the new state yet
+        // Without this `useSyncExternalStore` will keep reading the old state
+        // This may result in `useNavigationState` or `useIsFocused` returning wrong values
+        // Apart from `useSyncExternalStore`, `getState` should never be called during render
+        if (stateRef.current != null) {
+          return stateRef.current;
+        }
+
+        return getState();
+      },
     } as NavigationHelpers<ParamListBase, EventMap> & ActionHelpers;
 
     return navigationHelpers;
   }, [
-    navigatorId,
+    router,
+    parentNavigationHelpers,
     emitter.emit,
     getState,
     onAction,
     onUnhandledAction,
-    parentNavigationHelpers,
-    router,
+    navigatorId,
+    stateRef,
   ]);
 }