react-gondoladeprecated

React Native declarative navigation

Usage no npm install needed!

<script type="module">
  import reactGondola from 'https://cdn.skypack.dev/react-gondola';
</script>

README

React Gondola → React Nonav

⚠️ WARNING: This package has been moved to React NoNav!

React Native declarative and reactive navigation.

Build Status Coverage Status NPM Downloads Commitizen friendly semantic-release


Philosophy

This repo focuses on grouping screens by business conversion tunnels called canals. Why did I call it react-gondola? Just because I though of this package when I was visiting Venice... and I kind of hope that using this package will feel like navigating in Venice 📸

When you use React Gondola, you define several screens and you have the possibility to control their visibility with YOUR state machine. You define the rules of WHEN some screens should appear; react-gondola takes care of the rest.

👍 TLDR; Use this package if:

  • you want to group screens by business conversion tunnels rather than transition.
  • you want to control your navigation state with YOUR state machine.
  • you want your navigation to react to YOUR store changes.

👎 Do not use this repo if:

  • you want to navigate imperatively.
  • you need to use Native navigation (react-gondola's navigation is powered by JS code only).

Docs

The docs are here: https://react-gondola.netlify.com/ Powered by the incredible docz.

Contribute

  • Clone this repository.
  • Run yarn in the root directory.
  • Run yarn in the example directory.
  • Add your code and its test in the <rootDir>/src directory.
  • Add your example code and its test in the <rootDir>/example directory.
  • Open a pull request !

Run the example project

  • Clone this repository.
  • Run yarn in the root directory.
  • Run yarn in the example directory.
  • In the example directory, run either react-native run-ios or react-native run-android.

Compare