Skip to content

Commit 7736b56

Browse files
committed
update README for version 1.1.0
1 parent d639284 commit 7736b56

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

projects/ng2-loading-spinner/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
<p align="center">
22
<img height="200px" width="200px" style="text-align: center;" src="https://cdn.rawgit.com/me-majidi/ng2-loading-spinner/e284608f/assets/logo.svg">
33
</p>
4+
<a name="ng2-loading-spinner" />
45
<h1>Ng2-loading-spinner</h1>
6+
7+
<a name="Customisable loading spinner for angular applications" />
58
<h5>Customisable loading spinner for angular applications</h5>
69

710
[![npm version](https://badge.fury.io/js/ng2-loading-spinner.svg)](https://www.npmjs.com/package/ng2-loading-spinner)
@@ -15,6 +18,8 @@
1518

1619

1720

21+
<a name="Table of contents" />
22+
1823
## Table of contents
1924
- [Online Demo](https://me-majidi.github.io/ng2-loading-spinner/)
2025
- [Installation](https://www.npmjs.com/package/ng2-loading-spinner#installation)
@@ -27,13 +32,16 @@
2732

2833

2934

35+
<a name="Installation" />
3036

3137
## Installation
3238
```shell
3339
npm install --save ng2-loading-spinner
3440
```
3541

3642

43+
<a name="Usage" />
44+
3745
## Usage
3846
Import `Ng2LoadingSpinnerModule` in your module
3947

@@ -74,8 +82,12 @@ export class AppComponent {
7482

7583
<br><br>
7684
<br><br>
85+
<a name="API" />
86+
7787
## API
7888

89+
<a name="Input parameters" />
90+
7991
#### Input parameters
8092
Input | Type | Required | Description |
8193
------ | ----- | ----- | ----- |
@@ -84,7 +96,10 @@ config | INg2LoadingSpinnerConfig | Optional | Configuartion object for spinner.
8496
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 |
8597

8698

99+
<a name="Configurable options" />
100+
87101
#### Configurable options
102+
88103
Option | Required | type | Default value | Description | Examples |
89104
--- | --- | --- | --- | --- | ---- |
90105
animationType | Optional | string | ANIMATION_TYPES.fadingCircle | The spinner animation to be used. import ANIMATION_TYPES constant to select valid options. | ANIMATION_TYPES.chasingDots |
@@ -99,6 +114,8 @@ spinnerFontSize | Optional | string | | Option for controlling size of spinner.I
99114

100115

101116
<br><br><br>
117+
<a name="Available spinner positions" />
118+
102119
#### Available spinner positions:
103120
Position |
104121
------ |
@@ -115,6 +132,8 @@ bottom-left |
115132

116133

117134
<br><br>
135+
<a name="Available spinner sizes" />
136+
118137
#### Available spinner sizes:
119138
Size |
120139
------ |
@@ -134,9 +153,13 @@ xl |
134153

135154

136155

156+
<a name="Examples" />
137157

138158
## Examples
139159

160+
161+
<a name="Example 1 - with custom configuration options" />
162+
140163
#### Example 1 - with custom configuration options
141164

142165
``` typescript
@@ -186,6 +209,8 @@ export class Example1Component {
186209
</button>
187210
```
188211

212+
<a name="Example2 - using custom template" />
213+
189214
#### Example2 - using custom template
190215

191216
``` typescript

0 commit comments

Comments
 (0)