This package has been deprecated

Author message:

This package has been moved. Use the @studiohyperdrive/ng-redux-router package instead.

@district01/ng-redux-router
TypeScript icon, indicating that this package has built-in type declarations

3.1.2 • Public • Published

Angular Redux Router

Sync Angular Router state with the Redux app state, gaining easy access to the entire route, not just the activated route.

Dependencies

  • @angular/router

Installation

npm install @district01/ng-redux-router --save

Import component in app.module.ts:

import { ReduxRouterModule } from '@district01/ng-redux-router';

@NgModule({
    imports: [
        ReduxRouterModule
    ]
})

export class AppModule {}

Initialize ReduxRouter with a dispatch function (e.g. using the @angular-redux/store package:

constructor(
    private ngRedux: NgRedux<MyAppState>,
    private reduxRouter: ReduxRouter
) {
    reduxRouter.initialize(ngRedux.dispatch);
}

Usage

The ReduxRouter will listen for route changes and store the current, previous and active (pending) route in the state. The following properties are stored for each route:

  • url: the complete path including queryParams & fragments
  • path: the url path without queryParams & fragments
  • frament: the current active fragment
  • query: all queryParams found on the route
  • params: all route params found on the route

The ROUTE_UPDATE action will only be dispatched once the NavigationEnd event is triggered.

Package Sidebar

Install

npm i @district01/ng-redux-router

Weekly Downloads

3

Version

3.1.2

License

none

Unpacked Size

66.7 kB

Total Files

21

Last publish

Collaborators

  • fabianmeul
  • jeroenvalcke
  • laurenspeeters
  • sanderh
  • thomasbormans
  • tom-odb