-
-
Notifications
You must be signed in to change notification settings - Fork 10.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Redux Integration #4668
Redux Integration #4668
Changes from all commits
9bba6fc
d296fa9
f5a69b9
a1cfec6
7b65c6b
58fa088
1a3fd03
cdf5ff1
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"lerna": "2.0.0-beta.32", | ||
"version": "4.0.0-beta.8", | ||
"version": "independent", | ||
"packages": [ | ||
"packages/*" | ||
] | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
{ | ||
"presets": [ | ||
"./tools/es2015-preset", | ||
"stage-1", | ||
"react" | ||
], | ||
"env": { | ||
"production": { | ||
"plugins": [ | ||
"transform-react-remove-prop-types" | ||
] | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
{ | ||
"parser": "babel-eslint", | ||
"env": { | ||
"node": true, | ||
"es6": true, | ||
"jest": true | ||
}, | ||
"plugins": [ | ||
"import", | ||
"react" | ||
], | ||
"extends": [ | ||
"eslint:recommended", | ||
"plugin:import/errors", | ||
"plugin:react/recommended" | ||
], | ||
"rules": { | ||
"prefer-arrow-callback": 2, | ||
"react/display-name": 0, | ||
"semi": [ 2, "never" ] | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
es | ||
node_modules | ||
umd | ||
/*.js | ||
!rollup.config.js |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# react-router-redux | ||
|
||
[![npm version](https://img.shields.io/npm/v/react-router-redux.svg?style=flat-square)](https://www.npmjs.com/package/react-router-redux) [![npm downloads](https://img.shields.io/npm/dm/react-router-redux.svg?style=flat-square)](https://www.npmjs.com/package/react-router-redux) [![build status](https://img.shields.io/travis/reactjs/react-router-redux/master.svg?style=flat-square)](https://travis-ci.org/reactjs/react-router-redux) | ||
|
||
> **Keep your state in sync with your router** :sparkles: | ||
|
||
|
||
## Installation | ||
|
||
``` | ||
npm install --save react-router-redux | ||
``` | ||
|
||
## Usage | ||
|
||
Here's a basic idea of how it works: | ||
|
||
```js | ||
import React from 'react' | ||
import ReactDOM from 'react-dom' | ||
|
||
import { createStore, combineReducers, applyMiddleware } from 'redux' | ||
import { Provider } from 'react-redux' | ||
|
||
import createHistory from 'history/createBrowserHistory' | ||
import { Route } from 'react-router' | ||
|
||
import { ConnectedRouter, routerReducer, routerMiddleware, push } from 'react-router-redux' | ||
|
||
import reducers from './reducers' // Or wherever you keep your reducers | ||
|
||
// Create a history of your choosing (we're using a browser history in this case) | ||
const history = createHistory() | ||
|
||
// Build the middleware for intercepting and dispatching navigation actions | ||
const middleware = routerMiddleware(history) | ||
|
||
// Add the reducer to your store on the `router` key | ||
// Also apply our middleware for navigating | ||
const store = createStore( | ||
combineReducers({ | ||
...reducers, | ||
router: routerReducer | ||
}), | ||
applyMiddleware(middleware) | ||
) | ||
|
||
// Now you can dispatch navigation actions from anywhere! | ||
// store.dispatch(push('/foo')) | ||
|
||
ReactDOM.render( | ||
<Provider store={store}> | ||
{ /* ConnectedRouter will use the store from Provider automatically */ } | ||
<ConnectedRouter history={history}> | ||
<div> | ||
<Route exact path="/" component={Home}/> | ||
<Route path="/about" component={About}/> | ||
<Route path="/topics" component={Topics}/> | ||
</div> | ||
</ConnectedRouter> | ||
</Provider>, | ||
document.getElementById('root') | ||
) | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
import React, { Component, PropTypes } from 'react' | ||
import { Router, Route } from 'react-router' | ||
|
||
import { LOCATION_CHANGE } from './reducer' | ||
|
||
class ConnectedRouter extends Component { | ||
static propTypes = { | ||
store: PropTypes.object, | ||
history: PropTypes.object, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I wasn't sure if we wanted to provide a reasonable default here (create a browser history if none provided) or set up prefab There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. My personal opinion as an end-user is to serve prefab exports, this avoids me on my end having to put a reference to the history module and init it and pass it in. It also means I dont need a dependency in my package to history (I know I could ignore it, but then some of my tools throw warnings) -- and personally you guys are better equipped to keep those dependencies updated along side react-router. Just my 2¢ |
||
children: PropTypes.node | ||
} | ||
|
||
static contextTypes = { | ||
store: PropTypes.object | ||
} | ||
|
||
render() { | ||
const { store:propsStore, history, children, ...props } = this.props | ||
let store = propsStore || this.context.store | ||
|
||
return ( | ||
<Router {...props} history={history}> | ||
<Route render={({ location }) => { | ||
store.dispatch({ | ||
type: LOCATION_CHANGE, | ||
payload: location | ||
}) | ||
|
||
return children | ||
}}/> | ||
</Router> | ||
) | ||
} | ||
} | ||
|
||
export default ConnectedRouter |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
import React from 'react' | ||
import renderer from 'react-test-renderer' | ||
import { createStore, combineReducers } from 'redux' | ||
import { Provider } from 'react-redux' | ||
import createHistory from 'history/createMemoryHistory' | ||
|
||
import ConnectedRouter from '../ConnectedRouter' | ||
import { routerReducer } from '../reducer' | ||
|
||
describe('A <ConnectedRouter>', () => { | ||
let store, history | ||
|
||
beforeEach(() => { | ||
store = createStore(combineReducers({ | ||
router: routerReducer | ||
})) | ||
|
||
history = createHistory() | ||
}) | ||
|
||
it('connects to a store via Provider', () => { | ||
expect(store.getState()).toHaveProperty('router.location', null) | ||
|
||
renderer.create( | ||
<Provider store={store}> | ||
<ConnectedRouter history={history}> | ||
<div>Test</div> | ||
</ConnectedRouter> | ||
</Provider> | ||
) | ||
|
||
expect(store.getState()).toHaveProperty('router.location.pathname') | ||
}) | ||
|
||
it('connects to a store via props', () => { | ||
expect(store.getState()).toHaveProperty('router.location', null) | ||
|
||
renderer.create( | ||
<ConnectedRouter store={store} history={history}> | ||
<div>Test</div> | ||
</ConnectedRouter> | ||
) | ||
|
||
expect(store.getState()).toHaveProperty('router.location.pathname') | ||
}) | ||
|
||
it('updates the store with location changes', () => { | ||
renderer.create( | ||
<ConnectedRouter store={store} history={history}> | ||
<div>Test</div> | ||
</ConnectedRouter> | ||
) | ||
|
||
expect(store.getState()).toHaveProperty('router.location.pathname', '/') | ||
|
||
history.push('/foo') | ||
|
||
expect(store.getState()).toHaveProperty('router.location.pathname', '/foo') | ||
}) | ||
}) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
import { | ||
CALL_HISTORY_METHOD, | ||
push, replace, go, goBack, goForward | ||
} from '../actions' | ||
|
||
describe('routerActions', () => { | ||
|
||
describe('push', () => { | ||
it('creates actions', () => { | ||
expect(push('/foo')).toEqual({ | ||
type: CALL_HISTORY_METHOD, | ||
payload: { | ||
method: 'push', | ||
args: [ '/foo' ] | ||
} | ||
}) | ||
|
||
expect(push({ pathname: '/foo', state: { the: 'state' } })).toEqual({ | ||
type: CALL_HISTORY_METHOD, | ||
payload: { | ||
method: 'push', | ||
args: [ { | ||
pathname: '/foo', | ||
state: { the: 'state' } | ||
} ] | ||
} | ||
}) | ||
|
||
expect(push('/foo', 'baz', 123)).toEqual({ | ||
type: CALL_HISTORY_METHOD, | ||
payload: { | ||
method: 'push', | ||
args: [ '/foo' , 'baz', 123 ] | ||
} | ||
}) | ||
}) | ||
}) | ||
|
||
describe('replace', () => { | ||
it('creates actions', () => { | ||
expect(replace('/foo')).toEqual({ | ||
type: CALL_HISTORY_METHOD, | ||
payload: { | ||
method: 'replace', | ||
args: [ '/foo' ] | ||
} | ||
}) | ||
|
||
expect(replace({ pathname: '/foo', state: { the: 'state' } })).toEqual({ | ||
type: CALL_HISTORY_METHOD, | ||
payload: { | ||
method: 'replace', | ||
args: [ { | ||
pathname: '/foo', | ||
state: { the: 'state' } | ||
} ] | ||
} | ||
}) | ||
}) | ||
}) | ||
|
||
describe('go', () => { | ||
it('creates actions', () => { | ||
expect(go(1)).toEqual({ | ||
type: CALL_HISTORY_METHOD, | ||
payload: { | ||
method: 'go', | ||
args: [ 1 ] | ||
} | ||
}) | ||
}) | ||
}) | ||
|
||
describe('goBack', () => { | ||
it('creates actions', () => { | ||
expect(goBack()).toEqual({ | ||
type: CALL_HISTORY_METHOD, | ||
payload: { | ||
method: 'goBack', | ||
args: [] | ||
} | ||
}) | ||
}) | ||
}) | ||
|
||
describe('goForward', () => { | ||
it('creates actions', () => { | ||
expect(goForward()).toEqual({ | ||
type: CALL_HISTORY_METHOD, | ||
payload: { | ||
method: 'goForward', | ||
args: [] | ||
} | ||
}) | ||
}) | ||
}) | ||
|
||
}) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
import { push, replace } from '../actions' | ||
import routerMiddleware from '../middleware' | ||
|
||
describe('routerMiddleware', () => { | ||
let history, next, dispatch | ||
|
||
beforeEach(() => { | ||
history = { | ||
push: jest.fn(), | ||
replace: jest.fn() | ||
} | ||
next = jest.fn() | ||
|
||
dispatch = routerMiddleware(history)()(next) | ||
}) | ||
|
||
|
||
it('calls the appropriate history method', () => { | ||
dispatch(push('/foo')) | ||
expect(history.push).toHaveBeenCalled() | ||
|
||
dispatch(replace('/foo')) | ||
expect(history.replace).toHaveBeenCalled() | ||
|
||
expect(next).toHaveBeenCalledTimes(0) | ||
}) | ||
|
||
it('ignores other actions', () => { | ||
dispatch({ type: 'FOO' }) | ||
expect(next).toHaveBeenCalled() | ||
}) | ||
}) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done as a separate commit (d296fa9) so we can revert easily.