❤
npm
Sign UpSign In

react-routes-dub

1.5.1 • Public • Published

react-routes-dub

Stupid-easy React routing for the browser in 200 lines of code and with a single dependency.

That single dependency is important. path-to-regexp is used by Express to parse path strings, and now you can use it for your client-side routes.

Why you might use it:

  • All configuration takes place in a single file, using plain JS.
  • Uses the React Context API for minimum fuss.
  • Routes are named, as they should be.

Why you might skip it:

  • Browser only. Not for React Native, React VR, or anything else like that.

Installation

yarn add react-routes-dub

or

npm install --save react-routes-dub

Usage

Define your routes with a single file:

// routes.js
 
import routesDub from 'react-routes-dub';
 
export const {
  DubProvider,
  Link,
  Route,
  pathFor 
} = routesDub([
  {
    name: 'home',
    pattern: '/'
  },
  {
    name: 'pet',
    pattern: 'pets/:petId',
    onEnter: ({ params }) => {
      loadPetData(params.petId);
    },
    routes: [
      {
        name: 'toys',
        pattern: 'toys'
      }
    ]
  }
]);
 

Now everything you need to begin routing is immediately available.

// app.jsx
 
import React, { Component } from 'react';
import { DubProvider, Link, Route } from './routes';
 
class App extends Component {
  render () {
    return (
      <DubProvider>
        <Link to='home'>Home</Link>
        <Link to='pet' params={ { petId: 'dog-1' } }>See Dog One</Link>
        <Link to='pet' params={ { petId: 'dog-2' } }>See Dog Two</Link>
        <Link to='pet.toys' params={ { petId: 'dog-1' } }>See Dog One's Toys</Link>
        <Route is='home'>
          <p>Welcome home.</p>
        </Route>
        <Route is='pet'>
          { ({ params }) => {
            // route parameters are available here
            return (
              <p>Pet ID here: { params.petId }</p>
            )
          } }
        </Route>
        <Route is='pet.toys'>
          <p>Pet Toys!</p>
        </Route>
      </DubProvider>
    );
  }
}

That's it! You're done.

See ./test for a complete example.

Readme

Keywords

Package Sidebar

Install

npm i react-routes-dub

Repository

github.com/bugeats/react-routes-dub

Homepage

github.com/bugeats/react-routes-dub#readme

Weekly Downloads

5

Version

1.5.1

License

MIT

Unpacked Size

12 kB

Total Files

8

Last publish

Collaborators

  • bugeats
Try on RunKit
Report malware