@@ -25,29 +25,17 @@ Configurable, lightweight back to top button for Angular projects.
25
25
<img src =" src/assets/images/demo-scroll-top.gif " />
26
26
</p >
27
27
28
- To run this demo:
29
- * ` git clone https://github.com/ProAngular/ngx-scroll-top.git `
30
- * ` cd ngx-scroll-top `
31
- * ` npm install `
32
- * ` npm run start `
28
+ # Installation
33
29
34
- # Installation and importing
35
-
36
- ## Installation
37
-
38
- Angular
39
30
``` bash
40
31
ng add @proangular/ngx-scroll-top@latest
41
32
```
42
-
43
- Direct
33
+ or
44
34
``` bash
45
35
npm install @proangular/ngx-scroll-top --save
46
36
```
47
37
48
- ## Import
49
-
50
- Import package into the module of your choice
38
+ Import ` NgxScrollTopModule ` where needed
51
39
``` diff
52
40
...
53
41
+ import { NgxScrollTopModule } from '@proangular/ngx-scroll-top';
@@ -63,14 +51,14 @@ Import package into the module of your choice
63
51
export class AppModule { }
64
52
```
65
53
66
- # Usage and Examples
54
+ # Usage
67
55
68
- Default use (blue button with white icon)
56
+ Default (blue button with white icon)
69
57
``` html
70
58
<ngx-scroll-top ></ngx-scroll-top >
71
59
```
72
60
73
- Example with optional inputs
61
+ Customization with optional inputs and icon
74
62
``` html
75
63
<ngx-scroll-top
76
64
backgroundColor =" #0D58C0"
@@ -109,15 +97,19 @@ Example with optional inputs
109
97
110
98
# Development
111
99
112
- 1 . Clone, create new branch.
113
- * ` git clone https://github.com/ProAngular/ngx-scroll-top.git `
114
- * ` git checkout -b username/feature `
115
- 2 . Bump version of package in ` package.json ` and ` package-lock.json ` , commit all changes, push.
116
- * ` git add -A `
117
- * ` git commit -m "My commit message" `
118
- * ` git push origin username/feature `
100
+ Please submit all issues, and feature requests here: [ https://github.com/ProAngular/ngx-scroll-top/issues ] ( https://github.com/ProAngular/ngx-scroll-top/issues )
101
+
102
+ Contribution:
103
+
104
+ 1 . Clone the repo and create a new branch:
105
+ * ` git clone https://github.com/ProAngular/ngx-scroll-top.git `
106
+ * ` git checkout -b username/feature-or-bug-description `
107
+ 2 . Bump up the version of package in ` package.json ` and ` package-lock.json ` , commit all changes, push.
108
+ * ` git add -A `
109
+ * ` git commit -m "My commit message" `
110
+ * ` git push origin username/feature-or-bug-description `
119
111
3 . Submit code in published PR for review and approval. Add a good description and link any possible user stories or bugs.
120
- * [ Create a new pull request] ( https://github.com/ProAngular/ngx-scroll-top/compare ) .
112
+ * [ Create a new pull request] ( https://github.com/ProAngular/ngx-scroll-top/compare ) .
121
113
4 . Allow CI actions to completely run and verify files.
122
114
5 . Add/ping reviewers and await approval.
123
115
0 commit comments