ngx-fast-marquee - npm Package Compare versions

Comparing version 0.1.8 to 0.2.0

package.json

 {
   "name": "ngx-fast-marquee",
-  "version": "0.1.8",
+  "version": "0.2.0",
   "author": {
@@ -5,0 +5,0 @@ "name": "Julian Andres Gomez Gomez",

README.md

@@ -1,24 +0,108 @@
-# NgxFastMarquee
+# Ngx Fast Marquee
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 12.0.5.
+[![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg)](https://your-build-url.com)
+[![License](https://img.shields.io/badge/license-MIT-orange.svg)](https://opensource.org/licenses/MIT)
 
-## Code scaffolding
+## Description
 
-Run `ng generate component component-name --project ngx-fast-marquee` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project ngx-fast-marquee`.
-> Note: Don't forget to add `--project ngx-fast-marquee` or else it will be added to the default project in your `angular.json` file. 
+Want to bring your website to life with dynamic, eye-catching marquees?
 
-## Build
+Look no further! The ✨ **Ngx Fast Marquee** ✨ is a lightweight component that can bring to life your Angular applications through fast and user-friendly marquee animations. 
 
-Run `ng build ngx-fast-marquee` to build the project. The build artifacts will be stored in the `dist/` directory.
+See the Demo section below for a live example!
 
-## Publishing
+## 🖥️ Demo
+See  **Ngx Fast Marquee** in action!
+- 📱 <a href="https://ngx-fast-marquee.web.app/" target="_blank">Web Demo</a>
+- 🎮 <a href="https://stackblitz.com/edit/stackblitz-starters-m8pkwe?file=src%2Fmain.ts" target="_blank">StackBlitz</a>
 
-After building your library with `ng build ngx-fast-marquee`, go to the dist folder `cd dist/ngx-fast-marquee` and run `npm publish`.
+## 🛠️ Installation
 
-## Running unit tests
+Install the library using your favorite package manager:
 
-Run `ng test ngx-fast-marquee` to execute the unit tests via [Karma](https://karma-runner.github.io).
+- npm
 
-## Further help
+```bash
+npm i ngx-fast-marquee
+```
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+- pnpm
+
+```bash
+pnpm i ngx-fast-marquee
+```
+
+- yarn
+
+```bash
+yarn add ngx-fast-marquee
+```
+
+- bun
+
+```bash
+bun add ngx-fast-marquee
+```
+
+### Angular Compatibility
+
+| Angular Version | Library Version                   |
+| --------------- | ------------------------- |
+| `>=12`           | `0.2.0`  |
+
+## 🚀 Getting Started
+
+Import the `NgxFastMarqueeModule` in your `AppModule`:
+
+```typescript
+import { NgxFastMarqueeModule } from "ngx-fast-marquee";
+
+@NgModule({
+  declarations: [AppComponent],
+  imports: [BrowserModule, NgxFastMarqueeModule],
+  bootstrap: [AppComponent],
+})
+export class AppModule {}
+```
+
+Use the `ngx-fast-marquee` component in your templates:
+
+```html
+<ngx-fast-marquee>
+  <div>Item 1</div>
+  <div>Item 2</div>
+  <div>Item 3</div>
+  <div>Item 4</div>
+  <div>Item 5</div>
+</ngx-fast-marquee>
+```
+
+## 📚 Documentation
+
+Marquee Inputs:
+
+| Name                   | Type    | Default | Description
+| ---------------------- | ------- | ------- | -----------
+| `speed`                | number  | `medium`    | The speed of the marquee in pixels per second. Also can be qualitative, `fast`, `medium`, `slow`.
+| `direction`            | string  | `left`  | The direction of the marquee (`left`, `right`, `up`, `down`).
+| `autoFill`             | boolean | `true`  | `true` for auto filling the space.
+| `useSystemReducedMotion` | boolean | `false` | `true` for avoid animate the marquee when the system has reduced motion.
+| `maskStartPercentage`  | number  | `0`     | Start percentage of the mask. Suitable Range: 0 - 100, where 100 is the middle of the marquee.
+| `maskEndPercentage`    | number  | `0`     | End percentage of the mask. Suitable Range: 0 - 100, where 100 is the middle of the marquee.
+| `maskPercentage`       | number  | `0`     | Percentage of the mask. Suitable Range: 0 - 100, where 100 is the middle of the marquee (start to center and end to the center).
+| `play`                 | boolean | `true`  | `true` for playing the marquee animation, otherwise the animation is paused.
+| `pauseOnClick`         | boolean | `false` | `true` for pausing the marquee when the cursor is held down on the marquee.
+| `pauseOnHover`         | boolean | `false` | `true` for Pausing the marquee when the mouse is over it.
+
+
+Marquee Outputs:
+
+| Name                   | Description
+| ---------------------- | -----------
+| `mounted`              | Event emitted when the marquee is in the view. Emitted only once.
+| `updated`              | Event emitted each time the marquee is updated.
+
+
+## 📄 License
+
+This project is licensed under the MIT License.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

301500

increased by0.86%

Number of lines in readme file

109

increased by336%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes