Skip to content
Get packs

Guide · Open source

How to use react-native-navigation: setup and basics

Updated · written with AI from the project's own documentation and checked against our catalogue data

React Native Navigation is an open-source library that moves users between screens in React Native apps using the platform's own native navigation components on iOS and Android. This guide explains what it is, what it requires, how setup works and when it is the right choice. By the end you will know whether your project fits it and what to prepare before installing.

React Native Navigationwix/react-native-navigation · ★ 13.2k · MIT

Quick start

  1. 1Check requirements. Confirm your app targets iOS 11 or later and Android 5.0 (API 21) or later.
  2. 2Confirm you can edit native files. Installation requires changes to native project files, so make sure your team is ready for that.
  3. 3Read the official docs. Open the installation guides at wix.github.io/react-native-navigation and follow them for your platforms.
  4. 4Clone the repository for reference. Run git clone https://github.com/wix/react-native-navigation to review the source.
  5. 5Set up navigation in your app. Follow the documented steps to integrate the library and define your screens.
  6. 6Test on both platforms. Run your app on iOS and Android to confirm transitions match platform conventions.

What react-native-navigation does

React Native Navigation provides native platform navigation on both iOS and Android for React Native apps. According to its README, the JavaScript API is simple and cross-platform, so the same navigation code works on both platforms.

It is aimed at developers who want navigation that feels native rather than navigation drawn entirely in JavaScript.

Check the requirements before you start

The README says apps using React Native Navigation may target iOS 11 and Android 5.0 (API 21). You can develop on Windows, macOS or Linux.

  • Target iOS 11 or later
  • Target Android 5.0 (API 21) or later
  • Develop on Windows, macOS or Linux

Install react-native-navigation in your app

The README notes that react-native-navigation is a native navigation library, so integrating it requires editing native files. Installation steps are in the official documentation, which the README links to.

The README's install reference is to clone the repository. Use it to look at the source and examples; for app integration, follow the documentation guides.

  • Read the installation guides in the documentation before editing any project files
  • Be prepared to change native iOS and Android project files
git clone https://github.com/wix/react-native-navigation

Decide whether it fits your project

The library suits teams that need screen transitions and navigation matching iOS and Android conventions, and developers comfortable editing native project files during setup.

A lighter JavaScript-only router may be less work if you only need simple navigation. React Navigation and Expo Router are the comparable projects named in this analysis.

  • Good fit: native-feeling transitions, apps that must follow platform conventions, teams comfortable with native files
  • Probably not a fit: beginners new to React Native, or projects needing only simple JavaScript navigation

Where to find more detail

The official documentation at wix.github.io/react-native-navigation covers installation guides and the full API. The changelog, Stack Overflow tag and Discord chat are linked from the README for troubleshooting and questions.

  • Documentation: wix.github.io/react-native-navigation
  • Changelog on GitHub
  • Stack Overflow tag: wix-react-native-navigation
  • Discord community chat

What people use it for

  • Apps that must match iOS and Android navigation conventions
  • Screen transitions that should feel like native platform navigation
  • Teams that already work comfortably with native project files

Frequently asked questions

Is react-native-navigation free to use?

Yes, it is released under the MIT licence. The MIT licence permits use, modification and distribution, subject to its terms.

What are the requirements for react-native-navigation?

The README says apps may target iOS 11 and Android 5.0 (API 21). You can develop on Windows, macOS or Linux.

How do I install react-native-navigation?

The README says integration requires editing native files and points to the installation guides in the official documentation. The README's listed command clones the repository.

Is react-native-navigation beginner friendly?

The README indicates it requires editing native files, so the library is aimed at developers comfortable with that. Beginners may find a JavaScript-only router easier.

What are alternatives to react-native-navigation?

This analysis lists React Navigation and Expo Router as comparable projects. A lighter JavaScript-only router may suit simpler apps.

Where can I get help if setup fails?

The README links to the documentation, a Stack Overflow tag named wix-react-native-navigation, and a Discord chat for questions.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Choose react-native-navigation if you want native-feeling transitions and your team can edit native iOS and Android project files. If you are new to React Native or only need simple JavaScript navigation, a lighter router such as React Navigation or Expo Router is likely less work.

Install options & downloads