Git Product home page Git Product logo

react-router-navigation's Introduction

react-router-navigation

Build Status npm version Am I a cool kid ? styled with prettier

react-router-navigation provides tools to navigate between multiple screens with navigators or tab views. This library is based on react-router, react-navigation, and react-native-tab-view.

Highlights

  • Just an add-on to react-router
  • Declarative composability
  • Allow you to call transitions anywhere in your code with simple components
  • Dynamic Routing
  • URL Driven Development
  • Easy-to-use navigation solution using react-navigation
  • Tab Bar Support using react-native-tab-view
  • Cross-platform
  • First class deep linking support
  • Nested Navigators

How to use

Install:

$ yarn add react-router react-router-native react-router-navigation

And then, enjoy it:

import React from 'react'
import { Text } from 'react-native'
import { NativeRouter, Link } from 'react-router-native'
import { Navigation, Card } from 'react-router-navigation'

const App = () => (
  <NativeRouter>
    <Navigation>
      <Card
        exact
        path="/"
        render={() => (
          <Link to="/hello">
            <Text>Press it</Text>
          </Link>
        )}
      />
      <Card path="/hello" render={() => <Text>Hello</Text>} />
    </Navigation>
  </NativeRouter>
)

Docs

Contributing

Want to hack on react-router-navigation? Awesome! We welcome contributions from anyone and everyone. 🚀

While developing, you can run examples app to test your changes.

Make sure the tests still pass, and your code passes Flow and ESLint. Run the following to verify:

$ yarn run bootstrap
$ yarn test

Remember to add tests for your change if possible.

Questions

If you have any questions, feel free to get in touch on Twitter, @Leo_LeBras.

Thanks

react-router-navigation is based on React Router. Thanks to Ryan Florence @ryanflorence, Michael Jackson @mjackson and all the contributors for their work on react-router and history.

Special thanks to @ericvicenti, @skevy, @satya164 and @grabbou for their work on react-navigation and @satya164 for his work on react-native-tab-view.

react-router-navigation's People

Contributors

baloran avatar charlesmangwa avatar dtupalov avatar g3z avatar leolebras avatar nansthomas avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.