ngx-scroll-signal
TypeScript icon, indicating that this package has built-in type declarations

0.1.0 • Public • Published

ngx-scroll-signal

This library helps you add page scroll signal on top or the left of your page.

Installation

npm install ngx-scroll-signal --save

Its that simple to use

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { NgxScrollSignalModule } from 'ngx-scroll-signal';
 
import { AppComponent } from './app.component';
 
@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    NgxScrollSignalModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }
`
 
# Options
 
| position      | type        | Set the position to be vertical or horizontal   | 'x' or '0' or 'horizontal'  | 'y' or '1' or 'vertical'  |
|-------------- |-------------- |------------------------------------------------ |---------------------------- |-------------------------- |
| base-color    | property      | Set the base color of the scroll signal line    | Hex or RGB or Color name    |                           |
| signal-color  | property      | Set the progress bar / filler color             | Hex or RGB or Color name    |                           |
| opacity       | property      | Sets the opacity of both base and signal color  |                             |                           |
| on-end        | event         | Event fired as a end of page flag               |                             |                           |
 
# Default
 
| base-color    | #ecf0f1  |
|-------------- |--------- |
| signal-color  | #2ecc71  |
 
 
# License
 
MIT

Package Sidebar

Install

npm i ngx-scroll-signal

Weekly Downloads

529

Version

0.1.0

License

MIT

Last publish

Collaborators

  • anas.firdousi