Skip to content

Commit ac35f03

Browse files
authored
v20.4.0 - NPM OIDC
* README updates and version bump * README updates * Package updates: token > OIDC * Quick readme update.
1 parent 2951021 commit ac35f03

File tree

4 files changed

+92
-70
lines changed

4 files changed

+92
-70
lines changed

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

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
1-
# npmjs Package Deployment
2-
# https://docs.npmjs.com/about-packages-and-modules
3-
41
name: Verify and Deploy to npmjs
2+
3+
permissions:
4+
id-token: write
5+
contents: read
6+
57
on:
68
push:
7-
branches:
8-
- main
9+
tags:
10+
- 'v*'
11+
912
jobs:
1013
deploy_npmjs_package:
1114
runs-on: ubuntu-latest
1215
steps:
1316
- uses: actions/checkout@v4
17+
1418
- uses: actions/setup-node@v4
1519
with:
1620
node-version: '20.x'
1721
registry-url: 'https://registry.npmjs.org'
22+
23+
- name: Update npm to latest
24+
run: npm install -g npm@latest
1825
- run: npm ci
1926
- run: npm run npm-build-package
2027
- run: cd dist/npm && npm publish
21-
env:
22-
NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

README.md

Lines changed: 74 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -3,77 +3,94 @@
33
<img src="https://raw.githubusercontent.com/ProAngular/ngx-scroll-top/refs/heads/main/public/images/pro-angular-logo.png" />
44
</a>
55
<h1 align="center">
6-
<a href="https://www.ProAngular.com" target="_blank">Pro Angular</a>: ngx-scroll-top
6+
@proangular/ngx-scroll-top
77
</h1>
8-
<a align="center" href="https://github.com/ProAngular/ngx-scroll-top" target="_blank">
9-
View GitHub Repository
10-
</a>
118
<p align="center">
12-
Configurable, lightweight back to top button for Angular projects.
9+
<a href="https://github.com/ProAngular/ngx-scroll-top" target="_blank">
10+
ProAngular
11+
</a>&nbsp;&nbsp;|&nbsp;&nbsp;
12+
<a href="https://github.com/ProAngular/ngx-scroll-top" target="_blank">
13+
GitHub Repo
14+
</a>&nbsp;&nbsp;|&nbsp;&nbsp;
15+
<a href="https://www.npmjs.com/@proangular/ngx-scroll-top" target="_blank">
16+
NPM Package
17+
</a>&nbsp;&nbsp;|&nbsp;&nbsp;
18+
<a href="https://www.ProAngular.com/demos/ngx-scroll-top" target="_blank">
19+
Demo Page
20+
</a>
21+
</p>
22+
<p align="center">
23+
A simple, configurable, lightweight back to top button for your Angular projects.
1324
</p>
1425
</div>
1526

16-
[![npm](https://badgen.net/badge/icon/npm?icon=npm&label)](https://www.npmjs.com/@proangular/ngx-scroll-top)
17-
[![GitHub](https://badgen.net/badge/icon/GitHub?icon=github&label)](https://github.com/ProAngular/ngx-scroll-top)
18-
[![TypeScript](https://badgen.net/badge/icon/TypeScript?icon=typescript&label)](https://github.com/ProAngular/ngx-scroll-top/search?l=typescript)
19-
[![npm Version](https://badge.fury.io/js/@proangular%2Fngx-scroll-top.svg)](https://www.npmjs.com/@proangular/ngx-scroll-top)
20-
[![Node Version](https://badgen.net/npm/node/@proangular/ngx-scroll-top)](https://www.npmjs.com/@proangular/ngx-scroll-top)
21-
[![Package Downloads](https://badgen.net/npm/dw/@proangular/ngx-scroll-top)](https://www.npmjs.com/@proangular/ngx-scroll-top)
22-
[![Size](https://img.shields.io/bundlephobia/minzip/@proangular/ngx-scroll-top.svg)](https://bundlephobia.com/result?p=ProAngular/ngx-scroll-top)
23-
[![Demo Status](https://badgen.net/badge/Demo/Online/green)](https://www.ProAngular.com/demos/ngx-scroll-top)
24-
[![Website Status](https://img.shields.io/website?down_color=lightgrey&down_message=Offline&label=Website&up_color=green&up_message=Online&url=https%3A%2F%2Fwww.proangular.com)](https://www.proangular.com)
25-
[![Gitter Chat](https://badges.gitter.im/ProAngular/lobby.svg)](https://gitter.im/ProAngular/community)
26-
[![Discord Chat](https://img.shields.io/discord/1003103094588055552?label=Discord)](https://discord.com/channels/1003103094588055552)
27-
[![Sponsors](https://img.shields.io/github/sponsors/proangular?label=Sponsors)](https://github.com/sponsors/ProAngular)
28-
[![License](https://img.shields.io/npm/l/express.svg?maxAge=2592000)](/LICENSE)
29-
[![GitHub Package Status](https://github.com/ProAngular/ngx-scroll-top/actions/workflows/on-merge-main-deploy-gpr.yml/badge.svg)](https://github.com/ProAngular/ngx-scroll-top/actions/workflows/on-merge-main-deploy-gpr.yml)
30-
[![npmjs Package Status](https://github.com/ProAngular/ngx-scroll-top/actions/workflows/on-merge-main-deploy-npmjs.yml/badge.svg)](https://github.com/ProAngular/ngx-scroll-top/actions/workflows/on-merge-main-deploy-npmjs.yml)
31-
32-
## Index <a name="index"></a>
33-
34-
- [Description](#description)
35-
- [Demo](#demo)
36-
- [Installation](#installation)
37-
- [Prerequisites](#prerequisites)
38-
- [Install Scroll Top Component](#install-scroll-top-component)
39-
- [Usage](#usage)
40-
- [Component API](#api)
41-
- [Compatibility](#compatibility)
42-
- [Issues & Contribution](#development)
43-
- [Licensing](#licensing)
44-
- [Wrapping Up](#wrapping-up)
45-
46-
## Description <a name="description"></a>
27+
<!---------------------------------------------------------------------------->
28+
<!---------------------------------------------------------------------------->
29+
<!---------------------------------------------------------------------------->
4730

48-
Configurable, lightweight back to top button for Angular projects.
31+
<p align="center">
32+
<a href="https://www.npmjs.com/@proangular/ngx-scroll-top" target="_blank">
33+
<img src="https://badge.fury.io/js/@proangular%2Fngx-scroll-top.svg" >
34+
</a>
35+
<a href="https://bundlephobia.com/result?p=ProAngular/ngx-scroll-top" target="_blank">
36+
<img src="https://img.shields.io/bundlephobia/minzip/@proangular/ngx-scroll-top.svg" >
37+
</a>
38+
<a href="/LICENSE" target="_blank">
39+
<img src="https://img.shields.io/npm/l/express.svg?maxAge=2592000" >
40+
</a>
41+
</p>
4942

50-
<p align="right">[ <a href="#index">Index</a> ]</p>
43+
<!--
44+
<p align="center">
45+
<a href="https://github.com/ProAngular/ngx-scroll-top/actions/workflows/on-merge-main-deploy-gpr.yml" target="_blank">
46+
<img src="https://github.com/ProAngular/ngx-scroll-top/actions/workflows/on-merge-main-deploy-gpr.yml/badge.svg" >
47+
</a>
48+
<a href="https://github.com/ProAngular/ngx-scroll-top/actions/workflows/on-merge-main-deploy-npmjs.yml" target="_blank">
49+
<img src="https://github.com/ProAngular/ngx-scroll-top/actions/workflows/on-merge-main-deploy-npmjs.yml/badge.svg" >
50+
</a>
51+
</p>
52+
-->
5153

5254
<!---------------------------------------------------------------------------->
5355
<!---------------------------------------------------------------------------->
5456
<!---------------------------------------------------------------------------->
5557

56-
## Demo <a name="demo"></a>
57-
58+
<p align="center">
59+
<code>ng add @proangular/ngx-scroll-top</code>
60+
</p>
5861
<p align="center">
5962
<img src="https://raw.githubusercontent.com/ProAngular/ngx-scroll-top/refs/heads/main/public/images/demo-scroll-top.gif" />
6063
</p>
64+
<p align="center">
65+
<a href="https://www.ProAngular.com/demos/ngx-scroll-top" target="_blank">Click here to preview it live!</a>
66+
</p>
67+
68+
<!---------------------------------------------------------------------------->
69+
<!---------------------------------------------------------------------------->
70+
<!---------------------------------------------------------------------------->
6171

62-
Live demo here:
63-
[https://www.ProAngular.com/demos/ngx-scroll-top](https://www.ProAngular.com/demos/ngx-scroll-top)
72+
## 📇 Index <a name="index"></a>
6473

65-
<p align="right">[ <a href="#index">Index</a> ]</p>
74+
- [📦 Installation](#installation)
75+
- [📋 Prerequisites](#prerequisites)
76+
- [📥 Install Scroll Top Component](#install-scroll-top-component)
77+
- [💻 Usage](#usage)
78+
- [📚 Component API](#api)
79+
- [🔄 Compatibility](#compatibility)
80+
- [🤝 Issues & Contribution](#development)
81+
- [⚖️ Licensing](#licensing)
82+
- [🏁 Wrapping Up](#wrapping-up)
6683

6784
<!---------------------------------------------------------------------------->
6885
<!---------------------------------------------------------------------------->
6986
<!---------------------------------------------------------------------------->
7087

71-
## Installation <a name="installation"></a>
88+
## 📦 Installation <a name="installation"></a>
7289

7390
Using Node Package Manager ([NPM][url-node-js]) in a new terminal window run the
7491
following commands to install the required dependencies.
7592

76-
### Prerequisites <a name="prerequisites"></a>
93+
### 📋 Prerequisites <a name="prerequisites"></a>
7794

7895
**Angular Material**
7996

@@ -84,7 +101,7 @@ https://material.angular.io/guide/theming
84101
ng add @angular/material
85102
```
86103

87-
### Install Scroll Top Component <a name="install-scroll-top-component"></a>
104+
### 📥 Install Scroll Top Component <a name="install-scroll-top-component"></a>
88105

89106
```bash
90107
ng add @proangular/ngx-scroll-top@latest
@@ -96,13 +113,13 @@ or
96113
npm install @proangular/ngx-scroll-top --save
97114
```
98115

99-
<p align="right">[ <a href="#index">Index</a> ]</p>
116+
<p align="right">[ <a href="#index">🔍 Index</a> ]</p>
100117

101118
<!---------------------------------------------------------------------------->
102119
<!---------------------------------------------------------------------------->
103120
<!---------------------------------------------------------------------------->
104121

105-
## Usage <a name="usage"></a>
122+
## 💻 Usage <a name="usage"></a>
106123

107124
Default (blue button with white icon)
108125

@@ -127,13 +144,13 @@ Customization with optional inputs and icon
127144
>
128145
```
129146

130-
<p align="right">[ <a href="#index">Index</a> ]</p>
147+
<p align="right">[ <a href="#index">🔍 Index</a> ]</p>
131148

132149
<!---------------------------------------------------------------------------->
133150
<!---------------------------------------------------------------------------->
134151
<!---------------------------------------------------------------------------->
135152

136-
## Component API <a name="api"></a>
153+
## 📚 Component API <a name="api"></a>
137154

138155
| Input | Value Typing | Default Value | Description |
139156
| ---------------------- | --------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -147,13 +164,13 @@ Customization with optional inputs and icon
147164
| **width** | string | `'40px'` | Width of back to top button in string px format. |
148165
| **zIndex** | number | `999` | Style the `z-index` for the back to top button as needed for correct layer height adjustment. This can be useful when working with sticky headers. |
149166

150-
<p align="right">[ <a href="#index">Index</a> ]</p>
167+
<p align="right">[ <a href="#index">🔍 Index</a> ]</p>
151168

152169
<!---------------------------------------------------------------------------->
153170
<!---------------------------------------------------------------------------->
154171
<!---------------------------------------------------------------------------->
155172

156-
## Compatibility <a name="compatibility"></a>
173+
## 🔄 Compatibility <a name="compatibility"></a>
157174

158175
| Angular version | @proangular/ngx-scroll-top | Install |
159176
| --------------- | -------------------------- | ----------------------------------------- |
@@ -167,13 +184,13 @@ Customization with optional inputs and icon
167184
| v13 | v1.x.x | `ng add @proangular/ngx-scroll-top@1.1.8` |
168185
| v12 | v1.x.x | `ng add @proangular/ngx-scroll-top@1.1.8` |
169186

170-
<p align="right">[ <a href="#index">Index</a> ]</p>
187+
<p align="right">[ <a href="#index">🔍 Index</a> ]</p>
171188

172189
<!---------------------------------------------------------------------------->
173190
<!---------------------------------------------------------------------------->
174191
<!---------------------------------------------------------------------------->
175192

176-
## Issues & Contribution <a name="development"></a>
193+
## 🤝 Issues & Contribution <a name="development"></a>
177194

178195
Please submit all issues, and feature requests here:
179196
[https://github.com/ProAngular/ngx-scroll-top/issues](https://github.com/ProAngular/ngx-scroll-top/issues)
@@ -206,20 +223,20 @@ Thank you for any and all contributions!
206223
<!---------------------------------------------------------------------------->
207224
<!---------------------------------------------------------------------------->
208225

209-
## Licensing <a name="licensing"></a>
226+
## ⚖️ Licensing <a name="licensing"></a>
210227

211228
This project is licensed under the **MIT** License. See the
212229
[LICENSE](LICENSE.md) file for the pertaining license text.
213230

214231
`SPDX-License-Identifier: MIT`
215232

216-
<p align="right">[ <a href="#index">Index</a> ]</p>
233+
<p align="right">[ <a href="#index">🔍 Index</a> ]</p>
217234

218235
<!---------------------------------------------------------------------------->
219236
<!---------------------------------------------------------------------------->
220237
<!---------------------------------------------------------------------------->
221238

222-
## Wrapping Up <a name="wrapping-up"></a>
239+
## 🏁 Wrapping Up <a name="wrapping-up"></a>
223240

224241
Thank you to the entire Angular team and community for such a great framework to
225242
build upon. If you have any questions, please let me know by opening an issue

package-lock.json

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@proangular/ngx-scroll-top",
3-
"version": "20.3.6",
3+
"version": "20.4.0",
44
"description": "Configurable, lightweight back to top button for Angular projects.",
55
"author": "Pro Angular <webmaster@proangular.com>",
66
"homepage": "https://www.proangular.com",

0 commit comments

Comments
 (0)