Now supports Angular 10+
ngx-scroll-event
An Angular 2+ directive to emit an event if scroll occurs on an element or window.
Features
- Detect scroll on an element or window and emits an event, also calculates if the user is reaching the top/bottom of that element or not.
Install
- With NPM
npm install ngx-scroll-event --save
- With Yarn
yarn add ngx-scroll-event
Usage
Import ScrollEvent and add it to the imports array of your module.
// app.module.ts;
In your template you may now add the libScrollEvent
attribute and (onscroll)
event to any element.
you can also add [bottomOffset]
or [topOffset]
to change when reaching bottom or top detection, bot values defaults to 100px, the value should be a number in pixels.
// app.awesome.component.ts ...;...
Code scaffolding
Run ng generate component component-name --project ngx-scroll-event
to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module --project ngx-scroll-event
.
Note: Don't forget to add
--project ngx-scroll-event
or else it will be added to the default project in yourangular.json
file.
Build
Run ng build ngx-scroll-event
to build the project. The build artifacts will be stored in the dist/
directory.
Publishing
After building your library with ng build ngx-scroll-event
, go to the dist folder cd dist/ngx-scroll-event
and run npm publish
.
Running unit tests
Run ng test ngx-scroll-event
to execute the unit tests via Karma.
Further help
To get more help on the Angular CLI use ng help
or go check out the Angular CLI README.