8392f67b1f
* Fix .flowconfig to stop ignoring modules and properly include React Native libraries Currently, there are numerous ignored libraries that are hiding type errors. Actually, they're causing type errors too. This sort of thing only patches over actual problems, so we have to revert them to get a config we can build upon. * Update react-native/flow-bin dependencies We want to have Flow types working with the latest packages. * Update flow-typed libraries (auto-generated) * Fix typing of navigation prop used by withNavigation HOC The current typing is clearly a typo, as it is circular. `NavigationScreenProp` should be used to type the navigation prop * Fix typing of easing function What's funny is that I fixed this before ind71ed75133. @skevy reintroduced the mistyped function in9436d03fe8, which didn't trigger any Flow errors because .flowconfig was ignoring the entire react-native package * Correct typing of View and Text style prop The current code thinks it can import these, but this isn't true, and was being hidden because the .flowconfig ignored the whole react-native package. There's no easy to type Text and View at the current moment, as far as I can tell. Importing the highly generic `StyleObj` seems like the best bet, and is what I have being using in my projects. * Import NavigationScreenComponent using full path * Updating yarn.lock files * Get rid of library overrides in flow-typed/react-native.js and flow/react-navigation.js * Add @flow to src/react-navigation.js and make last three params to createNavigator optional * Make screenProps and navigationOptions optional in NavigationNavigatorProps * yarn run format * Readd react-navigation/node_modules ignore to NavigationPlayground's .flowconfig Realized this line I removed in the first commit is necessary when using npm link/yarn link, which is what the CircleCI build does * Make all DrawerViewConfig's params optional Some of these params are marked as optional because they have defaults. However, the only place `DrawerViewConfig` is used is as the input the function that then applies the defaults * Make all props in NavigationNavigatorProps optional `NavigationNavigatorProps` is used to type the props of the component that is output by the `StackNavigator`, `TabNavigator`, etc. component factories. This component does not need to have any props specified. * Make second param to `DrawerNavigator` factory optional `DrawerNavigator`, just like `TabNavigator` and `StackNavigator`, can be called with just a single argument (ie. omitting the config) * Upgrade to RN 0.48.4 to address https://github.com/facebook/react-native/issues/15810
React Navigation 4
Routing and navigation for your React Native apps.
Documentation can be found at reactnavigation.org.
Contributing
The project uses a monorepo structure for the packages managed by yarn workspaces and lerna. To get started with the project, run yarn in the root directory to install the required dependencies for each package:
yarn
While developing, you can run the example app with Expo to test your changes:
yarn example start
Make sure your code passes TypeScript and ESLint. Run the following to verify:
yarn typescript
yarn lint
To fix formatting errors, run the following:
yarn lint --fix
Remember to add tests for your change if possible. Run the unit tests by:
yarn test
Running the e2e tests with Detox (on iOS) requires the following:
- Mac with macOS (at least macOS High Sierra 10.13.6)
- Xcode 10.1+ with Xcode command line tools
First you need to install applesimutils and detox-cli:
brew tap wix/brew
brew install applesimutils
yarn global add detox-cli
Then you can build and run the tests:
detox build -c ios.sim.debug
detox test -c ios.sim.debug
Publishing
To publish a new version, first we need to export a GH_TOKEN environment variable as mentioned here. Then run:
yarn lerna publish
This will automatically bump the version and publish the packages. It'll also publish the changelogs on GitHub for each package.
Installing from a fork on GitHub
Since we use a monorepo, it's not possible to install a package from the repository URL. If you need to install a forked version from Git, you can use gitpkg.
First install gitpkg:
yarn global add gitpkg
Then follow these steps to publish and install a forked package:
- Fork this repo to your account and clone the forked repo to your local machine
- Open a Terminal and
cdto the location of the cloned repo - Run
yarnto install any dependencies - If you want to make any changes, make them and commit
- Now
cdto the package directory that you want to use (e.g.cd packages/stackfor@react-navigation/stack) - Run
gitpkg publishto publish the package to your repo
After publishing, you should see something like this:
Package uploaded to git@github.com:<user>/<repo>.git with the name <name>
You can now install the dependency in your project:
yarn add <user>/<repo>.git#<name>
Remember to replace <user>, <repo> and <name> with right values.