feat: Export StackNavigator, StackNavigatorProps and TypedStackNavigator type defs

[jtomaszewski]

(Same as #8233 but rebased from master to main)

Thanks to this, you can easily import and construct a type of a value returned by createStackNavigator<T>() expression.

We would use this because our app is quite complex, and so we extract constructing routes/params/stacks to separate files. We could use this like that:

import React from "react";
import { TypedStackNavigator } from "@react-navigation/stack";
import { RootStackNavigatorParamList, Screens } from "../navigation";
import { ChatScreen, ChatListScreen } from "./chat";

export const getChatStackScreens = (
  Stack: TypedStackNavigator<RootStackNavigatorParamList>
): React.ReactElement => {
  return (
    <>
      <Stack.Screen
        name={Screens.ChatList}
        component={ChatListScreen}
      />
      <Stack.Screen
        name={Screens.Chat}
        component={ChatScreen}
      />
    </>
  );
};

// and then in `Stack.Navigator` just use it like `{getMoreStackScreens(Stack)}`

[satya164]

Thanks for the PR. Can you also export types for all of the other navigators?

[satya164]

I think exposing this is confusing (there's no the difference between this and Stack.Navigator to the user, which one should they use). Why do you need it?

[satya164]

I think this shouldn't be exported. You should use React.ComponentProps<typeof Stack.Navigator> or React.ComponentProps<TypedStackNavigator<ParamList>['Navigator']> in this case. Otherwise it lacks type information for params.

[satya164]

Can you rename it to StackNavigatorType?

[jtomaszewski]

Should I also rename TypedNavigator to NavigatorType? (That's why I named it TypedStackNavigator, because TypedNavigator already existed.)

[satya164]

That's internal, so it doesn't matter what we name it. I think TypedNavigator is ok for internal use.

[satya164]

Can you move the type export to separate export type statement?

[satya164]

Closing due to no activity

[github-actions]

Hey! This issue is closed and isn't watched by the core team. You are welcome to discuss the issue with others in this thread, but if you think this issue is still valid and needs to be tracked, please open a new issue with a repro.