README.md

InView Directive for AngularJS

A directive to evaluate an expression if a DOM element is or not in the current visible browser viewport.

The directive is directly derived from the jQuery.inview plugin. However this implementation has no dependency on jQuery.

Intallation

To install using Bower:

bower install angular-inview

Setup

In your document include this scripts:

<script src="/bower_components/angular/angular.js"></script>
<script src="/bower_components/angular-inview/angular-inview.js"></script>

In your AngularJS app, you'll need to import the angular-inview module:

angular.module('myModule', ['angular-inview']);

Usage

This module will define a single directive inView that may be used as an attribute.

<any in-view="{expression}" in-view-offset="{number}"></any>

The in-view attribute must contain a valid AngularJS expression to work. When the DOM element enter or exits the viewport, the expression will be evaluated. To actually check if the element is in view, the following data is available in the expression:

• $inview is a boolean value indicating if the DOM element is in view
• $inviewpart is undefined or a string either top, bottom or both indicating which part of the DOM element is visible.

An additional attribute in-view-offset can be speficied to add a virtual offset to the element that will anticipate or delay the in view event.

Testing

To run tests, install Karma and run: karma start.