Skip to content

Commit bd31f0b

Browse files
committed
REFACTOR - Change app name
1 parent 4a2d4e9 commit bd31f0b

36 files changed

+768
-491
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ before_script:
1919

2020
script:
2121
- ng lint
22-
- ng build ngx-progress
22+
- ng build ngx-ui-loader
2323
- ng build --prod

README.md

Lines changed: 36 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
[![npm version](https://badge.fury.io/js/ngx-progress.svg)](https://badge.fury.io/js/ngx-progress)
2-
[![npm](https://img.shields.io/npm/dt/ngx-progress.svg)](https://www.npmjs.com/package/ngx-progress)
3-
[![npm](https://img.shields.io/npm/dm/ngx-progress.svg)](https://www.npmjs.com/package/ngx-progress)
4-
[![npm](https://img.shields.io/npm/dw/ngx-progress.svg)](https://www.npmjs.com/package/ngx-progress)
5-
[![npm](https://img.shields.io/npm/l/ngx-progress.svg)](https://www.npmjs.com/package/ngx-progress)
1+
[![npm version](https://badge.fury.io/js/ngx-ui-loader.svg)](https://badge.fury.io/js/ngx-ui-loader)
2+
[![npm](https://img.shields.io/npm/dw/ngx-ui-loader.svg)](https://www.npmjs.com/package/ngx-ui-loader)
3+
[![npm](https://img.shields.io/npm/l/ngx-ui-loader.svg)](https://www.npmjs.com/package/ngx-ui-loader)
64

7-
# ngx-progress
5+
# ngx-ui-loader
86

97
A fully customizable loader/spinner and progress bar for Angular 4, 5(tested) and 6+(tested) applications - AoT compatible.
108

119
### Features
1210

13-
* Show foreground loading with progress bar
14-
* Show background loading with different id for different tasks
11+
* Show foreground loader with progress bar
12+
* Show background loader with different id for different tasks
1513
* There are 12 spinner types available
1614
* Be able to add logo, loading text
1715
* Be able to change position of spinners, logo and loading text
@@ -20,22 +18,22 @@ A fully customizable loader/spinner and progress bar for Angular 4, 5(tested) an
2018

2119
## Demo
2220

23-
Live demo [here](https://ngx-progress-demo-angular-6.stackblitz.io).
21+
Live demo [here](https://ngx-ui-loader-demo.stackblitz.io).
2422

25-
Play with **ngx-progress** [here](https://stackblitz.com/edit/ngx-progress-demo-angular-6) on stackblitz.
23+
Play with **ngx-ui-loader** [here](https://stackblitz.com/edit/ngx-ui-loader-demo) on stackblitz.
2624

2725
## Installation
2826

29-
Install `ngx-progress` via NPM, using the command below.
27+
Install `ngx-ui-loader` via NPM, using the command below.
3028

3129
### NPM
3230

3331
```shell
34-
npm install --save ngx-progress
32+
npm install --save ngx-ui-loader
3533
```
3634
## Getting started
3735

38-
Import the `NgxProgressModule` in your root application module `AppModule`:
36+
Import the `NgxUiLoaderModule` in your root application module `AppModule`:
3937

4038
```typescript
4139

@@ -44,16 +42,16 @@ import { NgModule } from '@angular/core';
4442

4543
import { AppComponent } from './app.component';
4644

47-
import { NgxProgressModule } from 'ngx-progress';
45+
import { NgxUiLoaderModule } from 'ngx-ui-loader';
4846

4947
@NgModule({
5048
declarations: [
5149
AppComponent,
5250
],
5351
imports: [
5452
BrowserModule,
55-
// Import NgxProgressModule
56-
NgxProgressModule,
53+
// Import NgxUiLoaderModule
54+
NgxUiLoaderModule,
5755
],
5856
providers: [],
5957
bootstrap: [AppComponent]
@@ -64,18 +62,18 @@ export class AppModule { }
6462

6563
## Usage
6664

67-
After importing the `NgxProgressModule`, use `ngx-progress` component in your root app template:
65+
After importing the `NgxUiLoaderModule`, use `ngx-ui-loader` component in your root app template:
6866

6967
```html
70-
<ngx-progress></ngx-progress>
68+
<ngx-ui-loader></ngx-ui-loader>
7169
```
7270

73-
Add `NgxProgressService` service wherever you want to use the `ngx-progress`:
71+
Add `NgxUiLoaderService` service wherever you want to use the `ngx-ui-loader`:
7472

7573

7674
```typescript
7775
import { Component, OnInit } from '@angular/core';
78-
import { NgxProgressService } from 'ngx-progress'; // Import NgxProgressService
76+
import { NgxUiLoaderService } from 'ngx-ui-loader'; // Import NgxUiLoaderService
7977

8078
@Component({
8179
selector: 'app-root',
@@ -84,7 +82,7 @@ import { NgxProgressService } from 'ngx-progress'; // Import NgxProgressService
8482
})
8583
export class AppComponent implements OnInit {
8684

87-
constructor(private ngxService: NgxProgressService) { }
85+
constructor(private ngxService: NgxUiLoaderService) { }
8886

8987
ngOnInit() {
9088
this.ngxService.start(); // start foreground loading with 'default' id
@@ -103,24 +101,24 @@ export class AppComponent implements OnInit {
103101

104102
```
105103

106-
## NgxProgressService service
104+
## NgxUiLoaderService service
107105

108-
* `NgxProgressService.start([id]='default')` Starts a foreground loader with progress bar. Users cannot interact with the page when the loader is showed.
109-
* `NgxProgressService.stop([id]='default')` Stops a foreground loader with progress bar.
110-
* `NgxProgressService.startBackground([id]='default')` Starts a background loader. Users can interact with the page when the loader is showed.
111-
* `NgxProgressService.stopBackground([id]='default')` Stops a background loader.
112-
* `NgxProgressService.getDefaultConfig()` Returns the default configuration object of `ngx-progress`.
113-
* `NgxProgressService.getStatus()` Returns an object including `waitingForeground` and `waitingBackground` properties.
114-
* `NgxProgressService.stopAll()` Stops all foreground and background loaders.
106+
* `NgxUiLoaderService.start([id]='default')` Starts a foreground loader with progress bar. Users cannot interact with the page when the loader is showed.
107+
* `NgxUiLoaderService.stop([id]='default')` Stops a foreground loader with progress bar.
108+
* `NgxUiLoaderService.startBackground([id]='default')` Starts a background loader. Users can interact with the page when the loader is showed.
109+
* `NgxUiLoaderService.stopBackground([id]='default')` Stops a background loader.
110+
* `NgxUiLoaderService.getDefaultConfig()` Returns the default configuration object of `ngx-ui-loader`.
111+
* `NgxUiLoaderService.getStatus()` Returns an object including `waitingForeground` and `waitingBackground` properties.
112+
* `NgxUiLoaderService.stopAll()` Stops all foreground and background loaders.
115113

116114
## Configuration
117115

118-
You can configure `ngx-progress` in the template as below:
116+
You can configure `ngx-ui-loader` in the template as below:
119117

120-
Import the constant `SPINNER_TYPES` from `ngx-progress` in your controller. Then in your template:
118+
Import the constant `SPINNER_TYPES` from `ngx-ui-loader` in your controller. Then in your template:
121119

122120
```html
123-
<ngx-progress fgsSize="75" [fgsType]="SPINNER_TYPES.wanderingCubes" ></ngx-progress>
121+
<ngx-ui-loader fgsSize="75" [fgsType]="SPINNER_TYPES.wanderingCubes" ></ngx-ui-loader>
124122
```
125123

126124
Or you can override the default configuration via `forRoot()` method.
@@ -131,15 +129,15 @@ import { NgModule } from '@angular/core';
131129

132130
import { AppComponent } from './app.component';
133131

134-
import { NgxProgressModule, NgxProgressConfig, SPINNER_TYPES, NGX_POSITIONS, PB_DIRECTIONS } from 'ngx-progress';
132+
import { NgxUiLoaderModule, NgxUiLoaderConfig, SPINNER_TYPES, NGX_POSITIONS, PB_DIRECTIONS } from 'ngx-ui-loader';
135133

136-
const ngxProgressConfig: NgxProgressConfig = {
134+
const ngxUiLoaderConfig: NgxUiLoaderConfig = {
137135
bgsColor: 'red',
138136
bgsPosition: NGX_POSITIONS.bottomCenter,
139137
bgsSize: 40,
140138
bgsType: SPINNER_TYPES.rectangleBounce,
141-
pbDirection: PB_DIRECTIONS.leftToRight,
142-
pbThickness: 5,
139+
pbDirection: PB_DIRECTIONS.leftToRight, // progress bar direction
140+
pbThickness: 5, // progress bar thickness
143141
};
144142

145143
@NgModule({
@@ -148,8 +146,8 @@ const ngxProgressConfig: NgxProgressConfig = {
148146
],
149147
imports: [
150148
BrowserModule,
151-
// Import NgxProgressModule with custom configuration globally
152-
NgxProgressModule.forRoot(ngxProgressConfig)
149+
// Import NgxUiLoaderModule with custom configuration globally
150+
NgxUiLoaderModule.forRoot(ngxUiLoaderConfig)
153151
],
154152
providers: [],
155153
bootstrap: [AppComponent]

angular.json

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"version": 1,
44
"newProjectRoot": "projects",
55
"projects": {
6-
"ngx-progress-app": {
6+
"ngx-ui-loader-app": {
77
"root": "",
88
"sourceRoot": "src",
99
"projectType": "application",
@@ -17,7 +17,7 @@
1717
"build": {
1818
"builder": "@angular-devkit/build-angular:browser",
1919
"options": {
20-
"outputPath": "dist/ngx-progress-app",
20+
"outputPath": "dist/ngx-ui-loader-app",
2121
"index": "src/index.html",
2222
"main": "src/main.ts",
2323
"polyfills": "src/polyfills.ts",
@@ -54,18 +54,18 @@
5454
"serve": {
5555
"builder": "@angular-devkit/build-angular:dev-server",
5656
"options": {
57-
"browserTarget": "ngx-progress-app:build"
57+
"browserTarget": "ngx-ui-loader-app:build"
5858
},
5959
"configurations": {
6060
"production": {
61-
"browserTarget": "ngx-progress-app:build:production"
61+
"browserTarget": "ngx-ui-loader-app:build:production"
6262
}
6363
}
6464
},
6565
"extract-i18n": {
6666
"builder": "@angular-devkit/build-angular:extract-i18n",
6767
"options": {
68-
"browserTarget": "ngx-progress-app:build"
68+
"browserTarget": "ngx-ui-loader-app:build"
6969
}
7070
},
7171
"test": {
@@ -99,15 +99,15 @@
9999
}
100100
}
101101
},
102-
"ngx-progress-app-e2e": {
102+
"ngx-ui-loader-app-e2e": {
103103
"root": "e2e/",
104104
"projectType": "application",
105105
"architect": {
106106
"e2e": {
107107
"builder": "@angular-devkit/build-angular:protractor",
108108
"options": {
109109
"protractorConfig": "e2e/protractor.conf.js",
110-
"devServerTarget": "ngx-progress-app:serve"
110+
"devServerTarget": "ngx-ui-loader-app:serve"
111111
}
112112
},
113113
"lint": {
@@ -121,38 +121,38 @@
121121
}
122122
}
123123
},
124-
"ngx-progress": {
125-
"root": "projects/ngx-progress",
126-
"sourceRoot": "projects/ngx-progress/src",
124+
"ngx-ui-loader": {
125+
"root": "projects/ngx-ui-loader",
126+
"sourceRoot": "projects/ngx-ui-loader/src",
127127
"projectType": "library",
128128
"prefix": "ngx",
129129
"architect": {
130130
"build": {
131131
"builder": "@angular-devkit/build-ng-packagr:build",
132132
"options": {
133-
"tsConfig": "projects/ngx-progress/tsconfig.lib.json",
134-
"project": "projects/ngx-progress/ng-package.json"
133+
"tsConfig": "projects/ngx-ui-loader/tsconfig.lib.json",
134+
"project": "projects/ngx-ui-loader/ng-package.json"
135135
},
136136
"configurations": {
137137
"production": {
138-
"project": "projects/ngx-progress/ng-package.prod.json"
138+
"project": "projects/ngx-ui-loader/ng-package.prod.json"
139139
}
140140
}
141141
},
142142
"test": {
143143
"builder": "@angular-devkit/build-angular:karma",
144144
"options": {
145-
"main": "projects/ngx-progress/src/test.ts",
146-
"tsConfig": "projects/ngx-progress/tsconfig.spec.json",
147-
"karmaConfig": "projects/ngx-progress/karma.conf.js"
145+
"main": "projects/ngx-ui-loader/src/test.ts",
146+
"tsConfig": "projects/ngx-ui-loader/tsconfig.spec.json",
147+
"karmaConfig": "projects/ngx-ui-loader/karma.conf.js"
148148
}
149149
},
150150
"lint": {
151151
"builder": "@angular-devkit/build-angular:tslint",
152152
"options": {
153153
"tsConfig": [
154-
"projects/ngx-progress/tsconfig.lib.json",
155-
"projects/ngx-progress/tsconfig.spec.json"
154+
"projects/ngx-ui-loader/tsconfig.lib.json",
155+
"projects/ngx-ui-loader/tsconfig.spec.json"
156156
],
157157
"exclude": [
158158
"**/node_modules/**"
@@ -162,5 +162,5 @@
162162
}
163163
}
164164
},
165-
"defaultProject": "ngx-progress-app"
165+
"defaultProject": "ngx-ui-loader-app"
166166
}

0 commit comments

Comments
 (0)