〽️ MobX Router

v0.0.6 🎉 - by @thekitze

###Example usage
Demo project
Demo project repo

Inspiration

📖 How to decouple state and UI - a.k.a. you don’t need componentWillMount

##Features
- Decoupled state from UI
- Central route configuration in one file
- URL changes are triggering changes directly in the store, and vice-versa
- No need to use component lifecycle methods like ``componentWillMount` to fetch data or trigger a side effect in the store
- Supported hooks for the routes are: `beforeEnter`, `onEnter`, `beforeExit`, `onExit`. All of the hooks receive `route`, `params`, `store`, and `queryParams` as parameters. If the `beforeExit` or `beforeEnter` methods return `false` the navigation action will be prevented.
- The current URL params and query params are accessible directly in the store `store.router.params` / `store.router.queryParams` so basically they're available everywhere without any additional wrapping or HOC.
- Navigating to another view happens by calling the `goTo` method on the router store, and the changes in the url are reflected automatically. So for example you can call `router.goTo(views.book, {id:5, page:3})` and after the change is made in the store, the URL change will follow. You never directly manipulate the URL or the history object.
- `` component which also populates the href attribute and works with middle click or `cmd/ctrl` + click

$3


`js
import React from 'react';
import ReactDOM from 'react-dom';
import {Provider} from 'mobx-react';

import {MobxRouter, RouterStore, startRouter} from 'mobx-router';
import views from 'config/views';

//example mobx store
const store = {
app: {
title: 'MobX Router Example App',
user: null
},
//here's how we can plug the routerStore into our store
router: new RouterStore()
};

startRouter(views, store);

ReactDOM.render(


, document.getElementById('root')
)
`

###Example config

/config/views.js

`js
import React from 'react';

//models
import {Route} from 'mobx-router';

//components
import Home from 'components/Home';
import Document from 'components/Document';
import Gallery from 'components/Gallery';
import Book from 'components/Book';
import UserProfile from 'components/UserProfile';

const views = {
home: new Route({
path: '/',
component:
}),
userProfile: new Route({
path: '/profile/:username/:tab',
component: ,
onEnter: () => {
console.log('entering user profile!');
},
beforeExit: () => {
console.log('exiting user profile!');
},
onParamsChange: (route, params, store) => {
console.log('params changed to', params);
}
}),
gallery: new Route({
path: '/gallery',
component: ,
onEnter: (route, params, store, queryParams) => {
store.gallery.fetchImages();
console.log('current query params are -> ', queryParams);
},
beforeExit: () => {
const result = confirm('Are you sure you want to leave the gallery?');
return result;
}
}),
document: new Route({
path: '/document/:id',
component: ,
beforeEnter: (route, params, store) => {
const userIsLoggedIn = store.app.user;
if (!userIsLoggedIn) {
alert('Only logged in users can enter this route!');
return false;
}
},
onEnter: (route, params) => {
console.log(entering document with params, params);
}
}),
book: new Route({
path: '/book/:id/page/:page',
component: ,
onEnter: (route, params, store) => {
console.log(entering book with params, params);
store.app.setTitle(route.title);
}
})
};
export default views;
`

$3


- [ ] Add async support for the `beforeEnter` and `beforeExit` hooks
- [ ] Add array support for the hooks so they can execute multiple methods. A sample usage of this would be having one `isUserAuthenticated`` method that can be just plugged in as one of the callbacks triggered from the hook.