Skip to content

Commit

Permalink
doc: update readme's and change lib version to 0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
DevJaGz committed Dec 6, 2023
1 parent 4d5091c commit 144e4ee
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 33 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Ngx Fast Marquee
In progress...🚧
# Ngx Fast Marquee

> [!NOTE]
> More info can be found in the Library's [README.md](https://www.npmjs.com/package/ngx-fast-marquee)
[![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)

## Description

Want to bring your website to life with dynamic, eye-catching marquees?

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.
See [more](https://github.com/DevJaGz/app-fast-marquee/blob/master/projects/ngx-fast-marquee/README.md)
57 changes: 30 additions & 27 deletions projects/ngx-fast-marquee/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,16 @@

## Description

Welcome to the 🌟 Ngx Marquee Library 🌟! This library provides an easy-to-use and customizable marquee component for your Angular applications.
Want to bring your website to life with dynamic, eye-catching marquees?

<small style="font-size:12px">
Inspired by <a href="https://www.react-fast-marquee.com/" target="_blank">React-Fast-Marquee</a> <img src="https://www.react-fast-marquee.com//favicon.ico" alt="React.js Icon" width="16" height="16" style="transform: translateY(4px)">
</small>
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.

## 🖥️ Demo

<a href="https://stackblitz.com/edit/stackblitz-starters-m8pkwe?file=src%2Fmain.ts" target="_blank">
<img alt="Edit on StackBlitz" src="https://img.shields.io/badge/stackblitz-edit-blue?style=for-the-badge&logo=stackblitz">
</a>
See the Demo section below for a live example!

<a href="https://ngx-fast-marquee.web.app/" target="_blank">
<img alt="Web Page" src="https://img.shields.io/badge/web%20page-visit-blue?style=for-the-badge&logo=google-chrome">
</a>
## 🖥️ 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>

## 🛠️ Installation

Expand Down Expand Up @@ -49,7 +44,11 @@ yarn add ngx-fast-marquee
bun add ngx-fast-marquee
```

Note: For Angular versions lower than v17 can be installed using the `--legacy-peer-deps` flag to avoid peer dependency errors.
### Angular Compatibility

| Angular Version | Library Version |
| --------------- | ------------------------- |
| `>=12` | `0.2.0` |

## 🚀 Getting Started

Expand Down Expand Up @@ -80,25 +79,29 @@ Use the `ngx-fast-marquee` component in your templates:

## 📚 Documentation

In progress...🚧

Marquee Inputs:

- `speed` - The speed of the marquee in pixels per second. Also can be qualitative, `fast`, `medium`, `slow`. **Default:** `medium`.
- `direction` - The direction of the marquee (`left`, `right`, `up`, `down`).**Default:** `left`.
- `autoFill` - `true` for auto filling the space. **Default:** `true`.
- `useSystemReducedMotion` - `true` for avoid animate the marquee when the system has reduced motion. **Default:** `false`.
- `maskStartPercentage` - Start percentage of the mask. Suitable Range: 0 - 100, where 100 is the middle of the marquee. **Default:** `0`.
- `maskEndPercentage` - End percentage of the mask. Suitable Range: 0 - 100, where 100 is the middle of the marquee. **Default:** `0`.
- `maskPercentage` - Percentage of the mask. Suitable Range: 0 - 100, where 100 is the middle of the marquee (start to center and end to the center). **Default:** `0`.
- `play` - `true` for playing the marquee animation, otherwise the animation is paused. **Default:** `true`.
- `pauseOnClick` - `true` for pausing the marquee when the cursor is held down on the marquee. **Default:** `false`.
- `pauseOnHover` - `true` for Pausing the marquee when the mouse is over it. **Default:** `false`.
| 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:

- `mounted` - Event emitted when the marquee is in the view. Emitted only once.
- `updated` - Event emitted each time the marquee is updated.
| 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

Expand Down
4 changes: 2 additions & 2 deletions projects/ngx-fast-marquee/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ngx-fast-marquee",
"version": "0.1.8",
"version": "0.2.0",
"author": {
"name": "Julian Andres Gomez Gomez",
"email": "[email protected]",
Expand All @@ -11,7 +11,7 @@
"type": "git",
"url": "https://github.com/DevJaGz/app-fast-marquee.git"
},
"description": "This is a customazebale marquee component for angular based on react-fast-marquee",
"description": "Lightweight Angular Component that can bring to life your Angular applications through fast and user-friendly marquee animations.",
"keywords": [
"angular",
"marquee",
Expand Down

0 comments on commit 144e4ee

Please sign in to comment.