npmpackage.info

Gathering detailed insights and metrics for connected-react-router

Other packages similar to connected-react-router

@talend/router-bridge

2.2.0

Bridge on top of cmf-router or react-router v5 + connected-react-router

fusion-plugin-connected-react-router

2.4.8

The `fusion-plugin-connected-react-router` package provides plugin to integrate connected-react-router with your app.

connected-next-router

5.0.0

A Redux binding for Next.js Router

redux-first-history

5.2.0

Redux First History - Redux history binding support react-router - @reach/router - wouter

Gathering detailed insights and metrics for connected-react-router

connected-react-router

A Redux binding for React Router v4

6.9.3

4,726

MIT

JavaScript

130,716,981 3.2

Installations

npm install connected-react-router

Pull Requests

Open

29

Total

300

Closed

44

Merged

227

Issues

Open

146

Total

316

Closed

170

Releases

v6.9.3

Published on 11 Jul 2022

v6.9.2

Published on 28 Nov 2021

v6.9.1

Published on 22 Feb 2021

v6.9.0

Published on 22 Feb 2021

v6.8.0

Published on 15 Mar 2020

v6.7.0

Published on 09 Feb 2020

View all 47 releases

Developer

supasate

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

13.11.0

NPM Version

6.13.7 Statistics

4,726 Stars

485 Commits

593 Forks

42 Watching

24 Branches

77 Contributors

Updated on 11 Nov 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

130,716,981

Last day

2.6%

72,115

Compared to previous day

Last week

6.1%

366,968

Compared to previous week

Last month

11.9%

1,492,929

Compared to previous month

Last year

-20.5%

18,883,113

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

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

A Redux binding for React Router v4 and v5

Main features

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

:gift: Supports React Router v4 and v5.

:sunny: Supports functional component hot reloading while preserving state (with react-hot-reload).

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

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

:clock9: Supports time traveling in Redux DevTools.

:gem: Supports Immutable.js

:muscle: Supports TypeScript

Installation

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

npm install --save connected-react-router

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.

1// reducers.js
2import { combineReducers } from 'redux'
3import { connectRouter } from 'connected-react-router'
4
5const createRootReducer = (history) => combineReducers({
6  router: connectRouter(history),
7  ... // rest of your reducers
8})
9export default createRootReducer

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')).

1// configureStore.js
2...
3import { createBrowserHistory } from 'history'
4import { applyMiddleware, compose, createStore } from 'redux'
5import { routerMiddleware } from 'connected-react-router'
6import createRootReducer from './reducers'
7...
8export const history = createBrowserHistory()
9
10export default function configureStore(preloadedState) {
11  const store = createStore(
12    createRootReducer(history), // root reducer with router state
13    preloadedState,
14    compose(
15      applyMiddleware(
16        routerMiddleware(history), // for dispatching history actions
17        // ... other middlewares ...
18      ),
19    ),
20  )
21
22  return store
23}

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.

1// index.js
2...
3import { Provider } from 'react-redux'
4import { Route, Switch } from 'react-router' // react-router v4/v5
5import { ConnectedRouter } from 'connected-react-router'
6import configureStore, { history } from './configureStore'
7...
8const store = configureStore(/* provide initial state if any */)
9
10ReactDOM.render(
11  <Provider store={store}>
12    <ConnectedRouter history={history}> { /* place ConnectedRouter under Provider */ }
13      <> { /* your usual react-router v4/v5 routing */ }
14        <Switch>
15          <Route exact path="/" render={() => (<div>Match</div>)} />
16          <Route render={() => (<div>Miss</div>)} />
17        </Switch>
18      </>
19    </ConnectedRouter>
20  </Provider>,
21  document.getElementById('react-root')
22)

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

1npm 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.

1...
2import { Provider, ReactReduxContext } from 'react-redux'
3...
4      <Provider store={store} context={ReactReduxContext}>
5        <App history={history} context={ReactReduxContext} />
6      </Provider>
7...

In App.js,

1...
2const App = ({ history, context }) => {
3  return (
4    <ConnectedRouter history={history} context={context}>
5      { routes }
6    </ConnectedRouter>
7  )
8}
9...

Contributors

See Contributors and Acknowledge.

License

MIT License

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

9

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

7

SAST

Determines if the project uses static code analysis.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

83 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-f5x2-xv93-4p23
Warn: Project is vulnerable to: GHSA-gmpm-xp43-f7g6
Warn: Project is vulnerable to: GHSA-pf27-929j-9pmm
Warn: Project is vulnerable to: GHSA-327c-qx3v-h673
Warn: Project is vulnerable to: GHSA-x4cf-6jr3-3qvp
Warn: Project is vulnerable to: GHSA-mph8-6787-r8hw
Warn: Project is vulnerable to: GHSA-7mhc-prgv-r3q4
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-rxrc-rgv4-jpvx
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj
Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7

Score

3.2

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to connected-react-router

connected-react-router

Installations

Pull Requests

29

300

44

227

Issues

146

316

170

Releases

Developer

supasate

Developer Guide

CommonJS

Yes

13.11.0

6.13.7

Statistics

Languages

Total Downloads

130,716,981

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Optional Dependencies

Connected React Router

Main features

Installation

Usage

Step 1

Step 2

Step 3

Examples

FAQ

Build

Development

Contributors

License

10

10

9

7

4

0

0

0

0

0

0

0

0

3.2

/10

Other packages similar to connected-react-router