@react-navigation/core 7.5.0 → 7.6.1

package/src/types.tsx

@@ -23,21 +23,6 @@ declare global {
 
 type Keyof<T extends {}> = Extract<keyof T, string>;
 
-type ScreenParamsPair<
-  ParamList extends ParamListBase,
-  RouteName extends keyof ParamList,
-> = {
-  // First we use a mapped type to get an union of screen & params pairs
-  // Then we pick the pair which matches the RouteName
-  // Mapped type is used instead of just ParamList[RouteName]
-  // Otherwise it'll result in union of all params leading to incorrect types
-  [Screen in keyof ParamList]: undefined extends ParamList[Screen] // Params are either undefined or a union with undefined
-    ?
-        | [screen: Screen] // if the params are optional, we don't have to provide it
-        | [screen: Screen, params: ParamList[Screen]]
-    : [screen: Screen, params: ParamList[Screen]];
-}[RouteName];
-
 export type DefaultNavigatorOptions<
   ParamList extends ParamListBase,
   NavigatorID extends string | undefined,
@@ -110,7 +95,7 @@ export type DefaultNavigatorOptions<
 
   /**
    * A function returning overrides for the underlying router used by the navigator.
-   * The overrides will be shallow merged into the original router.
+   * The overrides will be shallow merged onto 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.
@@ -256,21 +241,30 @@ type NavigationHelpersCommon<
    * 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 screen Name of the route to navigate to.
    * @param [params] Params object for the route.
-   * @param [merge] Whether to merge the params onto the route.
+   * @param [options.merge] Whether to merge the params onto the route. Defaults to `false`.
+   * @param [options.pop] Whether to pop routes in a stack to go back to the matching route. Defaults to `false`.
    */
   navigate<RouteName extends keyof ParamList>(
-    ...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]
+    ...args: // This condition allows us to iterate over a union type
+    // This is to avoid getting a union of all the params from `ParamList[RouteName]`,
+    // which will get our types all mixed up if a union RouteName is passed in.
+    RouteName extends unknown
+      ? // This condition checks if the params are optional,
+        // which means it's either undefined or a union with undefined
+        undefined extends ParamList[RouteName]
+        ? [
+            screen: RouteName,
+            params?: ParamList[RouteName],
+            options?: { merge?: boolean; pop?: boolean },
+          ]
+        : [
+            screen: RouteName,
+            params: ParamList[RouteName],
+            options?: { merge?: boolean; pop?: boolean },
+          ]
+      : never
   ): void;
 
   /**
@@ -279,19 +273,19 @@ type NavigationHelpersCommon<
    * @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.
+   * @param [options.merge] Whether to merge the params onto the route. Defaults to `false`.
+   * @param [options.pop] Whether to pop routes in a stack to go back to the matching route. Defaults to `false`.
    */
   navigate<RouteName extends keyof ParamList>(
-    options: {
-      [Screen in keyof ParamList]: {
-        name: Screen;
-        params: ParamList[Screen];
-        path?: string;
-        merge?: boolean;
-        pop?: boolean;
-      };
-    }[RouteName]
+    options: RouteName extends unknown
+      ? {
+          name: RouteName;
+          params: ParamList[RouteName];
+          path?: string;
+          merge?: boolean;
+          pop?: boolean;
+        }
+      : never
   ): void;
 
   /**
@@ -299,11 +293,15 @@ type NavigationHelpersCommon<
    *
    * @deprecated Use `navigate` instead.
    *
-   * @param name Name of the route to navigate to.
+   * @param screen Name of the route to navigate to.
    * @param [params] Params object for the route.
    */
   navigateDeprecated<RouteName extends keyof ParamList>(
-    ...args: ScreenParamsPair<ParamList, RouteName>
+    ...args: RouteName extends unknown
+      ? undefined extends ParamList[RouteName]
+        ? [screen: RouteName, params?: ParamList[RouteName]]
+        : [screen: RouteName, params: ParamList[RouteName]]
+      : never
   ): void;
 
   /**
@@ -314,23 +312,27 @@ type NavigationHelpersCommon<
    * @param options Object with `name` for the route to navigate to, and a `params` object.
    */
   navigateDeprecated<RouteName extends keyof ParamList>(
-    options: {
-      [Screen in keyof ParamList]: {
-        name: Screen;
-        params: ParamList[Screen];
-        merge?: boolean;
-      };
-    }[RouteName]
+    options: RouteName extends unknown
+      ? {
+          name: RouteName;
+          params: ParamList[RouteName];
+          merge?: boolean;
+        }
+      : never
   ): void;
 
   /**
    * Preloads the route in current navigation tree.
    *
-   * @param name Name of the route to navigate to.
+   * @param screen Name of the route to preload.
    * @param [params] Params object for the route.
    */
   preload<RouteName extends keyof ParamList>(
-    ...args: ScreenParamsPair<ParamList, RouteName>
+    ...args: RouteName extends unknown
+      ? undefined extends ParamList[RouteName]
+        ? [screen: RouteName, params?: ParamList[RouteName]]
+        : [screen: RouteName, params: ParamList[RouteName]]
+      : never
   ): void;
 
   /**
@@ -549,7 +551,7 @@ export type Descriptor<
   /**
    * Render the component associated with this route.
    */
-  render(): JSX.Element;
+  render(): React.JSX.Element;
 
   /**
    * Options for the route.

package/src/useComponent.tsx

@@ -1,6 +1,6 @@
 import * as React from 'react';
 
-type Render = (children: React.ReactNode) => JSX.Element;
+type Render = (children: React.ReactNode) => React.JSX.Element;
 
 type Props = {
   render: Render;