Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@kken94/ngx-progress

2.0.0 • Public • Published

@kken94/ngx-progress

Build Status npm version CodeClimate Codacy code style: prettier semantic-release license Donate

NgxProgress is customizable Angular library for showing a progress bar during http request and/or routing change (or all you want) and prevent user interaction.

Changelog

Please read the changelog

Installation

If you use npm

npm install @kken94/ngx-progress --save

If you use yarn

yarn add @kken94/ngx-progress

Usage

Choose the most suitable module for you.

There are two modules:

  • NgxProgressModule (manage progress bar by yourself)
  • NgxProgressOnlyHttpModule (import progress bar and intercept http requests)

Import one of this in your *.module.ts

import { NgxProgressModule } from '@kken94/ngx-progress';

@NgModule({
  declarations: [AppComponent],
  imports: [
    ...
    NgxProgressModule,
    ...
  ],
  bootstrap: [AppComponent],
})
export class AppModule {}

and place it into the element you want to cover.

Note: If you want to use overlay be sure that the parent element has position:relative Overlay works with position:absolute, top:0, left:0

<div style="position: relative">
  <ngx-progress></ngx-progress>
  <table></table>
</div>

Features

  • NgxProgress supports multiple requests. If during the bar progress another request is fired, bar will not reset and keep going until all requests are completed.
  • NgxProgress can be instantiated multiple times. Only the deepest one will be displayed

Requests filtering

You can filter the HTTP requests that would like to be avoided by the interceptor by providing an array of regex patterns:

  import { NgxProgressHttpModule } from '@kken94/ngx-progress';
  
  @NgModule({
    declarations: [AppComponent],
    imports: [
      ...
      NgxProgressHttpModule.forRoot(['auth', '[a-zA-Z]']),
      ...
    ],
    bootstrap: [AppComponent],
  })
  export class AppModule {}

Configuration

Customization

Input Description Default value
color #0984e3
showSpinner true
showBar true
indeterminate Indeterminate style like Material false
barHeight 1px
spinnerDiameter 10px
initialValue From 1 to 100 undefined
overlay Show overlay that prevent user click true
overlayValue From 0 to 1 1
spinnerSpeed From 1 to 10 4

Emitters

NgxProgress provides also some emitters.
You have to inject NgxProgressService and subscribe end$ or start$

Manually show and hide progress

In NgxProgressService there are four methods:

  • start(): start bar if no request is in progress or add new request to queue of the bar already shown
  • end(): complete the bar if all requests are finished
  • reset(): force bar to start from zero
  • terminate(): force bar to terminate even if some requests are in progress

Enable and disable progress bar

In NgxProgressService:

  • enable(): enable bars if it has been previously disabled
  • disable(): disables all the bars that will not be shown until the next enabling

and provide isEnabled variable to know if progress bar is enabled.
Enabled by default.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Donate

Offer me a coffee 😁

donate

Install

npm i @kken94/ngx-progress

DownloadsWeekly Downloads

4

Version

2.0.0

License

MIT

Unpacked Size

245 kB

Total Files

33

Last publish

Collaborators

  • avatar