Skip to content

A universal native-feeling React router for web, native and server-side rendering

Notifications You must be signed in to change notification settings

Aloompa/react-universal-router

Repository files navigation

React Universal Router

Create Route Redux Store

import { combineReducers } from 'redux';
import { createStore } from 'redux';
import queryStringAdapter from '@aloompa/react-universal-router/lib/adapters/queryStringAdapter';
import { routerReducer } from '@aloompa/react-universal-router/lib';

const combinedReducers = combineReducers({
    router: routerReducer({
        initialRoute: 'Home',
        adapter: queryStringAdapter
    })
});

const store = createStore(combinedReducers);

export default store; 

Define your routes

import { createRoutes, withRouter } from '@aloompa/react-universal-router/lib';

const Routes = createRoutes({
    routes: {
        Home: {
            route: Component,
            getTitle: () => 'Home'
        },
        AnotherRoute: {
            route: AnotherComponent,
            getTitle: () => 'Another Page'
        },
        // routes with modal as the mode don't get added to the history stack.
        ModalRoute: {
            route: ModalComponent,
            getTitle: () => 'Modal Page',
            mode: 'modal'
        }
    },
    renderTopNav: NavComponent
});

export default withRouter(Routes);

Add them to your root

import * as React from 'react';

import { Provider } from 'react-redux'
import Routes from './Routes';
import store from './store';

const App = () => (
    <Provider store={store}>
        <Routes />
    </Provider>
);

Push View

props.setRoute({
    route: 'AnotherRoute',
    params: {}
});
props.setRoute({
    route: 'AnotherRoute',
    params: {
        navigationTitle: 'Some Navigation Title'
    }
});
  • pushing a view with a specific title

Pop View

props.navigateBack();

Example

  • yarn run server

Open example project

Contributing

We encourage you to contribute to React Universal Router by submitting bug reports and pull requests through Github.

License

React Universal Router is released under The MIT License (MIT)

Copyright (c) [2015] [Aloompa LLC]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A universal native-feeling React router for web, native and server-side rendering

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published