This project was generated with Angular CLI version 1.5.4.

A simple lightweight library for Angular that detects when an element is within the browser viewport and adds a sn-viewport-in or sn-viewport-out class to the element.

This is a simple library for Angular, implemented in the Angular Package Format v5.0.

npm i @thisissoon/angular-inviewport --save

yarn add @thisissoon/angular-inviewport

app.module.ts

import { InViewportModule } from '@thisissoon/angular-inviewport';

const providers = [
  { provide: WindowRef, useValue: window }
];

@NgModule({
  imports: [
    // provide WindowRef class by using an window object
    InViewportModule.forRoot(providers)
  ]
})
export class AppModule { }

app.server.module.ts // Only required if using Angular Universal

import { InViewportModule } from '@thisissoon/angular-inviewport';

@NgModule({
  imports: [
    // no need to pass any arguments to forRoot
    // function for server module
    InViewportModule.forRoot()
  ]
})
export class AppServerModule { }

<p class="foo" snInViewport>Amet tempor excepteur occaecat nulla.</p>

.foo {
  transition: transform .35s ease-out;
}

.foo.sn-viewport-out {
  transform: translateY(-30px);
}

.foo.sn-viewport-in {
  transform: translateY(0);
}

<p class="foo" snInViewport (inViewportChange)="onInViewportChange($event)">
  Amet tempor excepteur occaecat nulla.
</p>

export class AppComponent {
  highlight = false;

  onInViewportChange(inViewport: boolean) {
    this.highlight = inViewport;
  }
}

.highlight {
  background-color: yellow;
}

<p class="foo" snInViewport [debounce]="500">
  Amet tempor excepteur occaecat nulla.
</p>

Useful if element is within another scrollable element

<div #container>
  <p class="foo" snInViewport [debounce]="500" [parent]="container">
    Amet tempor excepteur occaecat nulla.
  </p>
</div>

Window scroll and resize events doesn't cover all potential use cases for the inViewport status check. For example if using directive inside a carousel. To trigger a check manually simply assign a template variable value to the directive and call calculateInViewportStatus when you require.

<p snInViewport #foo="snInViewport">
  Amet tempor excepteur occaecat nulla.
</p>

<button (click)="foo.calculateInViewportStatus()">Check status</button>

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.

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.

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.

Run ng test to execute the unit tests via Karma.

Run ng e2e to execute the end-to-end tests via Protractor.

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.

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.

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.