callstackincubator / rebolt-navigation

Fast and declarative router for Rebolt
https://rebolt-navigation.callstack.com/
MIT License
208 stars 11 forks source link
react-native reasonml

Rebolt Navigation

Build Status Version MIT License PRs Welcome Chat

a fast, declarative navigation for react native

We're looking forward to seeing your feedback or questions on Discord

Getting started

Rebolt Navigation website

Installation

Open a Terminal in your project's folder and run,

yarn add rebolt-navigation

After installation, you will need to add this library to your bsconfig.json dependencies

"bs-dependencies": [
  "reason-react",
  "rebolt-navigation"
],

In addition you will need to install a few peer dependencies:

yarn add rebolt react-native-gesture-handler

As per this issue, you might need to add the following to your bsconfig.json:


"package-specs": {
  "module": "commonjs",
  "in-source": true
}

This generates output alongside source files. (documentation)

Usage

View the docs

Examples

Developing

# Starts Metro (React Native Packager)
npm run start-example

# Runs the app on iOS/Android
npm run run-ios

# Watches for source build changes
npm start

License

MIT (c) 2018 Callstack