Please note that this repo has been deprecated. Code and issues are being migrated to a monorepo at https://github.com/angular-redux/platform where we are beginning work on a new and improved v10. To file any new issues or see the state of the current code base, we would love to see you there! Thanks for your support!
Bindings to connect @angular/router to @angular-redux/core
For use with Angular 6: Use v9.
For use with Angular 5: Use v7.
For use with Angular 2-4: Use v6.
- Use npm to install the bindings:
npm install @angular-redux/router --save
- Use the
routerReducer
when providingStore
:
import { combineReducers } from 'redux';
import { routerReducer } from '@angular-redux/router';
export default combineReducers<IAppState>({
// your reducers..
router: routerReducer
});
- Add the bindings to your root module.
import { NgModule } from '@angular/core';
import { NgReduxModule, NgRedux } from '@angular-redux/core';
import { NgReduxRouterModule, NgReduxRouter } from '@angular-redux/router';
import { RouterModule } from '@angular/router';
import { routes } from './routes';
@NgModule({
imports: [
RouterModule.forRoot(routes),
NgReduxModule,
NgReduxRouterModule.forRoot()
// ...your imports
],
// Other stuff..
})
export class AppModule {
constructor(
ngRedux: NgRedux<IAppState>,
ngReduxRouter: NgReduxRouter
) {
ngRedux.configureStore(/* args */);
ngReduxRouter.initialize(/* args */);
}
}
When using a wrapper for your store's state, such as Immutable.js, you will need to change two things from the standard setup:
- Provide your own reducer function that will receive actions of type
UPDATE_LOCATION
and return the payload merged into state. - Pass a selector to access the payload state and convert it to a JS object via the
selectLocationFromState
option onNgReduxRouter
'sinitialize()
.
These two hooks will allow you to store the state that this library uses in whatever format or wrapper you would like.
Depending on your app's needs. It may need to supply the current URL of the page differently than directly
through the router. This can be achieved by initializing the bindings with a second argument: urlState$
.
The urlState$
argument lets you give NgReduxRouter
an Observable<string>
of the current URL of the page.
If this argument is not given to the bindings, it defaults to subscribing to the @angular/router
's events, and
getting the URL from there.