Giter VIP home page Giter VIP logo

connected-react-router's Introduction

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

v6.0.0 requires React v16.4.0 and React Redux v6.0 or later.

Connected React Router Build Status Open Source Helpers

A Redux binding for React Router v4

Main features

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

๐ŸŽ Support React Router v4.

โ˜€๏ธ 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 Redux 6.0 or later.

Using npm:

$ npm install --save connected-react-router

Or yarn:

$ yarn add connected-react-router

Usage

Step 1

  • Create a history object.
  • Create root reducer as a function that takes history as an argument and returns reducer.
  • Add router reducer into root reducer by passing history to connectRouter. Note: The key MUST be router.
  • Use routerMiddleware(history) if you want to dispatch history actions (e.g. to change URL with push('/path/to/somewhere')).
// reducers.js
import { combineReducers } from 'redux'
import { connectRouter } from 'connected-react-router'

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

// configureStore.js
...
import { createBrowserHistory } from 'history'
import { applyMiddleware, compose, createStore } from 'redux'
import { routerMiddleware } from 'connected-react-router'
import createRootReducer from './reducers'
...
const history = createBrowserHistory()

const store = createStore(
  createRootReducer(history), // root reducer with router state
  initialState,
  compose(
    applyMiddleware(
      routerMiddleware(history), // for dispatching history actions
      // ... other middlewares ...
    ),
  ),
)

Step 2

  • Wrap your react-router v4 routing with ConnectedRouter and pass the history object as a prop.
  • Place ConnectedRouter as a child of react-redux's Provider.
...
import { Provider } from 'react-redux'
import { Route, Switch } from 'react-router' // react-router v4
import { ConnectedRouter } from 'connected-react-router'
...
ReactDOM.render(
  <Provider store={store}>
    <ConnectedRouter history={history}> { /* place ConnectedRouter under Provider */ }
      <div> { /* your usual react-router v4 routing */ }
        <Switch>
          <Route exact path="/" render={() => (<div>Match</div>)} />
          <Route render={() => (<div>Miss</div>)} />
        </Switch>
      </div>
    </ConnectedRouter>
  </Provider>,
  document.getElementById('react-root')
)

Now, it's ready to work!

Examples

See the examples folder

Build

npm run build

Generated files will be in the lib folder.

Contributors

See Contributors and Acknowledge.

License

MIT License

connected-react-router's People

Contributors

abenhamdine avatar adams-brian avatar armour avatar brettm12345 avatar brneto avatar cereallarceny avatar deemoding avatar dictions avatar dimitriirybakov avatar durasj avatar jbasilio avatar joeyfigaro avatar josepot avatar judikdavid avatar lanwin avatar lazarljubenovic avatar lpillonel avatar mattvague avatar maxhawkins avatar n3tr avatar oliverjash avatar pete-otaqui avatar petetnt avatar rhuansantos avatar sgal avatar supasate avatar thomschke avatar tsekityam avatar vincentlanglet avatar wgao19 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.