Skip to content

Commit 86339ef

Browse files
committed
Upgrade to ng 19
1 parent 254db2a commit 86339ef

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+13676
-21376
lines changed

.eslintrc.json

Lines changed: 188 additions & 78 deletions
Large diffs are not rendered by default.

.github/FUNDING.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ patreon:
2929
# https://tidelift.com/
3030
tidelift:
3131
# Custom URL
32-
custom: ["https://www.paypal.me/CodyTolene"]
32+
custom: ['https://www.paypal.me/CodyTolene']

.github/workflows/on-merge-main-deploy-gpr.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ jobs:
1717
- uses: actions/checkout@v3
1818
- uses: actions/setup-node@v3
1919
with:
20-
node-version: "16.x"
21-
registry-url: "https://npm.pkg.github.com"
20+
node-version: '16.x'
21+
registry-url: 'https://npm.pkg.github.com'
2222
- run: npm ci
2323
- run: npm run npm-build-package
2424
- run: cd dist/npm && npm publish

.github/workflows/on-merge-main-deploy-npmjs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ jobs:
1313
- uses: actions/checkout@v3
1414
- uses: actions/setup-node@v3
1515
with:
16-
node-version: "16.x"
17-
registry-url: "https://registry.npmjs.org"
16+
node-version: '16.x'
17+
registry-url: 'https://registry.npmjs.org'
1818
- run: npm ci
1919
- run: npm run npm-build-package
2020
- run: cd dist/npm && npm publish

.github/workflows/verify-pull-request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "Verify Pull Request"
1+
name: 'Verify Pull Request'
22
on: pull_request
33
jobs:
44
verify_pull_request:

.gitignore

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# See http://help.github.com/ignore-files/ for more about ignoring files.
1+
# See https://docs.github.com/get-started/getting-started-with-git/ignoring-files for more about ignoring files.
22

33
# Compiled output
44
/dist
5-
/dist/**/*
65
/tmp
76
/out-tsc
87
/bazel-out
@@ -21,9 +20,6 @@ yarn-error.log
2120
.settings/
2221
*.sublime-workspace
2322

24-
# IDE - Visual Studio
25-
.vs/*
26-
2723
# Visual Studio Code
2824
.vscode/*
2925
!.vscode/settings.json
@@ -32,38 +28,15 @@ yarn-error.log
3228
!.vscode/extensions.json
3329
.history/*
3430

35-
# Husky Local Environment Files
36-
/.husky/_
37-
3831
# Miscellaneous
39-
.angular
40-
.angular/
41-
.angular/*
42-
.angular/cache
4332
/.angular/cache
4433
.sass-cache/
4534
/connect.lock
4635
/coverage
4736
/libpeerconnection.log
4837
testem.log
4938
/typings
50-
ui-debug.log
5139

5240
# System files
5341
.DS_Store
5442
Thumbs.db
55-
56-
# Build and Release Folders
57-
bin-debug/
58-
bin-release/
59-
[Oo]bj/
60-
[Bb]in/
61-
62-
# Other files and folders
63-
.settings/
64-
65-
# Executables
66-
*.swf
67-
*.air
68-
*.ipa
69-
*.apk

.prettierignore

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
# Ignore everything...
1+
# Ignore everything
22
/*
33

4-
# Except these files and directories:
4+
# Make sure production files are ignored
5+
dist/
6+
public/
7+
8+
# Do not ignore the following files
59
!.github/
6-
!.husky/
7-
!e2e/src
810
!src/
11+
!README.md
12+
13+
# Re-ignore sub-directories from the above exempt directories:
14+
.github/CODEOWNERS

.prettierrc.json

Lines changed: 0 additions & 7 deletions
This file was deleted.

README.md

Lines changed: 63 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center">
22
<a href="https://www.ProAngular.com" target="_blank">
3-
<img src="src/assets/images/pro-angular-logo.png" />
3+
<img src="public/pro-angular-logo.png" />
44
</a>
55
<h1 align="center">
66
<a href="https://www.ProAngular.com" target="_blank">
@@ -49,10 +49,11 @@ Configurable, lightweight back to top button for Angular projects.
4949
## Demo
5050

5151
<p align="center">
52-
<img src="src/assets/images/demo-scroll-top.gif" />
52+
<img src="public/demo-scroll-top.gif" />
5353
</p>
5454

55-
Live demo here: [https://www.ProAngular.com/demos/ngx-scroll-top](https://www.ProAngular.com/demos/ngx-scroll-top)
55+
Live demo here:
56+
[https://www.ProAngular.com/demos/ngx-scroll-top](https://www.ProAngular.com/demos/ngx-scroll-top)
5657

5758
<a name="installation"/>
5859

@@ -61,25 +62,37 @@ Live demo here: [https://www.ProAngular.com/demos/ngx-scroll-top](https://www.Pr
6162
```bash
6263
ng add @proangular/ngx-scroll-top@latest
6364
```
65+
6466
or
67+
6568
```bash
6669
npm install @proangular/ngx-scroll-top --save
6770
```
6871

69-
Import `NgxScrollTopModule` where needed
72+
Import `NgxScrollTopComponent` where needed
73+
7074
```diff
71-
...
72-
+ import { NgxScrollTopModule } from '@proangular/ngx-scroll-top';
73-
...
75+
+ import { NgxScrollTopComponent } from '@proangular/ngx-scroll-top';
7476

77+
// Import to module
7578
@NgModule({
79+
...
7680
imports: [
81+
+ NgxScrollTopComponent,
7782
...
78-
+ NgxScrollTopModule
7983
],
84+
})
85+
86+
...
87+
88+
// or component
89+
@Component({
8090
...
91+
imports: [
92+
+ NgxScrollTopComponent,
93+
...
94+
],
8195
})
82-
export class AppModule { }
8396
```
8497

8598
<a name="dependencies"/>
@@ -88,20 +101,24 @@ export class AppModule { }
88101

89102
### Styling UX - Angular Material
90103

91-
You should have an Angular Material theme set up prior to using this. It's also possible to use this without an angular theme and style it yourself entirely!
104+
You should have an Angular Material theme set up prior to using this. It's also
105+
possible to use this without an angular theme and style it yourself entirely!
92106

93-
More information on theming Angular Material: https://material.angular.io/guide/theming
107+
More information on theming Angular Material:
108+
https://material.angular.io/guide/theming
94109

95110
<a name="usage"/>
96111

97112
## Usage
98113

99114
Default (blue button with white icon)
115+
100116
```html
101117
<ngx-scroll-top></ngx-scroll-top>
102118
```
103119

104120
Customization with optional inputs and icon
121+
105122
```html
106123
<ngx-scroll-top
107124
backgroundColor="#0D58C0"
@@ -113,7 +130,8 @@ Customization with optional inputs and icon
113130
position="left"
114131
[zIndex]="1"
115132
width="3rem"
116-
>&#8686;</ngx-scroll-top>
133+
>&#8686;</ngx-scroll-top
134+
>
117135
```
118136

119137
<a name="api"/>
@@ -136,29 +154,43 @@ Customization with optional inputs and icon
136154

137155
## Compatibility
138156

139-
| Angular version | @proangular/ngx-scroll-top | Install |
140-
| --------------- | -------------------------- | ------------------------------------------ |
141-
| v14 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` |
142-
| v13 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` |
143-
| v12 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` |
157+
| Angular version | @proangular/ngx-scroll-top | Status |
158+
| --------------- | -------------------------- | ---------- |
159+
| v19 | v19.0.0 | Compatible |
160+
| v18 | ------ | Untested |
161+
| v17 | ------ | Untested |
162+
| v16 | ------ | Untested |
163+
| v15 | ------ | Untested |
164+
| v14 | v1.x.x | Compatible |
165+
| v13 | v1.x.x | Compatible |
166+
| v12 | v1.x.x | Compatible |
144167

145168
<a name="development"/>
146169

147170
## Issues & Contribution
148171

149-
Please submit all issues, and feature requests here: [https://github.com/ProAngular/ngx-scroll-top/issues](https://github.com/ProAngular/ngx-scroll-top/issues)
172+
Please submit all issues, and feature requests here:
173+
[https://github.com/ProAngular/ngx-scroll-top/issues](https://github.com/ProAngular/ngx-scroll-top/issues)
150174

151175
Contribution:
152176

153177
1. Clone the repo and create a new branch:
154-
* `git clone https://github.com/ProAngular/ngx-scroll-top.git`
155-
* `git checkout -b username/feature-or-bug-description`
156-
2. Bump up the version of package in `package.json` and `package-lock.json`, commit all changes, push.
157-
* `git add -A`
158-
* `git commit -m "My commit message"`
159-
* `git push origin username/feature-or-bug-description`
160-
3. Submit code in published PR for review and approval. Add a good description and link any possible user stories or bugs.
161-
* [Create a new pull request](https://github.com/ProAngular/ngx-scroll-top/compare).
178+
179+
- `git clone https://github.com/ProAngular/ngx-scroll-top.git`
180+
- `git checkout -b username/feature-or-bug-description`
181+
182+
2. Bump up the version of package in `package.json` and `package-lock.json`,
183+
commit all changes, push.
184+
185+
- `git add -A`
186+
- `git commit -m "My commit message"`
187+
- `git push origin username/feature-or-bug-description`
188+
189+
3. Submit code in published PR for review and approval. Add a good description
190+
and link any possible user stories or bugs.
191+
192+
- [Create a new pull request](https://github.com/ProAngular/ngx-scroll-top/compare).
193+
162194
4. Allow CI actions to completely run and verify files.
163195
5. Add/ping reviewers and await approval.
164196

@@ -168,9 +200,11 @@ Thank you for any and all contributions!
168200

169201
## Donation
170202

171-
As a husband and father of four children, your donations mean the world to me! Any donations are greatly appreciated and keep me going!
172-
* [https://www.paypal.me/CodyTolene](https://www.paypal.me/CodyTolene)
173-
* [https://github.com/sponsors/ProAngular](https://github.com/sponsors/ProAngular)
203+
As a husband and father of four children, your donations mean the world to me!
204+
Any donations are greatly appreciated and keep me going!
205+
206+
- [https://www.paypal.me/CodyTolene](https://www.paypal.me/CodyTolene)
207+
- [https://github.com/sponsors/ProAngular](https://github.com/sponsors/ProAngular)
174208

175209
<a name="license"/>
176210

0 commit comments

Comments
 (0)