New Priority Mail

    ng-loading-bar
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.10 • Public • Published

    @ngx-loading-bar

    A fully automatic loading bar with zero configuration for angular app (http, http-client and router).

    Packages

    Demo

    Quick Start

    1. Install one or all @ngx-loading-bar libraries:

      # if you use `@angular/common/http` 
      npm install @ngx-loading-bar/http-client --save
     
      # if you use `@angular/http` 
      npm install @ngx-loading-bar/http --save
     
      # if you use `@angular/router` 
      npm install @ngx-loading-bar/router --save
     
      # to manage loading-bar manually 
      npm install @ngx-loading-bar/core --save

    2. Import the installed libraries (LoadingBarHttpClientModule, LoadingBarHttpModule, LoadingBarRouterModule or LoadingBarModule):

    import { NgModule } from '@angular/core';
    import { BrowserModule } from '@angular/platform-browser';
     
    import { LoadingBarHttpClientModule } from '@ngx-loading-bar/http-client';
     
    // for Http import LoadingBarHttpModule:
    // import { LoadingBarHttpModule } from '@ngx-loading-bar/http';
     
    // for Router import LoadingBarRouterModule:
    // import { LoadingBarRouterModule } from '@ngx-loading-bar/router';
     
    // for Core import LoadingBarModule:
    // import { LoadingBarModule } from '@ngx-loading-bar/core';
     
    import { AppComponent } from './app';
     
    @NgModule({
      ...
      imports[
        ...
     
        LoadingBarHttpClientModule
     
        // for HttpClient use:
        // LoadingBarHttpModule,
     
        // for Router use:
        // LoadingBarRouterModule
     
        // for HttpClient use:
        // LoadingBarHttpClientModule
     
        // for Core use:
        // LoadingBarHttpClientModule.forRoot()
      ],
    })
    export class AppModule {}

    3. Include ngx-loading-bar in your app component:

    import { Component } from '@angular/core';
     
    @Component({
      selector: 'app',
      template: `
        ...
        <ngx-loading-bar></ngx-loading-bar>
      `,
    })
    export class AppComponent {}
     

    4. include the supplied CSS file (or create your own).

    Manually manage loading service

    1. Import the LoadingBarModule

    import { NgModule } from '@angular/core';
     
    import { LoadingBarModule } from '@ngx-loading-bar/core';
     
    @NgModule({
      ...
      imports[
        ...
     
        LoadingBarModule.forRoot(),
      ],
    })
    export class AppModule {}

    2. Inject/Use LoadingBarService

    import { Component } from '@angular/core';
    import { LoadingBarService } from '@ngx-loading-bar/core';
     
    @Component({
      selector: 'app',
      template: `
        ...
        <ngx-loading-bar></ngx-loading-bar>
        <button (click)="startLoading()">start</button>
        <button (click)="stopLoading()">stop</button>
      `,
    })
    export class App {
        constructor(private loadingBar: LoadingBarService) {}
     
        startLoading() {
            this.loadingBar.start();
        }
        
        stopLoading() {
            this.loadingBar.complete();
        }
    }

    Advanced

    When you import LoadingBarHttpModule, http service observables become hot. That means that a HTTP request is sent as soon as a call to http.get (for example) has been made.

     
    import { Component } from '@angular/core';
    import { Http } from '@angular/http';
     
     
    @Component({
        selector: 'ng-loading-bar-app',
        templateUrl: './app.html',
    })
    export class App {
        private request$;
     
        constructor(private _http: Http) {
            // http request is sent here
            this.request$ = _http.get('/app/heroes');
        }
     
        startLoadingBarHttpRequest() {
            if (false) {
                // Request has been sent to server 
                this.request$.subscribe();
            }
        }
    }
     

    This behavior is because the Loading bar module overrides default http service by setting up a subscription to the request. This subscription fires up the HTTP request.

    If this behavior doesn't suit you, you should manage loading bar manually as in the component startHttpRequest above.

    Credits

    Install

    npm i ng-loading-bar

    DownloadsWeekly Downloads

    37

    Version

    0.0.10

    License

    MIT

    Last publish

    Collaborators

    • aitboudad