@thisissoon/angular-infinite-scroll
v2.1.0
Published
Simple, lightweight infinite scrolling directive for Angular which emits an event when an element has been scrolled to the bottom
Downloads
190
Readme
Angular Infinite Scroll
A simple, lightweight infinite scrolling directive for Angular which emits an event when an element has been scrolled to the bottom.
This is a simple library for Angular, implemented in the Angular Package Format v5.0.
Install
npm i @thisissoon/angular-infinite-scroll --save
app.module.ts
import { InfiniteScrollModule } from '@thisissoon/angular-infinite-scroll';
@NgModule({
imports: [InfiniteScrollModule],
})
export class AppModule {}
Example
A working example can be found inside /src folder
app.component.html
<div
class="foo"
snInfiniteScroll
(scrollEnd)="onScrollEnd()"
[offset]="100"
[disabled]="disabled"
></div>
app.component.ts
export class AppComponent {
onScrollEnd() {
// Do something here
}
}
Options
offset
(number): distance in px from bottom of element to triggerscrollEnd
event (default: 0)disabled
(boolean): If true directive will not triggerscrollEnd
event
Development server
Run ng serve
for a dev server. Navigate to http://localhost:4200/
. The app will automatically reload if you change any of the source files.
Code scaffolding
Run ng generate component component-name
to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module
.
Build
Run ng build
to build the project. The build artifacts will be stored in the dist/
directory. Use the -prod
flag for a production build.
Running unit tests
Run ng test
to execute the unit tests via Karma.
Running end-to-end tests
Run ng e2e
to execute the end-to-end tests via Protractor.
Further help
To get more help on the Angular CLI use ng help
or go check out the Angular CLI README.
Making Commits
This repo uses Commitizen CLI and Conventional Changelog to create commits and generate changelogs. Instead of running git commit
run git cz
and follow the prompts. Changelogs will then be generated when creating new releases by running npm run release
.
Making Releases
Run npm run release
to create a new release. This will use Standard Version to create a new release. Standard Version will generate / update the changelog based on commits generated using Commitizen CLI, update the version number following semantic versioning rules and then commit and tag the commit for the release. Simply run git push --follow-tags origin master
.