/!\ The NPM location of this repository has changed /!\

Use @ibm/mobx-react-router

mobx-react-router

Keep your MobX state in sync with react-router via a RouterStore.

Router location state is observable, so any references to it in MobX components will cause the component to re-render when the location changes.

Very much inspired by (and copied from) react-router-redux.

• Installation
• Usage
• API
  • RouterStore
  • syncHistoryWithStore

This branch (master) is for use with react-router v6. Please, check the branch v5 for react-router v5.

Installation

npm install --save @ibm/mobx-react-router

/!\ npm install --save mobx-react-router is now deprecated, use npm install --save @ibm/mobx-react-router

And if you haven't installed all the peer dependencies, you should probably do that now:

1npm install --save mobx mobx-react react-router

Usage

index.js

1import React from 'react';
2import ReactDOM from 'react-dom';
3import { createBrowserHistory } from 'history';
4import { Provider } from 'mobx-react';
5import { RouterStore, syncHistoryWithStore } from '@ibm/mobx-react-router';
6import { Router } from 'react-router';
7import App from './App';
8
9const browserHistory = createBrowserHistory();
10const routingStore = new RouterStore();
11
12const stores = {
13  // Key can be whatever you want
14  routing: routingStore,
15  // ...other stores
16};
17
18const history = syncHistoryWithStore(browserHistory, routingStore);
19
20ReactDOM.render(
21  <Provider {...stores}>
22    <Router location={routingStore.location} navigator={history}>
23      <App />
24    </Router>
25  </Provider>,
26  document.getElementById('root')
27);

App.js

1import React, { Component } from 'react';
2import { inject, observer } from 'mobx-react';
3
4@inject('routing')
5@observer
6export default class App extends Component {
7  render() {
8    const { location, push, back } = this.props.routing;
9
10    return (
11      <div>
12        <span>Current pathname: {location.pathname}</span>
13        <button onClick={() => push('/test')}>Change url</button>
14        <button onClick={() => back()}>Go Back</button>
15      </div>
16    );
17  }
18}

Check our live example with Vite.js.

HashRouter

You can replace history/createBrowserHistory with history/createHashHistory in the example above to use hash routes instead of HTML5 routing.

Troubleshooting

Routes not updating correctly when URL changes

There is a known issue with React Router 4 and MobX (and Redux) where "blocker" components like those created by @observer (and @connect in Redux) block react router updates from propagating down the component tree.

To fix problems like this, try wrapping components which are being "blocked" with React Router's withRouter higher order component should help, depending on the case.

API

RouterStore

1const store = new RouterStore();

A router store instance has the following properties:

• location (observable) - history location object
• history - raw history API object

And the following history methods:

• push(path)
• replace(path)
• go(n)
• back()
• forward()

syncHistoryWithStore(history, store)

• history - A variant of a history object, usually browserHistory
• store - An instance of RouterStore

returns an enhanced history object with the following additional methods:

• subscribe(listener)
  Subscribes to any changes in the store's location observable
  Returns an unsubscribe function which destroys the listener

1const unsubscribeFromStore = history.subscribe((location, action) => console.log(location.pathname));
2
3history.push('/test1');
4unsubscribeFromStore();
5history.push('/test2');
6
7// Logs
8// 'test1'

• unsubscribe()
  Un-syncs the store from the history. The store will no longer update when the history changes

1history.unsubscribe();
2// Store no longer updates