refactor: rename createNavigator since it doesn't create a navigator

README.md

@@ -35,7 +35,7 @@ Navigators bundle a router and a view which takes the navigation state and decid
 A simple navigator could look like this:
 
 ```js
-import { createNavigator } from '@react-navigation/core';
+import { createNavigatorFactory } from '@react-navigation/core';
 
 function StackNavigator({ initialRouteName, children, ...rest }) {
   // The `navigation` object contains the navigation state and some helpers (e.g. push, pop)
@@ -56,7 +56,7 @@ function StackNavigator({ initialRouteName, children, ...rest }) {
   );
 }
 
-export default createNavigator(StackNavigator);
+export default createNavigatorFactory(StackNavigator);
 ```
 
 The navigator can render a screen by calling `descriptors[route.key].render()`. Internally, the descriptor adds appropriate wrappers to handle nested state.

packages/bottom-tabs/src/navigators/createBottomTabNavigator.tsx

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import {
   useNavigationBuilder,
-  createNavigator,
+  createNavigatorFactory,
   DefaultNavigatorOptions,
 } from '@react-navigation/core';
 import {
@@ -49,7 +49,7 @@ function BottomTabNavigator({
   );
 }
 
-export default createNavigator<
+export default createNavigatorFactory<
   BottomTabNavigationOptions,
   typeof BottomTabNavigator
 >(BottomTabNavigator);

packages/compat/src/createSwitchNavigator.tsx

@@ -1,6 +1,6 @@
 import {
   useNavigationBuilder,
-  createNavigator,
+  createNavigatorFactory,
   DefaultNavigatorOptions,
 } from '@react-navigation/core';
 import {
@@ -24,5 +24,5 @@ function SwitchNavigator(props: Props) {
 }
 
 export default createCompatNavigatorFactory(
-  createNavigator<{}, typeof SwitchNavigator>(SwitchNavigator)
+  createNavigatorFactory<{}, typeof SwitchNavigator>(SwitchNavigator)
 );

packages/core/README.md

@@ -15,7 +15,7 @@ yarn add @react-navigation/core
 A basic custom navigator bundling a router and a view looks like this:
 
 ```js
-import { useNavigationBuilder } from '@react-navigation/core';
+import { createNavigatorFactory, useNavigationBuilder } from '@react-navigation/core';
 import { StackRouter } from '@react-navigation/routers';
 
 function StackNavigator({ initialRouteName, children, ...rest }) {
@@ -34,5 +34,5 @@ function StackNavigator({ initialRouteName, children, ...rest }) {
   );
 }
 
-export default createNavigator(StackNavigator);
+export default createNavigatorFactory(StackNavigator);
 ```

packages/core/src/createNavigatorFactory.tsx

@@ -9,7 +9,7 @@ import { ParamListBase, TypedNavigator } from './types';
  * @param Navigator The navigtor component to wrap.
  * @returns Factory method to create a `Navigator` and `Screen` pair.
  */
-export default function createNavigator<
+export default function createNavigatorFactory<
   ScreenOptions extends object,
   NavigatorComponent extends React.ComponentType<any>
 >(Navigator: NavigatorComponent) {

packages/core/src/index.tsx

@@ -4,7 +4,7 @@ export { CommonActions };
 
 export { default as BaseRouter } from './BaseRouter';
 export { default as NavigationContainer } from './NavigationContainer';
-export { default as createNavigator } from './createNavigator';
+export { default as createNavigatorFactory } from './createNavigatorFactory';
 
 export { default as NavigationContext } from './NavigationContext';
 export { default as NavigationRouteContext } from './NavigationRouteContext';

packages/drawer/src/navigators/createDrawerNavigator.tsx

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import {
-  createNavigator,
+  createNavigatorFactory,
   useNavigationBuilder,
   DefaultNavigatorOptions,
 } from '@react-navigation/core';
@@ -48,6 +48,7 @@ function DrawerNavigator({
   );
 }
 
-export default createNavigator<DrawerNavigationOptions, typeof DrawerNavigator>(
-  DrawerNavigator
-);
+export default createNavigatorFactory<
+  DrawerNavigationOptions,
+  typeof DrawerNavigator
+>(DrawerNavigator);

packages/material-bottom-tabs/src/navigators/createMaterialBottomTabNavigator.tsx

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import {
   useNavigationBuilder,
-  createNavigator,
+  createNavigatorFactory,
   DefaultNavigatorOptions,
 } from '@react-navigation/core';
 import {
@@ -50,7 +50,7 @@ function MaterialBottomTabNavigator({
   );
 }
 
-export default createNavigator<
+export default createNavigatorFactory<
   MaterialBottomTabNavigationOptions,
   typeof MaterialBottomTabNavigator
 >(MaterialBottomTabNavigator);

packages/material-top-tabs/src/navigators/createMaterialTopTabNavigator.tsx

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import {
   useNavigationBuilder,
-  createNavigator,
+  createNavigatorFactory,
   DefaultNavigatorOptions,
 } from '@react-navigation/core';
 import {
@@ -49,7 +49,7 @@ function MaterialTopTabNavigator({
   );
 }
 
-export default createNavigator<
+export default createNavigatorFactory<
   MaterialTopTabNavigationOptions,
   typeof MaterialTopTabNavigator
 >(MaterialTopTabNavigator);

packages/native-stack/src/navigators/createNativeStackNavigator.tsx

@@ -1,6 +1,6 @@
 import React from 'react';
 import {
-  createNavigator,
+  createNavigatorFactory,
   useNavigationBuilder,
   EventArg,
 } from '@react-navigation/core';
@@ -73,7 +73,7 @@ function NativeStackNavigator(props: NativeStackNavigatorProps) {
   );
 }
 
-export default createNavigator<
+export default createNavigatorFactory<
   NativeStackNavigationOptions,
   typeof NativeStackNavigator
 >(NativeStackNavigator);

packages/routers/README.md

@@ -17,7 +17,7 @@ yarn add @react-navigation/core @react-navigation/routers
 A basic custom navigator bundling a router and a view looks like this:
 
 ```js
-import { useNavigationBuilder } from '@react-navigation/core';
+import { createNavigatorFactory, useNavigationBuilder } from '@react-navigation/core';
 import { StackRouter } from '@react-navigation/routers';
 
 function StackNavigator({ initialRouteName, children, ...rest }) {
@@ -36,5 +36,5 @@ function StackNavigator({ initialRouteName, children, ...rest }) {
   );
 }
 
-export default createNavigator(StackNavigator);
+export default createNavigatorFactory(StackNavigator);
 ```

packages/stack/src/navigators/createStackNavigator.tsx

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import {
   useNavigationBuilder,
-  createNavigator,
+  createNavigatorFactory,
   DefaultNavigatorOptions,
   EventArg,
 } from '@react-navigation/core';
@@ -78,6 +78,7 @@ function StackNavigator({
   );
 }
 
-export default createNavigator<StackNavigationOptions, typeof StackNavigator>(
-  StackNavigator
-);
+export default createNavigatorFactory<
+  StackNavigationOptions,
+  typeof StackNavigator
+>(StackNavigator);