react-native-navigation README

The project's README from github.com/wix/react-native-navigation. As one markdown file: README.md.

SWUbanner


React Native Navigation

NPM downloads NPM latest version NPM snapshot version NPM snapshot version

Follow on Twitter Chat on Discord StackExchange

React Native Navigation provides 100% native platform navigation on both iOS and Android for React Native apps. The JavaScript API is simple and cross-platform - just install it in your app and give your users the native feel they deserve. Ready to get started? Check out the docs.

Quick Links

Requirements

Apps using React Native Navigation may target iOS 11 and Android 5.0 (API 21). You may use Windows, macOS or Linux as your development operating system.

Installation

As react-native-navigation is a native navigation library - integrating it into your app will require editing native files. Follow the installation guides in the documentation.

react-native-navigation (wix/react-native-navigation)

Searching Database…

What is this?React Native Navigation is a navigation library for React Native apps that delegates all navigation to native platform APIs instead of re-implementing it in JavaScript, giving 100% native navigation on iOS and Android.
Is this a pure JS library or does it touch native code?It's a native navigation library: the JS API is simple and cross-platform, but under the hood it wires into native iOS and Android navigation controllers, so integrating it means editing native project files.
How do I add it to a project?You install the package and then follow the native installation guides in the documentation, since native files need to be edited on both iOS and Android.
What platform versions do I need to target?Apps must target iOS 11+ and Android 5.0 (API 21)+; development can be done from Windows, macOS, or Linux.
Is setup as easy as a typical npm package install?No — because it's a native library, you can't just `npm install` and go; you must follow platform-specific native integration steps in the docs, which is more involved than a pure-JS package.
Why use this instead of a JS-only navigation library?Because navigation is handled by native iOS/Android components directly rather than simulated in JavaScript, you get native transition performance, gestures, and look-and-feel instead of JS-driven approximations.
Does it support TypeScript?The project includes tslib as a dependency, suggesting TypeScript support, though the README doesn't give full details on type definitions.
Creator
wix
Size
202.8 MB
Stars
13.2K
Age
10y
Commits · 90 Days