Skip to content

Commit fc906fe

Browse files
committed
Chore: update README
1 parent d914103 commit fc906fe

File tree

5 files changed

+21
-11
lines changed

5 files changed

+21
-11
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,17 @@
55

66
# ngx-ui-loader
77

8-
A fully customizable loader/spinner and progress bar for Angular 4, 5(tested) and 6+(tested) applications - AoT compatible.
8+
An all-in-one and fully customizable loader/spinner for Angular 5+ (5+ and 6+ are tested) applications. It supports foreground, background spinner/loader and indicative progress bar.
9+
10+
[![ngx-ui-loader-demo](https://j.gifs.com/jq98XB.gif)](https://ngx-ui-loader-demo.stackblitz.io)
911

1012
### Features
1113

1214
* Show foreground loader with progress bar
1315
* Show background loader with different id for different tasks
1416
* Be able to add logo, loading text
15-
* Be able to change position of spinners, logo and loading text
16-
* Be able to change color and size of spinners and progress bar
17+
* Be able to change position of spinners, logo and loading text. NOTE: When they are all set to `center-center`, the gap between them are adjusted via `gap` properties. Other position types are is overlap. E.g. If the position of foreground spinner and logo are set to `bottom-center`, they are overlap each other.
18+
* Be able to change color and size of logo, spinners and progress bar
1719
* Be able to change the direction of progress bar
1820

1921
## Demo
@@ -165,18 +167,22 @@ export class AppModule { }
165167
| `bgsPosition` | *string* | optional | `bottom-right` | Background spinner postion. All available positions can be accessed via `NGX_POSITIONS` |
166168
| `bgsSize` | *number* | optional | `60` | Background spinner size. |
167169
| `bgsType` | *string* | optional | `rectangle-bounce`| Background spinner type. All available types can be accessed via `SPINNER_TYPES` |
170+
| | | | | |
168171
| `fgsColor` | *string* | optional | `#00ACC1` | Foreground spinner color |
169172
| `fgsPosition` | *string* | optional | `center-center` | Foreground spinner position. All available positions can be accessed via `NGX_POSITIONS` |
170173
| `fgsSize` | *number* | optional | `60` | Foreground spinner size. |
171174
| `fgsType` | *string* | optional | `rectangle-bounce`| Foreground spinner type. All available types can be accessed via `SPINNER_TYPES` |
172-
| `gap` | *number* | optional | `24` | The gap between logo, foreground spinner and text when their position are `center-center` |
175+
| `gap` | *number* | optional | `24` | The gap between logo, foreground spinner and text when their positions are `center-center`|
176+
| `overlayColor` | *string* | optional | `rgba(40,40,40,.8)`| Overlay background color |
177+
| | | | | |
173178
| `logoPosition` | *string* | optional | `center-center` | Logo position. All available positions can be accessed via `NGX_POSITIONS` |
174179
| `logoSize` | *number* | optional | `120` | Logo size (px) |
175180
| `logoUrl` | *string* | optional | (*empty string*) | Logo url |
176-
| `overlayColor` | *string* | optional | `rgba(40,40,40,.8)`| Overlay background color |
181+
| | | | | |
177182
| `pbColor` | *string* | optional | `#00ACC1` | Progress bar color |
178183
| `pbDirection` | *string* | optional | `ltr` | Progress bar direction. All directions type can be accessed via `PB_DIRECTIONS` |
179184
| `pbThickness` | *number* | optional | `5` | Progress bar thickness |
185+
| | | | | |
180186
| `text` | *string* | optional | (*empty string*) | Loading text |
181187
| `textColor` | *string* | optional | `#FFFFFF` | Loading text color |
182188
| `textPosition` | *string* | optional | `center-center` | Loading text position. All available positions can be accessed via `NGX_POSITIONS` ||

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ngx-ui-loader-app",
3-
"version": "1.0.1",
3+
"version": "1.0.2",
44
"scripts": {
55
"ng": "ng",
66
"start": "ng serve",

projects/ngx-ui-loader/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "ngx-ui-loader",
3-
"description": "A fully customizable loader/spinner and progress bar for Angular 4, 5(tested) and 6+(tested) applications - AoT compatible.",
4-
"version": "1.0.1",
3+
"description": "An all-in-one and fully customizable loader/spinner for Angular 5+ (5+ and 6+ are tested) applications. It supports foreground, background spinner/loader and indicative progress bar.",
4+
"version": "1.0.2",
55
"repository": {
66
"type": "git",
77
"url": "https://github.com/t-ho/ngx-ui-loader.git"

src/app/app.component.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ <h3>A fully customizable loader/spinner for angular 5+ and 6+</h3>
5050
<div fxLayout="row" fxLayoutAlign="center" style="margin-top: 12px">
5151
<div fxFlex="100" fxFlex.lg="90" fxFlex.gt-lg="70" fxLayout="row wrap" fxLayoutAlign="center">
5252

53-
<div fxFlex="100" fxFlex.gt-xs="50" fxFlex.gt-md="36" fxLayout="column" class="p-12">
54-
<mat-list role="list">
53+
<div fxFlex="100" fxFlex.gt-md="36" fxLayout="column" fxLayout.sm="row" fxLayout.md="row" class="p-12">
54+
<mat-list role="list" fxFlex.sm="50" fxFlex.md="50" class="mat-elevation-z4">
5555
<mat-list-item role="listitem">
5656
<mat-slide-toggle (change)="fgSlideChange($event.checked)" [(checked)]="waitingForeground['default']">
5757
{{waitingForeground['default'] ? 'stop' : 'start'}}() - automatically stop after 3s
@@ -85,7 +85,7 @@ <h3>A fully customizable loader/spinner for angular 5+ and 6+</h3>
8585
</div>
8686
</mat-list-item>
8787
</mat-list>
88-
<div fxLayout="column" class="config-info">
88+
<div fxLayout="column" fxFlex.sm="50" fxFlex.md="50" class="config-info">
8989
<span class="place-holder">ngx-ui-loader-configuration = </span>
9090
<pre><code>{{config | json}}</code></pre>
9191
</div>

src/app/app.component.scss

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,7 @@ mat-slider {
4242
overflow-x: auto;
4343
}
4444
}
45+
46+
.mat-elevation-z4 {
47+
background-color: rgba(63, 81, 181, 0.3);
48+
}

0 commit comments

Comments
 (0)