angular-router-observer

Small utility to track angular router events to get notified on completion and timeouts. Example use case is a loading bar that appears while routing is pending. Easy configurable debounce delay, routing timeout and url blacklisting or whitelisting.

Installation

For installation use the Node Package Manager:

$ npm install --save @korbiniankuhn/angular-router-observer

or clone the repository:

$ git clone https://github.com/KorbinianKuhn/angular-router-observer

Getting Started

Import the RouterObserverModule and add it to your imports list. Call the forRoot method.

import { RouterObserverModule } from '@korbiniankuhn/angular-router-observer';

@NgModule({
  bootstrap: [AppComponent],
  imports: [
    // ...
    RouterObserverModule.forRoot()
  ]
})
export class AppModule {}

Subscribe to the events of the RouterObserverService:

export class LoadingBarComponent implements OnInit {
  private showLoadingBar = false;

  constructor(private routerObserver: RouterObserverService) {}

  ngOnInit() {
    routerObserver.isPending.subscribe((groupName) => {
      this.showLoadingBar = true;
    });

    routerObserver.hasFinished.subscribe((groupName) => {
      this.showLoadingBar = false;
    });
  }
}

Options

You can configure the observer with following options. By default a delay of 50ms and no timeout is set.

// ...
RouterObserverModule.forRoot({
  whitelistedRoutes: ['/users', /posts/],
  blacklistedRoutes: [/messages/],
  delay: 0,
  timeout: 10000
})

The observer can have multiple routing groups with different settings, to observe different routings across components. By default a routingGroup with the name default is created. A routingGroup inherits and overwrites the global options.

// ...
RouterObserverModule.forRoot({
  whitelistedRoutes: ['/users', /posts/],
  blacklistedRoutes: [/messages/],
  delay: 0,
  timeout: 10000,
  routingGroups: [{
    name: 'localhost',
    whitelistedRoutes: [/messages/],
    blacklistedRoutes: null,
    timeout: 2000
  }]
})

Events

The following events are emitted by the observer.

/ ...
routerObserver.isPending.subscribe((groupName) => {
  console.log(groupName);
  // default

  if (groupName === 'custom') {
    console.log('show my custom loading bar');
  }
});

routerObserver.hasFinished.subscribe((groupName) => {
  console.log(groupName);
  // default
});

routerObserver.timedOutRouting.subscribe((object) => {
  console.log(object);
  // { routingGroupName: 'default', url: 'localhost', timeout: 2000 }
});

routerObserver.delayedRoutingEnd.subscribe((object) => {
  console.log(object);
  // { routingGroupName: 'default', url: 'localhost', timeout: 2000, duration: 3629 }
});

Testing

First you have to install all dependencies:

$ npm install

To execute all unit tests once, use:

$ npm test

To get information about the test coverage, use:

$ npm run coverage

Contribution

Get involved and push in your ideas.

Do not forget to add corresponding tests to keep up 100% test coverage.

License

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

KorbinianKuhn / angular-router-observer