+
+
+ 
+
+
+ 
+
+
- Configurable, lightweight back to top button for Angular projects. + + ProAngular + | + + GitHub Repo + | + + NPM Package + | + + Demo Page + +
++ A simple, configurable, lightweight back to top button for your Angular projects.
-[](https://www.npmjs.com/@proangular/ngx-scroll-top) -[](https://github.com/ProAngular/ngx-scroll-top) -[](https://github.com/ProAngular/ngx-scroll-top/search?l=typescript) -[](https://www.npmjs.com/@proangular/ngx-scroll-top) -[](https://www.npmjs.com/@proangular/ngx-scroll-top) -[](https://www.npmjs.com/@proangular/ngx-scroll-top) -[](https://bundlephobia.com/result?p=ProAngular/ngx-scroll-top) -[](https://www.ProAngular.com/demos/ngx-scroll-top) -[](https://www.proangular.com) -[](https://gitter.im/ProAngular/community) -[](https://discord.com/channels/1003103094588055552) -[](https://github.com/sponsors/ProAngular) -[](/LICENSE) -[](https://github.com/ProAngular/ngx-scroll-top/actions/workflows/on-merge-main-deploy-gpr.yml) -[](https://github.com/ProAngular/ngx-scroll-top/actions/workflows/on-merge-main-deploy-npmjs.yml) - -## Index - -- [Description](#description) -- [Demo](#demo) -- [Installation](#installation) - - [Prerequisites](#prerequisites) - - [Install Scroll Top Component](#install-scroll-top-component) -- [Usage](#usage) -- [Component API](#api) -- [Compatibility](#compatibility) -- [Issues & Contribution](#development) -- [Licensing](#licensing) -- [Wrapping Up](#wrapping-up) - -## Description + + + -Configurable, lightweight back to top button for Angular projects. + -[ Index ]
+ -## Demo - +
+ ng add @proangular/ngx-scroll-top
+
+ Click here to preview it live! +
+ + + + -Live demo here: -[https://www.ProAngular.com/demos/ngx-scroll-top](https://www.ProAngular.com/demos/ngx-scroll-top) +## 📇 Index -[ Index ]
+- [📦 Installation](#installation) + - [📋 Prerequisites](#prerequisites) + - [📥 Install Scroll Top Component](#install-scroll-top-component) +- [💻 Usage](#usage) +- [📚 Component API](#api) +- [🔄 Compatibility](#compatibility) +- [🤝 Issues & Contribution](#development) +- [⚖️ Licensing](#licensing) +- [🏁 Wrapping Up](#wrapping-up) -## Installation +## 📦 Installation Using Node Package Manager ([NPM][url-node-js]) in a new terminal window run the following commands to install the required dependencies. -### Prerequisites +### 📋 Prerequisites **Angular Material** @@ -84,7 +101,7 @@ https://material.angular.io/guide/theming ng add @angular/material ``` -### Install Scroll Top Component +### 📥 Install Scroll Top Component ```bash ng add @proangular/ngx-scroll-top@latest @@ -96,13 +113,13 @@ or npm install @proangular/ngx-scroll-top --save ``` -[ Index ]
+[ 🔍 Index ]
-## Usage +## 💻 Usage Default (blue button with white icon) @@ -127,13 +144,13 @@ Customization with optional inputs and icon > ``` -[ Index ]
+[ 🔍 Index ]
-## Component API +## 📚 Component API | Input | Value Typing | Default Value | Description | | ---------------------- | --------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -147,13 +164,13 @@ Customization with optional inputs and icon | **width** | string | `'40px'` | Width of back to top button in string px format. | | **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. | -[ Index ]
+[ 🔍 Index ]
-## Compatibility +## 🔄 Compatibility | Angular version | @proangular/ngx-scroll-top | Install | | --------------- | -------------------------- | ----------------------------------------- | @@ -167,13 +184,13 @@ Customization with optional inputs and icon | v13 | v1.x.x | `ng add @proangular/ngx-scroll-top@1.1.8` | | v12 | v1.x.x | `ng add @proangular/ngx-scroll-top@1.1.8` | -[ Index ]
+[ 🔍 Index ]
-## Issues & Contribution +## 🤝 Issues & Contribution Please submit all issues, and feature requests here: [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! -## Licensing +## ⚖️ Licensing This project is licensed under the **MIT** License. See the [LICENSE](LICENSE.md) file for the pertaining license text. `SPDX-License-Identifier: MIT` -[ Index ]
+[ 🔍 Index ]
-## Wrapping Up +## 🏁 Wrapping Up Thank you to the entire Angular team and community for such a great framework to build upon. If you have any questions, please let me know by opening an issue diff --git a/package-lock.json b/package-lock.json index 26b9ca9..ca2ff51 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@proangular/ngx-scroll-top", - "version": "20.3.6", + "version": "20.4.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@proangular/ngx-scroll-top", - "version": "20.3.6", + "version": "20.4.0", "hasInstallScript": true, "license": "MIT", "devDependencies": { @@ -8844,9 +8844,9 @@ "license": "MIT" }, "node_modules/js-yaml": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", - "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", + "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", "dev": true, "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index d02a1d3..66e36f9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@proangular/ngx-scroll-top", - "version": "20.3.6", + "version": "20.4.0", "description": "Configurable, lightweight back to top button for Angular projects.", "author": "Pro Angular