https://github.com/angular-ui/ui-scrollpoint
Add a 'ui-scrollpoint' class to elements when the page scrolls past them.
https://github.com/angular-ui/ui-scrollpoint
Last synced: 4 months ago
JSON representation
Add a 'ui-scrollpoint' class to elements when the page scrolls past them.
- Host: GitHub
- URL: https://github.com/angular-ui/ui-scrollpoint
- Owner: angular-ui
- License: mit
- Archived: true
- Created: 2015-05-29T00:24:38.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-06-02T20:52:41.000Z (over 7 years ago)
- Last Synced: 2024-09-26T15:10:55.644Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://htmlpreview.github.io/?https://github.com/angular-ui/ui-scrollpoint/master/demo/index.html
- Size: 5.79 MB
- Stars: 28
- Watchers: 6
- Forks: 25
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ui-scrollpoint [](https://travis-ci.org/angular-ui/ui-scrollpoint) [](http://badge.fury.io/js/angular-ui-scrollpoint) [](http://badge.fury.io/bo/angular-ui-scrollpoint) [](https://gitter.im/angular-ui/ui-scrollpoint?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Add a 'ui-scrollpoint' class to elements when the page scrolls past them.
## Requirements
- AngularJS
## Usage
You can get it from [Bower](http://bower.io/)
```sh
bower install angular-ui-scrollpoint
```
Load the script files in your application:
```html
```
Add the specific module to your dependencies:
```javascript
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:
```sh
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](https://github.com/angular-ui/ui-scrollpoint/releases/new) from the tag created by Travis.