@code-workers.io/ngx-loader

@code-workers.io/ngx-loader

A nice lib to show an overlay loading indicator.

Demo

Demo link

Install

npm i @code-workers.io/ngx-loader

Usage

Structural Directive Usage

Import the NgxLoaderModule in your app.module.ts

import { NgxLoaderDirectiveModule } from '@mikelgo/ngx-loader';

@NgModule({
  imports: [
    NgxLoaderDirectiveModule
  ]
})
export class AppModule { }

<div *ngxLoader="data; let result; loaderTemplate: myloader"> Some content I want to show {{result}} </div>


<ng-template #myloader> <my-spinner> </my-spinner> </ng-template

Optionally you can pass a config object to the module to customize a global loader component.

import { NgxLoaderDirectiveModule } from '@mikelgo/ngx-loader';

@NgModule({
  imports: [
    NgxLoaderDirectiveModule.forRoot({
      loaderComponent: MyCustomLoaderComponent,
      backdropClass: 'my-custom-backdrop-class'
    })
  ]
})
export class AppModule { }

Component Usage

Import the NgxLoaderModule in your app.module.ts

import { NgxLoaderModule } from '@mikelgo/ngx-loader';

@NgModule({
  imports: [
    NgxLoaderModule
  ]
})
export class AppModule { }

<ngx-loader [show]='loading$ | async' [loaderTemplate]="myloader">
  <ng-template>
    <div> Some content I want to show</div>
  </ng-template>
</ngx-loader>

<ng-template #myloader> <my-spinner> </my-spinner> </ng-template

Optionally you can pass a config object to the module to customize a global loader component. Then you can omit the loaderTemplate input in the previous example.

import { NgxLoaderModule } from '@mikelgo/ngx-loader';

@NgModule({
  imports: [
    NgxLoaderModule.forRoot({
      loaderComponent: MyCustomLoaderComponent,
      backdropClass: 'my-custom-backdrop-class'
    })
  ]
})
export class AppModule { }

Finally you will use it like this:

<ngx-loader [show]='loading$ | async'>
  <ng-template>
    <div> Some content I want to show</div>
  </ng-template>
</ngx-loader>

API

NgxLoaderComponent

• show [boolean]: condition to hide or show the component
• loaderTemplate [TemplateRef]: template to render a custom loader
• backdropClass [string]: CSS class to apply for the backdrop background

NgxLoaderConfig

• loaderComponent [Type]: component to render a custom loader
• backdropClass [string]: CSS class to apply for the backdrop background

Compatibility

Version 1.x.x is compatible with Angular 13.x.x.

Running unit tests

Run nx test ngx-loader to execute the unit tests.