Native navigation library for React Native applications
Java Swift JavaScript Ruby Other
Latest commit a8aa0b4 Mar 15, 2017 @lelandrichardson lelandrichardson committed on GitHub Merge pull request #51 from JSafaiyeh/patch-1
Updated Ruby version.
Permalink
Failed to load latest commit information.
assets Add FAQ and update install docs Mar 12, 2017
docs Update docs for OSS Mar 12, 2017
example [Android] Use the same container for all Fragments (#50) Mar 15, 2017
gradle/wrapper Moved MainActivity content into MainFragment Mar 12, 2017
lib [Android] Use the same container for all Fragments (#50) Mar 15, 2017
.babelrc Initial Implementation Mar 12, 2017
.bookignore Documentation first pass Mar 12, 2017
.eslintignore Get lint passing Mar 12, 2017
.eslintrc Get lint passing Mar 12, 2017
.flowconfig Initial Implementation Mar 12, 2017
.gitignore [iOS] Make pod install step automatic, and document dependencies Mar 15, 2017
.npmignore Initial Implementation Mar 12, 2017
.travis.yml Initial Implementation Mar 12, 2017
.watchmanconfig Initial Implementation Mar 12, 2017
CHANGELOG.md v0.1.0 Mar 14, 2017
CONTRIBUTING.md Add FAQ and update install docs Mar 12, 2017
GLOSSARY.md Documentation first pass Mar 12, 2017
Gemfile Updated Ruby version. Mar 16, 2017
Gemfile.lock [iOS] Make pod install step automatic, and document dependencies Mar 15, 2017
LICENSE Initial commit Sep 16, 2016
README.md [iOS] Make pod install step automatic, and document dependencies Mar 15, 2017
SUMMARY.md Documentation first pass Mar 12, 2017
book.json Documentation first pass Mar 12, 2017
build.gradle Depend on RN 0.42 Mar 12, 2017
gradlew Fix gradle structure Mar 12, 2017
gradlew.bat Fix gradle structure Mar 12, 2017
index.js Some iOS Example Tweaks Mar 12, 2017
native-navigation.podspec Initial restructuring of iOS project Mar 12, 2017
package.json [iOS] Make pod install step automatic, and document dependencies Mar 15, 2017
rn-cli.config.js Initial Implementation Mar 12, 2017
settings.gradle Get lint passing Mar 12, 2017

README.md

Native Navigation

npm Version License Build Status

DISCLAIMER

This project is currently in beta.

Many of the core APIs are subject to change, and we do not consider this project "Production Ready" until it hits a 1.0 release. We encourage people to try this library out and provide us feedback as we get it to a stable state we are confident in, but not to rely on it for production use until then.

Read more about our Roadmap to 1.0

Contents

Installation

See the Installation Guide

Running the Example Project

To run the example project, first clone this repo:

git clone https://github.com/airbnb/native-navigation.git
cd native-navigation

Both npm and the ruby bundler gem are needed to run the project.

npm install
npm start

Then, in another CLI window:

To run on iOS: npm run run:ios

To run on Android: npm run run:android

Guides

API Documentation

Related Projects and Alternatives

Native Navigation is a navigation library for the React Native platform. There are many navigation libraries in the React Native ecosystem. Native Navigation is unique in that it is built on top of the iOS and Android platform navigational components, and is thus more "native" than most other options which implement navigation from scratch in JavaScript on top of base React Native components like View and Animated.

React Native Navigation by Wix engineering is an alternative library that uses "Native" navigation components of each platform, and has been around longer than Native Navigation. If you need a stable / production-ready navigation library today that uses native platform based navigation components, we recommend you check this library out.

If you are investigating navigation solutions and you are okay with JavaScript-based solutions, we also encourage you to check out React Navigation.

Contributing

See the Contributors Guide

FAQ

See the Frequently Asked Questions page

License

This project is licensed under the MIT License.