feat: support navigate-like object in Link

react-navigation · May 9, 2021 · 1478659 · 1478659
1 parent b28bfdd
commit 1478659
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 27 deletions.
diff --git a/example/src/Screens/LinkComponent.tsx b/example/src/Screens/LinkComponent.tsx
@@ -24,7 +24,8 @@ const scrollEnabled = Platform.select({ web: true, default: false });
 const LinkButton = ({
   to,
   ...rest
-}: React.ComponentProps<typeof Button> & { to: string }) => {
+}: React.ComponentProps<typeof Button> &
+  Parameters<typeof useLinkProps>[0]) => {
   const props = useLinkProps({ to });
 
   return <Button {...props} {...rest} />;
@@ -57,6 +58,13 @@ const ArticleScreen = ({
         >
           Go to /link-component/music
         </LinkButton>
+        <LinkButton
+          to={{ screen: 'Home' }}
+          mode="contained"
+          style={styles.button}
+        >
+          Go to /
+        </LinkButton>
         <Button
           mode="outlined"
           onPress={() => navigation.goBack()}

diff --git a/packages/native/src/Link.tsx b/packages/native/src/Link.tsx
@@ -2,9 +2,10 @@ import * as React from 'react';
 import { Text, TextProps, GestureResponderEvent, Platform } from 'react-native';
 import type { NavigationAction } from '@react-navigation/core';
 import useLinkProps from './useLinkProps';
+import type { To } from './useLinkTo';
 
 type Props = {
-  to: string;
+  to: To;
   action?: NavigationAction;
   target?: string;
   onPress?: (

diff --git a/packages/native/src/useLinkProps.tsx b/packages/native/src/useLinkProps.tsx
@@ -4,10 +4,10 @@ import {
   NavigationAction,
   NavigationHelpersContext,
 } from '@react-navigation/core';
-import useLinkTo from './useLinkTo';
+import useLinkTo, { To } from './useLinkTo';
 
 type Props = {
-  to: string;
+  to: To;
   action?: NavigationAction;
 };
 
@@ -49,14 +49,6 @@ export default function useLinkProps({ to, action }: Props) {
           throw new Error("Couldn't find a navigation object.");
         }
       } else {
-        if (typeof to !== 'string') {
-          throw new Error(
-            `To 'to' option is invalid (found '${String(
-              to
-            )}'. It must be a valid string for navigation.`
-          );
-        }
-
         linkTo(to);
       }
     }

diff --git a/packages/native/src/useLinkTo.tsx b/packages/native/src/useLinkTo.tsx
@@ -6,37 +6,57 @@ import {
 } from '@react-navigation/core';
 import LinkingContext from './LinkingContext';
 
+export type To<
+  ParamList extends ReactNavigation.RootParamList = ReactNavigation.RootParamList,
+  RouteName extends keyof ParamList = keyof ParamList
+> =
+  | string
+  | (undefined extends ParamList[RouteName]
+      ? {
+          screen: RouteName;
+          params?: ParamList[RouteName];
+        }
+      : {
+          screen: RouteName;
+          params: ParamList[RouteName];
+        });
+
 export default function useLinkTo() {
   const navigation = React.useContext(NavigationContext);
   const linking = React.useContext(LinkingContext);
 
   const linkTo = React.useCallback(
-    (path: string) => {
-      if (!path.startsWith('/')) {
-        throw new Error(`The path must start with '/' (${path}).`);
-      }
-
+    (to: To) => {
       if (navigation === undefined) {
         throw new Error(
           "Couldn't find a navigation object. Is your component inside a screen in a navigator?"
         );
       }
 
+      let root = navigation;
+      let current;
+
+      // Traverse up to get the root navigation
+      while ((current = root.getParent())) {
+        root = current;
+      }
+
+      if (typeof to !== 'string') {
+        root.navigate(to.screen, to.params);
+        return;
+      }
+
+      if (!to.startsWith('/')) {
+        throw new Error(`The path must start with '/' (${to}).`);
+      }
+
       const { options } = linking;
 
       const state = options?.getStateFromPath
-        ? options.getStateFromPath(path, options.config)
-        : getStateFromPath(path, options?.config);
+        ? options.getStateFromPath(to, options.config)
+        : getStateFromPath(to, options?.config);
 
       if (state) {
-        let root = navigation;
-        let current;
-
-        // Traverse up to get the root navigation
-        while ((current = root.getParent())) {
-          root = current;
-        }
-
         const action = getActionFromState(state, options?.config);
 
         if (action !== undefined) {