https://github.com/mosch/react-navigator

A react version of the react-native Navigator
https://github.com/mosch/react-navigator

Last synced: 2 months ago
JSON representation

A react version of the react-native Navigator

• Host: GitHub
• URL: https://github.com/mosch/react-navigator
• Owner: mosch
• License: mit
• Created: 2015-06-15T09:44:55.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-06-15T09:52:12.000Z (over 9 years ago)
• Last Synced: 2024-08-29T18:37:14.768Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 133 KB
• Stars: 8
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-navigator

This is a react version of the [react-native navigator](https://facebook.github.io/react-native/docs/navigator.html) used in apps. 

We use this to implement the same navigating behavior in iOS and Web.

** This is a work in progress. No way to use this in production. Contributions welcome.** 

*Documentation stolen from react-native by Facebook:*

## Navigator Methods 

If you have a ref to the Navigator element, you can invoke several methods on it to trigger navigation:

### Implemented

* getCurrentRoutes() - returns the current list of routes

* jumpBack() - Jump backward without unmounting the current scene

* push(route) - Navigate forward to a new scene, squashing any scenes that you could jumpForward to

* pop() - Transition back and unmount the current scene

* popToTop() - Pop to the first scene in the stack, unmounting every other scene

### TBD

* popToRoute(route) - Pop to a particular scene, as specified by it's route. All scenes after it will be unmounted

* replace(route) - Replace the current scene with a new route

* replaceAtIndex(route, index) - Replace a scene as specified by an index

* replacePrevious(route) - Replace the previous scene

* immediatelyResetRouteStack(routeStack) - Reset every scene with an array of routes

* jumpForward() - Jump forward to the next scene in the route stack

* jumpTo(route) - Transition to an existing scene without unmounting