@hh.ru/connected-react-router

当前版本: 6.5.4


@hh.ru/connected-react-router是什么?

一个React Router v4和v5的Redux绑定
A Redux binding for React Router v4 and v5

许可协议

MIT

关键词

react , react-router , redux

安装方式

npm install @hh.ru/connected-react-router@6.5.4

相关网址


@hh.ru/connected-react-router使用说明

Breaking change in v5.0.0! Please read How to migrate from v4 to v5/v6.

v6.0.0 requires React v16.4.0 and React Redux v6.0 / v7.0.

Connected React Router Build Status Open Source Helpers

A Redux binding for React Router v4 and v5

Main features (主要功能)

Synchronize router state with redux store through uni-directional flow (i.e. history -> store -> router -> components).

🎁 Support React Router v4 and v5.

☀️ Support functional component hot reloading while preserving state (with react-hot-reload).

🎉 Dispatching of history methods (push, replace, go, goBack, goForward) works for both redux-thunk and redux-saga.

⛄️ Nested children can access routing state such as the current location directly with react-redux's connect.

🕘 Support time traveling in Redux DevTools.

💎 Support Immutable.js

💪 Support TypeScript

Installation (安装)

Connected React Router requires React 16.4 and React Redux 6.0 or later.

$ npm install --save connected-react-router

Or

$ yarn add connected-react-router

Usage (用法)

Step 1 (第一步)

In your root reducer file,

  • Create a function that takes history as an argument and returns a root reducer.
  • Add router reducer into root reducer by passing history to connectRouter.
  • Note: The key MUST be router.
// reducers.js
import { combineReducers } from 'redux'
import { connectRouter } from 'connected-react-router'

export default (history) => combineReducers({
  router: connectRouter(history),
  ... // rest of your reducers
})
Step 2 (第二步)

When creating a Redux store,

  • Create a history object.
  • Provide the created history to the root reducer creator.
  • Use routerMiddleware(history) if you want to dispatch history actions (e.g. to change URL with push('/path/to/somewhere')).
// configureStore.js
...
import { createBrowserHistory } from 'history'
import { applyMiddleware, compose, createStore } from 'redux'
import { routerMiddleware } from 'connected-react-router'
import createRootReducer from './reducers'
...
export const history = createBrowserHistory()

export default function configureStore(preloadedState) {
  const store = createStore(
    createRootReducer(history), // root reducer with router state
    preloadedState,
    compose(
      applyMiddleware(
        routerMiddleware(history), // for dispatching history actions
        // ... other middlewares ...
      ),
    ),
  )

  return store
}
Step 3 (第三步)
  • Wrap your react-router v4/v5 routing with ConnectedRouter and pass the history object as a prop. Remember to delete any usage of BrowserRouter or NativeRouter as leaving this in will cause problems synchronising the state.
  • Place ConnectedRouter as a child of react-redux's Provider.
  • N.B. If doing server-side rendering, you should still use the StaticRouter from react-router on the server.
// index.js
...
import { Provider } from 'react-redux'
import { Route, Switch } from 'react-router' // react-router v4/v5
import { ConnectedRouter } from 'connected-react-router'
import configureStore, { history } from './configureStore'
...
const store = configureStore(/* provide initial state if any */)

ReactDOM.render(
  <Provider store={store}>
    <ConnectedRouter history={history}> { /* place ConnectedRouter under Provider */ }
      <> { /* your usual react-router v4/v5 routing */ }
        <Switch>
          <Route exact path="/" render={() => (<div>Match</div>)} />
          <Route render={() => (<div>Miss</div>)} />
        </Switch>
      </>
    </ConnectedRouter>
  </Provider>,
  document.getElementById('react-root')
)

Note: the history object provided to router reducer, routerMiddleware, and ConnectedRouter component must be the same history object.

Now, it's ready to work!

Examples (示例)

See the examples folder

FAQ (常见问题解答)

Build (构建)

npm run build

Generated files will be in the lib folder.

Development (发展)

When testing the example apps with npm link or yarn link, you should explicitly provide the same Context to both Provider and ConnectedRouter to make sure that the ConnectedRouter doesn't pick up a different ReactReduxContext from a different node_modules folder.

In index.js.

...
import { Provider, ReactReduxContext } from 'react-redux'
...
      <Provider store={store} context={ReactReduxContext}>
        <App history={history} context={ReactReduxContext} />
      </Provider>
...

In App.js,

...
const App = ({ history, context }) => {
  return (
    <ConnectedRouter history={history} context={context}>
      { routes }
    </ConnectedRouter>
  )
}
...

Contributors (贡献者)

See Contributors and Acknowledge.

License (许可)

MIT License

项目热度

项目信息

分享到

基本信息
开发语言
JavaScript
相关项目
0
相关仓库
0
Watchers
40
Stars
4.22K
Forks
518
版本数量
3
最新发布
2019-11-15
首次发布
2019-11-12
仓库大小
3.02 MB

版本历史
6.5.4
2019-11-15
6.5.3
2019-11-12
6.5.2
2019-11-12

贡献者
Supasate Choochaisri Thanik Bhongbhibhat Joey Figaro thomschke Brendon Pagano Brett Mandler Sergey Galchenko Ian Williams Chong Guo Oden Oliver Joseph Ash Jakub Ďuraš Dimitrii Rybakov Brian Adams goszczynskip Leonardo Salgueiro Anthony Gonzales Patrick Cason Steve Wagner Christian Flach Arnaud Benhamdine Pete Nykänen Luca Pillonel Berchris Requiao