feat: export types for ScreenProps amd ScreenComponent

react-navigation · Sep 12, 2019 · be8155f · be8155f
1 parent 5267a1c
commit be8155f
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 13 deletions.
diff --git a/example/package.json b/example/package.json
@@ -19,7 +19,7 @@
     "react-native-gesture-handler": "~1.3.0",
     "react-native-paper": "^3.0.0-alpha.4",
     "react-native-reanimated": "~1.1.0",
-    "react-navigation": "^4.0.3",
+    "react-navigation": "^4.0.4",
     "react-navigation-stack": "^1.5.4"
   },
   "devDependencies": {

diff --git a/example/yarn.lock b/example/yarn.lock
@@ -4318,10 +4318,10 @@ react-navigation-stack@^1.5.4:
   dependencies:
     prop-types "^15.7.2"
 
-react-navigation@^4.0.3:
-  version "4.0.3"
-  resolved "https://registry.yarnpkg.com/react-navigation/-/react-navigation-4.0.3.tgz#ba2cacb71db56e22ee50d774829ebc7fa95a0724"
-  integrity sha512-oASR5gHwd6se1Mw8AM4Ie8GicD5mKzRiYP6oaQujiQroQzQPij9sXxkRSqOscd/Kw1/Hf3htvBX3ZRPbOkWsfA==
+react-navigation@^4.0.4:
+  version "4.0.4"
+  resolved "https://registry.yarnpkg.com/react-navigation/-/react-navigation-4.0.4.tgz#afa43c7183891d38708cf57f1d4394fed1d4c2ad"
+  integrity sha512-MZeVkYkFTKZobhrXMV3Hgeg0HHeokCrYsbxActVfO0n6zfzm0/La6EiC2mIHiwOymvb1ZygyFf90vryLUMEBNA==
   dependencies:
     "@react-navigation/core" "^3.5.0"
     "@react-navigation/native" "^3.6.2"

diff --git a/package.json b/package.json
@@ -60,15 +60,15 @@
     "react-native-gesture-handler": "^1.4.1",
     "react-native-paper": "^3.0.0-alpha.4",
     "react-native-reanimated": "^1.2.0",
-    "react-navigation": "^4.0.3",
+    "react-navigation": "^4.0.4",
     "release-it": "^12.3.6",
     "typescript": "^3.5.2"
   },
   "peerDependencies": {
     "react": "*",
     "react-native": "*",
     "react-native-paper": "^2.2.2 || ^3.0.0-alpha.1",
-    "react-navigation": "^4.0.3"
+    "react-navigation": "^4.0.4"
   },
   "husky": {
     "hooks": {

diff --git a/src/index.tsx b/src/index.tsx
@@ -1,3 +1,15 @@
 export {
   default as createMaterialBottomTabNavigator,
 } from './navigators/createMaterialBottomTabNavigator';
+
+/**
+ * Types
+ */
+export {
+  NavigationTabState,
+  NavigationTabProp,
+  NavigationTabScreenProps,
+  NavigationMaterialBottomTabOptions,
+  NavigationMaterialBottomTabConfig,
+  NavigationMaterialBottomTabScreenComponent,
+} from './types';
diff --git a/src/navigators/createMaterialBottomTabNavigator.tsx b/src/navigators/createMaterialBottomTabNavigator.tsx
@@ -54,12 +54,13 @@ export type NavigationViewProps = {
 export default function createMaterialBottomTabNavigator(
   routes: NavigationRouteConfigMap<
     NavigationMaterialBottomTabOptions,
-    NavigationTabProp
+    NavigationTabProp<NavigationRoute, any>
   >,
   config: CreateNavigatorConfig<
     NavigationMaterialBottomTabConfig,
     NavigationTabRouterConfig,
-    NavigationMaterialBottomTabOptions
+    NavigationMaterialBottomTabOptions,
+    NavigationTabProp<NavigationRoute, any>
   > = {}
 ) {
   class NavigationView extends React.Component<NavigationViewProps> {

diff --git a/src/types.tsx b/src/types.tsx
@@ -4,6 +4,8 @@ import {
   NavigationState,
   NavigationScreenProp,
   NavigationParams,
+  NavigationScreenConfig,
+  SupportedThemes,
 } from 'react-navigation';
 
 export type NavigationTabState = NavigationState;
@@ -85,3 +87,22 @@ export type NavigationMaterialBottomTabConfig = {
   barStyleDark?: StyleProp<ViewStyle>;
   style?: StyleProp<ViewStyle>;
 };
+
+export type NavigationTabScreenProps<
+  Params = NavigationParams,
+  ScreenProps = unknown
+> = {
+  theme: SupportedThemes;
+  navigation: NavigationTabProp<NavigationRoute, Params>;
+  screenProps: ScreenProps;
+};
+
+export type NavigationMaterialBottomTabScreenComponent<
+  Params = NavigationParams,
+  ScreenProps = unknown
+> = React.ComponentType<NavigationTabScreenProps<Params, ScreenProps>> & {
+  navigationOptions?: NavigationScreenConfig<
+    NavigationMaterialBottomTabOptions,
+    NavigationTabProp<NavigationRoute, Params>
+  >;
+};
diff --git a/yarn.lock b/yarn.lock
@@ -7378,10 +7378,10 @@ react-native@~0.59.8:
     xmldoc "^0.4.0"
     yargs "^9.0.0"
 
-react-navigation@^4.0.3:
-  version "4.0.3"
-  resolved "https://registry.yarnpkg.com/react-navigation/-/react-navigation-4.0.3.tgz#ba2cacb71db56e22ee50d774829ebc7fa95a0724"
-  integrity sha512-oASR5gHwd6se1Mw8AM4Ie8GicD5mKzRiYP6oaQujiQroQzQPij9sXxkRSqOscd/Kw1/Hf3htvBX3ZRPbOkWsfA==
+react-navigation@^4.0.4:
+  version "4.0.4"
+  resolved "https://registry.yarnpkg.com/react-navigation/-/react-navigation-4.0.4.tgz#afa43c7183891d38708cf57f1d4394fed1d4c2ad"
+  integrity sha512-MZeVkYkFTKZobhrXMV3Hgeg0HHeokCrYsbxActVfO0n6zfzm0/La6EiC2mIHiwOymvb1ZygyFf90vryLUMEBNA==
   dependencies:
     "@react-navigation/core" "^3.5.0"
     "@react-navigation/native" "^3.6.2"