angular-ui-scrollpoint

Add a 'ui-scrollpoint' class to elements when the page scrolls past them.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
angular-ui-scrollpoint
2932.1.17 years ago7 years agoMinified + gzip package size for angular-ui-scrollpoint in KB

Readme

ui-scrollpoint Build Status npm version Bower version Join the chat at https://gitter.im/angular-ui/ui-scrollpoint
Add a 'ui-scrollpoint' class to elements when the page scrolls past them.

Requirements

  • AngularJS

Usage

You can get it from Bower
bower install angular-ui-scrollpoint

Load the script files in your application:
<script type="text/javascript" src="bower_components/angular/angular.js"></script>
<script type="text/javascript" src="bower_components/angular-ui-scrollpoint/dist/scrollpoint.js"></script>

Add the specific module to your dependencies:
angular.module('myApp', ['ui.scrollpoint', ...])

Development

We use Karma and jshint to ensure the quality of the code. The easiest way to run these checks is to use grunt:
npm install -g gulp-cli
npm install && bower install
gulp

The karma task will try to open Firefox and Chrome as browser in which to run the tests. Make sure this is available or change the configuration in karma.conf.js

Gulp watch

gulp watch will automatically test your code and build a release whenever source files change.

How to release

Use gulp to bump version, build and create a tag. Then push to GitHub:
````sh gulp release --patch|--minor|--major git push --tags origin master # push everything to GitHub ````
Travis will take care of testing and publishing to npm's registry (bower will pick up the change automatically). Finally create a release on GitHub from the tag created by Travis.