mirror of
https://github.com/status-im/react-navigation.git
synced 2025-02-25 01:28:16 +00:00
64 lines
2.6 KiB
Markdown
64 lines
2.6 KiB
Markdown
# React Navigation [](https://circleci.com/gh/react-community/react-navigation/tree/master) [](https://badge.fury.io/js/react-navigation) [](https://codecov.io/gh/react-community/react-navigation)
|
|
|
|
|
|
*Learn once, navigate anywhere.*
|
|
|
|
Browse the docs on [reactnavigation.org](https://reactnavigation.org/) or try it out on [our expo demo](https://exp.host/@react-navigation/NavigationPlayground).
|
|
|
|
## Motivation
|
|
|
|
React Navigation is born from the React Native community's need for an
|
|
extensible yet easy-to-use navigation solution. It replaces and improves
|
|
upon several navigation libraries in the ecosystem, including Ex-Navigation,
|
|
React Native's Navigator and NavigationExperimental components. React
|
|
Navigation can also be used across React and React Native projects allowing
|
|
for a higher degree of shared code.
|
|
|
|
Once stable, NavigationExperimental will be deprecated in favor of React
|
|
Navigation. React Navigation is a collaboration between people from
|
|
Facebook, Exponent and the React community at large.
|
|
|
|
## [Getting started](https://reactnavigation.org/docs/intro/)
|
|
|
|
1. Create a new React Native App
|
|
```
|
|
react-native init SimpleApp
|
|
cd SimpleApp
|
|
```
|
|
|
|
2. Install the latest version of react-navigation from npm
|
|
```
|
|
yarn add react-navigation
|
|
```
|
|
or
|
|
```
|
|
npm install --save react-navigation
|
|
```
|
|
|
|
3. Run the new app
|
|
```
|
|
react-native run-android # or:
|
|
react-native run-ios
|
|
```
|
|
|
|
## Community
|
|
|
|
We have an active channel on the [Reactiflux](https://www.reactiflux.com/) community. It's the best place to show off things you've made with the library, ask for help, or just hang out and discuss the project. This also helps keep the [issues](https://github.com/react-community/react-navigation/issues) manageable.
|
|
|
|
## Advanced guide
|
|
|
|
- [Redux integration](https://reactnavigation.org/docs/guides/redux)
|
|
- [Web integration](https://reactnavigation.org/docs/guides/web)
|
|
- [Deep linking](https://reactnavigation.org/docs/guides/linking)
|
|
- [Contributors guide](https://reactnavigation.org/docs/guides/contributors)
|
|
|
|
## React Navigation API
|
|
|
|
- [Navigators](https://reactnavigation.org/docs/navigators/)
|
|
- [Routers](https://reactnavigation.org/docs/routers/)
|
|
- [Views](https://reactnavigation.org/docs/views/)
|
|
|
|
## Helpful Resources
|
|
|
|
- [React Navigation Links](https://github.com/react-navigation/react-navigation-links)
|