chore: drop support for createMaterialBottomTabNavigator

Author: lukewalczak

docs/docs/guides/09-bottom-navigation.md

@@ -2,6 +2,39 @@
 title: Using BottomNavigation with React Navigation
 ---
 
+:::caution
+`createMaterialBottomTabNavigator` has been deprecated since `[email protected]`. Please use `@react-navigation/bottom-tabs` version `7.x` or higher and combine it with `BottomNavigation.Bar` for a Material Design look.
+
+```js
+import { createBottomTabNavigator } from '@react-navigation/bottom-tabs';
+import { BottomNavigation } from 'react-native-paper';
+
+const Tab = createBottomTabNavigator();
+
+function MyTabs() {
+  return (
+    <Tab.Navigator
+      tabBar={({ navigation, state, descriptors, insets }) => (
+        <BottomNavigation.Bar
+          ...
+        />
+      )}
+    >
+      <Tab.Screen name="Home" component={HomeScreen} />
+      <Tab.Screen name="Profile" component={ProfileScreen} />
+    </Tab.Navigator>
+  );
+}
+```
+
+:::
+
+> 👉 For a complete example please visit `createBottomTabNavigator` [snack](https://snack.expo.dev/@react-native-paper/createbottomtabnavigator-with-bottomnavigationbar).
+
+---
+
+_For projects using `react-native-paper` < `5.14.0` and `react-navigation` < `7.x`, proceed as follows:_
+
 A material-design themed tab bar on the bottom of the screen that lets you switch between different routes with animation. Routes are lazily initialized - their screen components are not mounted until they are first focused.
 
 This wraps the [`BottomNavigation`](https://callstack.github.io/react-native-paper/docs/components/BottomNavigation/) component from `react-native-paper`, however if you [configure the Babel plugin](https://callstack.github.io/react-native-paper/docs/guides/getting-started/), it won't include the whole library in your bundle.
@@ -12,7 +45,7 @@ This wraps the [`BottomNavigation`](https://callstack.github.io/react-native-pap
 To use this navigator, ensure that you have [`@react-navigation/native` and its dependencies (follow this guide)](https://reactnavigation.org/docs/getting-started):
 :::
 
-> For a complete example please visit `createMaterialBottomTabNavigator` [snack](https://snack.expo.dev/@react-native-paper/creatematerialbottomtabnavigator)
+> 👉 For a complete example please visit `createMaterialBottomTabNavigator` [snack](https://snack.expo.dev/@react-native-paper/creatematerialbottomtabnavigator)
 
 ## API Definition
 
@@ -33,7 +66,7 @@ function MyTabs() {
 }
 ```
 
-> For a complete usage guide please visit [Tab Navigation](https://reactnavigation.org/docs/tab-based-navigation/)
+> 👉 For a complete usage guide please visit [Tab Navigation](https://reactnavigation.org/docs/tab-based-navigation/)
 
 ### Props
 
@@ -239,4 +272,4 @@ function MyTabs() {
     </Tab.Navigator>
   );
 }
-```
+```

example/src/ExampleList.tsx

@@ -28,7 +28,6 @@ import ListAccordionExample from './Examples/ListAccordionExample';
 import ListAccordionExampleGroup from './Examples/ListAccordionGroupExample';
 import ListItemExample from './Examples/ListItemExample';
 import ListSectionExample from './Examples/ListSectionExample';
-import MaterialBottomTabNavigatorExample from './Examples/MaterialBottomTabNavigatorExample';
 import MenuExample from './Examples/MenuExample';
 import ProgressBarExample from './Examples/ProgressBarExample';
 import RadioButtonExample from './Examples/RadioButtonExample';
@@ -80,7 +79,6 @@ export const mainExamples: Record<
   listAccordionGroup: ListAccordionExampleGroup,
   listSection: ListSectionExample,
   listItem: ListItemExample,
-  materialBottomTabNavigator: MaterialBottomTabNavigatorExample,
   menu: MenuExample,
   progressbar: ProgressBarExample,
   radio: RadioButtonExample,

example/src/Examples/MaterialBottomTabNavigatorExample.tsx

@@ -59,7 +59,7 @@
     "@callstack/eslint-config": "^13.0.2",
     "@commitlint/config-conventional": "^8.3.4",
     "@expo/vector-icons": "^14.0.2",
-    "@react-navigation/native": "^7.1.6",
+    "@react-navigation/native": "^6.1.2",
     "@release-it/conventional-changelog": "^1.1.0",
     "@testing-library/jest-native": "^5.4.1",
     "@testing-library/react-native": "11.5.0",

package.json

@@ -3,14 +3,11 @@ import * as React from 'react';
 import {
   createNavigatorFactory,
   DefaultNavigatorOptions,
-  NavigatorTypeBagBase,
   ParamListBase,
-  StaticConfig,
   TabActionHelpers,
   TabNavigationState,
   TabRouter,
   TabRouterOptions,
-  TypedNavigator,
   useNavigationBuilder,
 } from '@react-navigation/native';
 
@@ -21,14 +18,11 @@ import type {
 } from '../types';
 import MaterialBottomTabView from '../views/MaterialBottomTabView';
 
-// Based on: https://github.com/react-navigation/react-navigation/blob/main/packages/bottom-tabs/src/types.tsx#L445-L454
 export type MaterialBottomTabNavigatorProps = DefaultNavigatorOptions<
   ParamListBase,
-  undefined,
   TabNavigationState<ParamListBase>,
   MaterialBottomTabNavigationOptions,
-  MaterialBottomTabNavigationEventMap,
-  typeof MaterialBottomTabView
+  MaterialBottomTabNavigationEventMap
 > &
   TabRouterOptions &
   MaterialBottomTabNavigationConfig;
@@ -70,22 +64,12 @@ function MaterialBottomTabNavigator({
   );
 }
 
-// Based on: https://github.com/react-navigation/react-navigation/blob/main/packages/material-top-tabs/src/navigators/createMaterialTopTabNavigator.tsx#L65-L86
-export default function <
-  const ParamList extends ParamListBase,
-  const NavigatorID extends string | undefined,
-  const TypeBag extends NavigatorTypeBagBase = {
-    ParamList: ParamList;
-    NavigatorID: NavigatorID;
-    State: TabNavigationState<ParamList>;
-    ScreenOptions: MaterialBottomTabNavigationOptions;
-    EventMap: MaterialBottomTabNavigationEventMap;
-    NavigationList: {
-      [RouteName in keyof ParamList]: MaterialBottomTabNavigatorProps;
-    };
-    Navigator: typeof MaterialBottomTabNavigator;
-  },
-  const Config extends StaticConfig<TypeBag> = StaticConfig<TypeBag>
->(config?: Config): TypedNavigator<TypeBag, Config> {
-  return createNavigatorFactory(MaterialBottomTabNavigator)(config);
-}
+/**
+ * @deprecated `createMaterialBottomTabNavigator` has been deprecated since `5.14.0`. Please use `@react-navigation/bottom-tabs` version `7.x` or higher instead.
+ */
+export default createNavigatorFactory<
+  TabNavigationState<ParamListBase>,
+  MaterialBottomTabNavigationOptions,
+  MaterialBottomTabNavigationEventMap,
+  typeof MaterialBottomTabNavigator
+>(MaterialBottomTabNavigator);

src/react-navigation/__tests__/adapter.v6.test.ts

@@ -7,11 +7,11 @@ import {
   ParamListBase,
   Route,
   TabNavigationState,
+  useLinkBuilder,
 } from '@react-navigation/native';
 
 import BottomNavigation from '../../components/BottomNavigation/BottomNavigation';
 import MaterialCommunityIcon from '../../components/MaterialCommunityIcon';
-import { useNavigationLink } from '../adapter';
 import type {
   MaterialBottomTabDescriptorMap,
   MaterialBottomTabNavigationConfig,
@@ -29,7 +29,7 @@ export default function MaterialBottomTabView({
   descriptors,
   ...rest
 }: Props) {
-  const buildLink = useNavigationLink();
+  const buildLink = useLinkBuilder();
 
   return (
     <BottomNavigation