Use @ibm/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.
This branch (master) is for use with react-router v6. Please, check the branch v5 for react-router v5.
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:
npm install --save mobx mobx-react react-routerAlthough, mobx v6 deprecated decorators, this library still requires to enable them.
Below is an example of configuration using vite.js:
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';
export default defineConfig({
target: 'es2015',
plugins: [
react({
babel: {
plugins: [
['@babel/plugin-proposal-decorators', { legacy: true }],
],
},
}),
],
});
For more details, please consult the documentation of mobx v6 on decorators.
index.js
import React from 'react';
import ReactDOM from 'react-dom';
import { createBrowserHistory } from 'history';
import { Provider } from 'mobx-react';
import { RouterStore, syncHistoryWithStore } from '@ibm/mobx-react-router';
import { Router } from 'react-router';
import App from './App';
const browserHistory = createBrowserHistory();
const routingStore = new RouterStore();
const stores = {
// Key can be whatever you want
routing: routingStore,
// ...other stores
};
const history = syncHistoryWithStore(browserHistory, routingStore);
ReactDOM.render(
<Provider {...stores}>
<Router location={routingStore.location} navigator={history}>
<App />
</Router>
</Provider>,
document.getElementById('root')
);App.js
import React, { Component } from 'react';
import { inject, observer } from 'mobx-react';
@inject('routing')
@observer
export default class App extends Component {
render() {
const { location, push, back } = this.props.routing;
return (
<div>
<span>Current pathname: {location.pathname}</span>
<button onClick={() => push('/test')}>Change url</button>
<button onClick={() => back()}>Go Back</button>
</div>
);
}
}Check our live example.
You can replace history/createBrowserHistory with history/createHashHistory in the example above to use hash routes instead of HTML5 routing.
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.
const store = new RouterStore();A router store instance has the following properties:
location(observable) - history location objecthistory- raw history API object
And the following history methods:
- push(path)
- replace(path)
- go(n)
- back()
- forward()
history- A variant of a history object, usuallybrowserHistorystore- An instance ofRouterStore
returns an enhanced history object with the following additional methods:
- subscribe(listener)
Subscribes to any changes in the store'slocationobservable
Returns an unsubscribe function which destroys the listener
const unsubscribeFromStore = history.subscribe((location, action) => console.log(location.pathname));
history.push('/test1');
unsubscribeFromStore();
history.push('/test2');
// Logs
// 'test1'- unsubscribe()
Un-syncs the store from the history. The store will no longer update when the history changes
history.unsubscribe();
// Store no longer updates
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent