@react-navigation/routers 7.3.0 → 7.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/lib/typescript/commonjs/src/StackRouter.d.ts +4 -4
  2. package/lib/typescript/commonjs/src/TabRouter.d.ts +1 -1
  3. package/lib/typescript/module/src/StackRouter.d.ts +4 -4
  4. package/lib/typescript/module/src/TabRouter.d.ts +1 -1
  5. package/package.json +2 -2
  6. package/src/StackRouter.tsx +4 -4
  7. package/src/TabRouter.tsx +1 -1
package/lib/typescript/commonjs/src/StackRouter.d.ts CHANGED
@@ -51,14 +51,14 @@ export type StackActionHelpers<ParamList extends ParamListBase> = {
51
51
  /**
52
52
  * Replace the current route with a new one.
53
53
  *
54
- * @param name Name of the new route.
54
+ * @param screen Name of the new route that will replace the current one.
55
55
  * @param [params] Params object for the new route.
56
56
  */
57
57
  replace<RouteName extends keyof ParamList>(...args: RouteName extends unknown ? undefined extends ParamList[RouteName] ? [screen: RouteName, params?: ParamList[RouteName]] : [screen: RouteName, params: ParamList[RouteName]] : never): void;
58
58
  /**
59
59
  * Push a new screen onto the stack.
60
60
  *
61
- * @param name Name of the route to push onto the stack.
61
+ * @param screen Name of the route to push onto the stack.
62
62
  * @param [params] Params object for the route.
63
63
  */
64
64
  push<RouteName extends keyof ParamList>(...args: RouteName extends unknown ? undefined extends ParamList[RouteName] ? [screen: RouteName, params?: ParamList[RouteName]] : [screen: RouteName, params: ParamList[RouteName]] : never): void;
@@ -74,9 +74,9 @@ export type StackActionHelpers<ParamList extends ParamListBase> = {
74
74
  * Pop any screens to go back to the specified screen.
75
75
  * If the specified screen doesn't exist, it'll be added to the stack.
76
76
  *
77
- * @param name Name of the route to navigate to.
77
+ * @param screen Name of the route to pop to.
78
78
  * @param [params] Params object for the route.
79
- * @param [merge] Whether to merge the params onto the route.
79
+ * @param [options.merge] Whether to merge the params onto the route. Defaults to `false`.
80
80
  */
81
81
  popTo<RouteName extends keyof ParamList>(...args: RouteName extends unknown ? undefined extends ParamList[RouteName] ? [
82
82
  screen: RouteName,
package/lib/typescript/commonjs/src/TabRouter.d.ts CHANGED
@@ -33,7 +33,7 @@ export type TabActionHelpers<ParamList extends ParamListBase> = {
33
33
  /**
34
34
  * Jump to an existing tab.
35
35
  *
36
- * @param name Name of the route for the tab.
36
+ * @param screen Name of the route to jump to.
37
37
  * @param [params] Params object for the route.
38
38
  */
39
39
  jumpTo<RouteName extends Extract<keyof ParamList, string>>(...args: RouteName extends unknown ? undefined extends ParamList[RouteName] ? [screen: RouteName, params?: ParamList[RouteName]] : [screen: RouteName, params: ParamList[RouteName]] : never): void;
package/lib/typescript/module/src/StackRouter.d.ts CHANGED
@@ -51,14 +51,14 @@ export type StackActionHelpers<ParamList extends ParamListBase> = {
51
51
  /**
52
52
  * Replace the current route with a new one.
53
53
  *
54
- * @param name Name of the new route.
54
+ * @param screen Name of the new route that will replace the current one.
55
55
  * @param [params] Params object for the new route.
56
56
  */
57
57
  replace<RouteName extends keyof ParamList>(...args: RouteName extends unknown ? undefined extends ParamList[RouteName] ? [screen: RouteName, params?: ParamList[RouteName]] : [screen: RouteName, params: ParamList[RouteName]] : never): void;
58
58
  /**
59
59
  * Push a new screen onto the stack.
60
60
  *
61
- * @param name Name of the route to push onto the stack.
61
+ * @param screen Name of the route to push onto the stack.
62
62
  * @param [params] Params object for the route.
63
63
  */
64
64
  push<RouteName extends keyof ParamList>(...args: RouteName extends unknown ? undefined extends ParamList[RouteName] ? [screen: RouteName, params?: ParamList[RouteName]] : [screen: RouteName, params: ParamList[RouteName]] : never): void;
@@ -74,9 +74,9 @@ export type StackActionHelpers<ParamList extends ParamListBase> = {
74
74
  * Pop any screens to go back to the specified screen.
75
75
  * If the specified screen doesn't exist, it'll be added to the stack.
76
76
  *
77
- * @param name Name of the route to navigate to.
77
+ * @param screen Name of the route to pop to.
78
78
  * @param [params] Params object for the route.
79
- * @param [merge] Whether to merge the params onto the route.
79
+ * @param [options.merge] Whether to merge the params onto the route. Defaults to `false`.
80
80
  */
81
81
  popTo<RouteName extends keyof ParamList>(...args: RouteName extends unknown ? undefined extends ParamList[RouteName] ? [
82
82
  screen: RouteName,
package/lib/typescript/module/src/TabRouter.d.ts CHANGED
@@ -33,7 +33,7 @@ export type TabActionHelpers<ParamList extends ParamListBase> = {
33
33
  /**
34
34
  * Jump to an existing tab.
35
35
  *
36
- * @param name Name of the route for the tab.
36
+ * @param screen Name of the route to jump to.
37
37
  * @param [params] Params object for the route.
38
38
  */
39
39
  jumpTo<RouteName extends Extract<keyof ParamList, string>>(...args: RouteName extends unknown ? undefined extends ParamList[RouteName] ? [screen: RouteName, params?: ParamList[RouteName]] : [screen: RouteName, params: ParamList[RouteName]] : never): void;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@react-navigation/routers",
3
3
  "description": "Routers to help build custom navigators",
4
- "version": "7.3.0",
4
+ "version": "7.3.1",
5
5
  "keywords": [
6
6
  "react",
7
7
  "react-native",
@@ -80,5 +80,5 @@
80
80
  ]
81
81
  ]
82
82
  },
83
- "gitHead": "3f7e8f132c141c8a73ec5678e8bb37fbeb8283b4"
83
+ "gitHead": "a656331009fcb534e0bef535e6df65ae07a228a4"
84
84
  }
package/src/StackRouter.tsx CHANGED
@@ -64,7 +64,7 @@ export type StackActionHelpers<ParamList extends ParamListBase> = {
64
64
  /**
65
65
  * Replace the current route with a new one.
66
66
  *
67
- * @param name Name of the new route.
67
+ * @param screen Name of the new route that will replace the current one.
68
68
  * @param [params] Params object for the new route.
69
69
  */
70
70
  replace<RouteName extends keyof ParamList>(
@@ -78,7 +78,7 @@ export type StackActionHelpers<ParamList extends ParamListBase> = {
78
78
  /**
79
79
  * Push a new screen onto the stack.
80
80
  *
81
- * @param name Name of the route to push onto the stack.
81
+ * @param screen Name of the route to push onto the stack.
82
82
  * @param [params] Params object for the route.
83
83
  */
84
84
  push<RouteName extends keyof ParamList>(
@@ -103,9 +103,9 @@ export type StackActionHelpers<ParamList extends ParamListBase> = {
103
103
  * Pop any screens to go back to the specified screen.
104
104
  * If the specified screen doesn't exist, it'll be added to the stack.
105
105
  *
106
- * @param name Name of the route to navigate to.
106
+ * @param screen Name of the route to pop to.
107
107
  * @param [params] Params object for the route.
108
- * @param [merge] Whether to merge the params onto the route.
108
+ * @param [options.merge] Whether to merge the params onto the route. Defaults to `false`.
109
109
  */
110
110
  popTo<RouteName extends keyof ParamList>(
111
111
  ...args: RouteName extends unknown
package/src/TabRouter.tsx CHANGED
@@ -51,7 +51,7 @@ export type TabActionHelpers<ParamList extends ParamListBase> = {
51
51
  /**
52
52
  * Jump to an existing tab.
53
53
  *
54
- * @param name Name of the route for the tab.
54
+ * @param screen Name of the route to jump to.
55
55
  * @param [params] Params object for the route.
56
56
  */
57
57
  jumpTo<RouteName extends Extract<keyof ParamList, string>>(