redux-regexp-router v0.4.1

Redux Regexp Router

Declarative routing for React Redux using RegExps as patterns.

• Nested routing
• Relative links
• Regexp patterns

Installation

npm install --save redux-regexp-router

How to use

1. Add routeReducers to your Store
2. Wrap your app to History component
3. Use Route's

import ReactDom from 'react-dom';
import { combineReducers, createStore } from 'redux';

import { routeReducers, createHistory, HashHistory } from 'redux-regexp-router';

let store = createStore(combineReducers({ ...routeReducers, yourAppReducers }));
ReactDom.render(
    <Provider store={store}>
        <HashHistory>
            <div>
                <ul>
                    <li><Link to="/link1">To Link1</Link></li>
                    <li><Link to="/link2">To Link2</Link></li>
                    <li><Link to="/link3">To Link3</Link></li>
                </ul>
                
                <h4>Result</h4>
                <Route path="^link1">
                    <div>Link1</div>
                </Route>
                <Route path="^link2">
                    <div>Link2</div>
                </Route>
                <Route path="^link3">
                    <div>Link2</div>
                </Route>
            </div>
        </HashHistory>
    </Provider>
    , document.getElementById('app'));

Nested Routes

Just put one Route to another.

...
    <ul>
        <li><Link to="/link1">To Link1</Link></li>
        <li><Link to="/link1/1">To Link1 / 1</Link></li>
        <li><Link to="/link2">To Link2</Link></li>
    </ul>
    
    <h4>Result</h4>
    <Route path="^link1">
        <div>Link1</div>
        <Route path="^1">
            <div>SubRoute</div>
        </Route>
    </Route>
    <Route path="^link2">
        <div>Link2</div>
    </Route>
...

Switch routing

You can place many routes in one section. First matched route will display.

...
    <Switch>
        <Route path="^path123/"><span>path123</span></Route>
        <Route path="^path12/"><span>path12</span></Route>
        <Route path="^path1/"><span>path12</span></Route>
        <Route><span>not found</span></Route>
    </Switch>
...

Relative links

You can pass relative link to Link component. This link have an adress based on Route location.

...
    <Route path="^about/">
        <Link to="company">Company</Link>
    </Route>
...

Link will have an address: /about/company. To absolute link just add / at first.

Patterns / Path

Path matching based on RegExp. Also you can set kwargs for your routes.

    <Route path="^products/(id=\d+)/$" component={<Product/>}/>
    <Route path="^products/(slug=\w+)/$" component={<Product/>}/>
    <Route path="^products/(category=\w+)/(id=\d+)/$" component={<Product/>}/>

• ^products/(id=\d+)/$ - id kwarg with digits
• ^products/(slug=\w+)/$ - slug kwarg with 0-9a-z_
• ^products/(category=\w+)/(id=\d+)/$ - creates category and id kwargs

Access to Kwargs

By Props

Child component of Route will have this.props.kwargs

By Store

Connect your component to reducer routeKwargs. RouteKwargs contain kwargs by Routes. Key is a concatenate of nested routes path or name .

<Route path="^link1/(id=\d+)" name="link1">
    <div>Link1</div>
    <Route path="^(id=\d+)" name="sublink">
        <div>SubRoute</div>
    </Route>
</Route>

routeKwargs state by url /link1/1/2/:

{
  "link1": {
    "id": "1"
  },
  "link1/sublink": {
    "id": "2"
  }
}

By Context

Use helper addRoutingContext to add Context. After this you can get kwargs based on current route of your component. To get kwargs use: this.context.getRouteKwargs()

Absolute Routes

If you need, you can create Route ignoring parent location, just add absolute prop. url: /test/nested/test

    <Route path="^test/">
        <Route path="^nested">Will show</Route>
        <Route path="^test/nes" absolute>Will Show too, becouse absolute</Route>
    </Route>