Skip to content

Commit

Permalink
docs(readme): add ng18 info
Browse files Browse the repository at this point in the history
  • Loading branch information
bartholomej committed Jun 14, 2024
1 parent f0db161 commit 68cfccd
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 23 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@
> No dependencies.
> **Pure Angular!**
> **Angular 17**, Angular Universal (**SSR**) a **Standalone Components** compatible
> **Angular 18**, Angular Universal (**SSR**) a **Standalone Components** compatible
Just hit the button to smoothly scroll back to the top of the page. [Here's the demo.](http://bartholomej.github.io/ngx-scrolltop/)

- Lightweight _(~2 kB gzipped)_
- **Angular 17** compatible
- **Angular 18** compatible
- **Standalone Components** compatible
- Signals compatible
- No dependencies! _(only smooth scroll-behavior polyfill for iOS)_
Expand Down Expand Up @@ -53,15 +53,16 @@ npm install ngx-scrolltop --save # for lastest Angular only! See our compatibili

### Compatibility

| Angular version | ngx-scrolltop | Install |
| --------------- | ------------- | ----------------------------- |
| ng17 | v17.x.x | `ng add ngx-scrolltop@latest` |
| ng16 | v6.x.x | `ng add ngx-scrolltop@6` |
| ng15 | v6.x.x | `ng add ngx-scrolltop@6` |
| ng14 | v4.x.x | `ng add ngx-scrolltop@4` |
| ng13 | v4.x.x | `ng add ngx-scrolltop@4` |
| ng12 | v4.x.x | `ng add ngx-scrolltop@4` |
| ng5 – ng11 | v2.x.x | `ng add ngx-scrolltop@2` |
| Angular version | ngx-scrolltop | Install |
| --------------- | ------------- | ---------------------------------- |
| ng18 | v18.x.x | `npm install ngx-scrolltop@latest` |
| ng17 | v17.x.x | `npm install ngx-scrolltop@17` |
| ng16 | v6.x.x | `ng add ngx-scrolltop@6` |
| ng15 | v6.x.x | `ng add ngx-scrolltop@6` |
| ng14 | v4.x.x | `ng add ngx-scrolltop@4` |
| ng13 | v4.x.x | `ng add ngx-scrolltop@4` |
| ng12 | v4.x.x | `ng add ngx-scrolltop@4` |
| ng5 – ng11 | v2.x.x | `ng add ngx-scrolltop@2` |

## 🗜️ Setup and usage (`Standalone` or `Modules`)

Expand Down
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,9 @@
"angular15",
"angular16",
"angular17",
"angular18",
"standalone",
"signals",
"smooth",
"esm",
"sass"
Expand All @@ -121,4 +124,4 @@
"publishConfig": {
"registry": "https://registry.npmjs.org"
}
}
}
23 changes: 12 additions & 11 deletions projects/ngx-scrolltop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@
> No dependencies.
> **Pure Angular!**
> **Angular 17**, Angular Universal (**SSR**) a **Standalone Components** compatible
> **Angular 18**, Angular Universal (**SSR**) a **Standalone Components** compatible
Just hit the button to smoothly scroll back to the top of the page. [Here's the demo.](http://bartholomej.github.io/ngx-scrolltop/)

- Lightweight _(~2 kB gzipped)_
- **Angular 17** compatible
- **Angular 18** compatible
- **Standalone Components** compatible
- Signals compatible
- No dependencies! _(only smooth scroll-behavior polyfill for iOS)_
Expand Down Expand Up @@ -53,15 +53,16 @@ npm install ngx-scrolltop --save # for lastest Angular only! See our compatibili

### Compatibility

| Angular version | ngx-scrolltop | Install |
| --------------- | ------------- | ----------------------------- |
| ng17 | v17.x.x | `ng add ngx-scrolltop@latest` |
| ng16 | v6.x.x | `ng add ngx-scrolltop@6` |
| ng15 | v6.x.x | `ng add ngx-scrolltop@6` |
| ng14 | v4.x.x | `ng add ngx-scrolltop@4` |
| ng13 | v4.x.x | `ng add ngx-scrolltop@4` |
| ng12 | v4.x.x | `ng add ngx-scrolltop@4` |
| ng5 – ng11 | v2.x.x | `ng add ngx-scrolltop@2` |
| Angular version | ngx-scrolltop | Install |
| --------------- | ------------- | ---------------------------------- |
| ng18 | v18.x.x | `npm install ngx-scrolltop@latest` |
| ng17 | v17.x.x | `npm install ngx-scrolltop@17` |
| ng16 | v6.x.x | `ng add ngx-scrolltop@6` |
| ng15 | v6.x.x | `ng add ngx-scrolltop@6` |
| ng14 | v4.x.x | `ng add ngx-scrolltop@4` |
| ng13 | v4.x.x | `ng add ngx-scrolltop@4` |
| ng12 | v4.x.x | `ng add ngx-scrolltop@4` |
| ng5 – ng11 | v2.x.x | `ng add ngx-scrolltop@2` |

## 🗜️ Setup and usage (`Standalone` or `Modules`)

Expand Down
3 changes: 3 additions & 0 deletions projects/ngx-scrolltop/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@
"angular15",
"angular16",
"angular17",
"angular18",
"standalone",
"signals",
"smooth",
"esm",
"sass"
Expand Down

0 comments on commit 68cfccd

Please sign in to comment.