Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonnybgod/ngx-scrollspy
Angular ScrollSpy Service
https://github.com/jonnybgod/ngx-scrollspy
affix angular angular2 angular2-service aot index-generator infinite-scroll ng2-scrollspy ngx-scrollspy parallax parallax-scrolling scrollspy sticky
Last synced: 13 days ago
JSON representation
Angular ScrollSpy Service
- Host: GitHub
- URL: https://github.com/jonnybgod/ngx-scrollspy
- Owner: JonnyBGod
- License: mit
- Created: 2016-03-15T04:03:01.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-22T17:46:17.000Z (about 6 years ago)
- Last Synced: 2024-05-22T04:31:21.450Z (6 months ago)
- Topics: affix, angular, angular2, angular2-service, aot, index-generator, infinite-scroll, ng2-scrollspy, ngx-scrollspy, parallax, parallax-scrolling, scrollspy, sticky
- Language: TypeScript
- Homepage:
- Size: 275 KB
- Stars: 94
- Watchers: 7
- Forks: 21
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/ngx-scrollspy)
[](https://travis-ci.org/JonnyBGod/ngx-scrollspy)
[](https://www.codacy.com/app/jonnybgod/ngx-scrollspy?utm_source=github.com&utm_medium=referral&utm_content=JonnyBGod/ngx-scrollspy&utm_campaign=Badge_Grade)
[](https://coveralls.io/github/JonnyBGod/ngx-scrollspy?branch=master)
[](https://david-dm.org/JonnyBGod/ngx-scrollspy#info=devDependencies)
[](https://npmjs.org/package/ngx-scrollspy)
You can use this angular2 service to spy scroll events from ```window``` or any other scrollable element.
This library implements an service to collect observables from scroll spy directives. It can be used to create you own components or if you prefer use on of the following components that leverage this library functionality to accomplish different behaviors:
* **index**: create and display and index from content inside and element.
* **affix**: make element follow scroll inside its parent.
* **parallax**: create very simple parallax effects based on scroll.
* **infinite**: infinite scroll
# Repository change
Please not that the repository and npm package changed from *ng2-scrollspy* to *ngx-scrollspy*
## Installation
First you need to install the npm module:
```sh
npm install ngx-scrollspy --save
```
If you use SystemJS to load your files, you might have to update your config with this if you don't use `defaultJSExtensions: true`:
```js
System.config({
packages: {
"ngx-scrollspy": {"defaultExtension": "js"}
}
});
```
Finally, you can use ngx-scrollspy in your Angular 2 project.
It is recommended to instantiate `ScrollSpyService` in the bootstrap of your application and to never add it to the "providers" property of your components, this way you will keep it as a singleton.
If you add it to the "providers" property of a component it will instantiate a new instance of the service that won't be initialized.
```js
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { ScrollSpyModule } from 'ngx-scrollspy';
@NgModule({
imports: [
BrowserModule,
ScrollSpyModule.forRoot()
],
declarations: [ AppComponent ],
bootstrap: [ AppComponent ]
})
```
## Using
#### Spy window scroll
Use ```ScrollSpyDirective``` to spy on window.
```js
import { NgModule, Component, Injectable, AfterViewInit } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { ScrollSpyModule, ScrollSpyService } from 'ngx-scrollspy';
@Injectable()
@Component({
selector: 'app',
template: `
`
})
export class AppComponent implements AfterViewInit {
constructor(private scrollSpyService: ScrollSpyService) {}
ngAfterViewInit() {
this.scrollSpyService.getObservable('window').subscribe((e: any) => {
console.log('ScrollSpy::window: ', e);
});
}
}
@NgModule({
imports: [
BrowserModule,
ScrollSpyModule.forRoot()
],
declarations: [
AppComponent
],
bootstrap: [ AppComponent ]
})
```
#### Spy any element scroll
Use ```ScrollSpyElementDirective``` to spy on any element. You must give an unique id to each instance.
```js
import { NgModule, Component, Injectable, AfterViewInit } from '@angular/core';
import { ScrollSpyModule, ScrollSpyService } from 'ngx-scrollspy';
@Injectable()
@Component({
selector: 'yourComponent',
template: `
`
})
export class YourComponent implements AfterViewInit {
constructor(private scrollSpyService: ScrollSpyService) {}
ngAfterViewInit() {
this.scrollSpyService.getObservable('test').subscribe((e: any) => {
console.log('ScrollSpy::test: ', e);
});
}
}
@NgModule({
imports: [
ScrollSpyModule
],
declarations: [
AppComponent
],
providers: [ ]
})
export class YourModule { }
```
Because ```ScrollSpyService``` is a singleton, you can get any ScrollSpy observable from anywhere withing your application.
# TODO:
* Documentation/examples webpage
* Finish unit tests
## License
[MIT](LICENSE)