react-navigation/README.md

56 lines
1.9 KiB
Markdown
Raw Normal View History

# React Navigation [![CircleCI](https://circleci.com/gh/react-community/react-navigation/tree/master.svg?style=shield&circle-token=622fcb1d78413084c2f44699ed2104246a177485)](https://circleci.com/gh/react-community/react-navigation/tree/master) [![npm version](https://badge.fury.io/js/react-navigation.svg)](https://badge.fury.io/js/react-navigation)
*Learn once, navigate anywhere.*
Browse the docs on [reactnavigation.org](https://reactnavigation.org/).
## 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.
2017-03-03 12:32:59 -03:00
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
```
## 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/)