ng2-loading-spinner
v1.3.0TypeScript
customisable loading spinner for Angular applications
198/weekUpdated 3 years agoMITUnpacked: 578.5 KB
Published by Mehran Majidi
npm install ng2-loading-spinner
Ng2-loading-spinner
Customisable loading spinner for angular applications
Table of contents
- Online Demo
- Installation
- Usage
- API
- Examples
Installation
``
shell
npm install --save ng2-loading-spinner
`Usage
Import in your module`typescript
import { NgModule } from '@angular/core';
import { Ng2LoadingSpinnerModule } from 'ng2-loading-spinner'@NgModule({
imports: [ Ng2LoadingSpinnerModule.forRoot({}) ]
})
export class TestModule { }
`
then, use the directive on the element you want to have a spinner on:
`html
[ng2-loading]="showSpinner">
...
`
the directive expects a boolean for showing and removing Loading spinner:
typescript
@Component({
selector : 'app.component',
templateUrl: './app.component.html',
styleUrls : [ './app.component.css' ]
})
export class AppComponent {
showSpinner: boolean = true;
constructor() {
setTimeout(() => {
this.showSpinner = false;
}, 1500);
}
}
`API
#### Input parameters
Input | Type | Required | Description |
------ | ----- | ----- | ----- |
ng2-loading | boolean | Required | A boolean, which will determine when spinner is added to the DOM |
config | INg2LoadingSpinnerConfig | Optional | Configuartion object for spinner. If no config options are set, the default config options will be used. |
template | TemplateRef | Optional | If provided, the custom template will be shown in place of the default spinner animations. You can use this for rendering custom spinners instead of default spinner animations |
#### Configurable options
Config options can be set globally using the forRoot module import statement as well as being passed into each loader instance.Options passed to the instance of loader will override each global options.
Option | Required | type | Default value | Description | Examples |
--- | --- | --- | --- | --- | ---- |
animationType | Optional | string | ANIMATION_TYPES.fadingCircle | The spinner animation to be used. import ANIMATION_TYPES constant to select valid options. | ANIMATION_TYPES.chasingDots |
backdropColor | Optional | string | rgba(0, 0, 0, 0.3) | Background color of backdrop element | 'red', 'rgb(120, 0, 171)', '#434343' |
backdropBorderRadius | Optional | string | 0 | The border-radius property to be aplied to the spinner | '10px', '1rem', '50%' |
spinnerColor | Optional | string | white | Color of spinner | 'red', 'rgb(120, 0, 171)', '#434343' |
spinnerPosition | Optional | string | 'center' | Position the spinner into the host view | 'top', 'right', 'bottom', 'left', 'top-right', 'bottom-left' |
spinnerSize | Optional | string | 'md' | Option that indicates size of spinner | 'sm', 'md', 'lg' |
spinnerFontSize | Optional | string | | Option for controlling size of spinner.If provided
option will be ignored | '10px', '1rem' |#### Available spinner positions:
Position |
------ |
center |
top |
right |
bottom |
left |
top-right |
left-right |
top-left |
bottom-left |
#### Available spinner sizes:
Size |
------ |
xs |
sm |
md |
lg |
xl |
Examples
#### Example 1 - with custom configuration options
`typescript
import { NgModule } from '@angular/core';
import { Ng2LoadingSpinnerModule } from 'ng2-loading-spinner'@NgModule({
imports: [ Ng2LoadingSpinnerModule.forRoot({
backdropColor : 'rgba(0, 0, 0, 0.3)',
spinnerColor : '#fff',
}) ]
})
export class TestModule { }
` typescript
import { Component } from '@angular/core';
import { ANIMATION_TYPES } from 'ng2-loading-spinner';
import { INg2LoadingSpinnerConfig } from 'ng2-loading-spinner';@Component({
selector : 'app-example1',
templateUrl: './example1.component.html',
styleUrls : [ './example1.component.css' ]
})
export class Example1Component {
show = false;
loadingConfig: INg2LoadingSpinnerConfig = {
animationType : ANIMATION_TYPES.dualCircle,
spinnerPosition: 'left',
backdropBorderRadius: '15px',
spinnerSize: 'md',
spinnerFontSize: '2rem'
};
constructor () {
}
showLoading() {
this.show = true;
setTimeout(() => {
this.show = false;
}, 1500);
}
}
`html
[ng2-loading]="show"
[config]="loadingConfig"
(click)="showLoading()">
Show Spinner
`#### Example2 - using custom template
typescript
import { Component } from '@angular/core';
import { ANIMATION_TYPES } from 'ng2-loading-spinner';
import { INg2LoadingSpinnerConfig } from 'ng2-loading-spinner';
import { AuthService } from '../auth.service'@Component({
selector : 'app-example2',
templateUrl: './example2.component.html',
styleUrls : [ './example2.component.css' ]
})
export class Example2Component {
show = false;
loadingConfig: INg2LoadingSpinnerConfig = {
animationType : ANIMATION_TYPES.dualCircle,
backdropColor : 'rgba(0, 0, 0, 0.3)',
spinnerColor : '#fff',
spinnerPosition: 'center',
backdropBorderRadius: '15px',
spinnerSize: 'md',
spinnerFontSize: '2rem'
};
constructor (private authService: AuthService) {
}
onLogin() {
this.show = true;
this.authService.login()
.subscribe((res) => {
this.show = false;
})
}
}
`
html [config]="loadingConfig"
[template]="customTemplate">
`and style this custom loader in example2.component.css:
css
.custom-loader {
....
}
``