https://github.com/srph/angular-infinite-scroll
A simple infinite scroll solution for AngularJS
https://github.com/srph/angular-infinite-scroll
angular angular-directive
Last synced: 10 months ago
JSON representation
A simple infinite scroll solution for AngularJS
- Host: GitHub
- URL: https://github.com/srph/angular-infinite-scroll
- Owner: srph
- License: mit
- Created: 2015-02-09T07:57:11.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2015-03-01T10:35:27.000Z (almost 11 years ago)
- Last Synced: 2025-04-15T00:16:13.886Z (10 months ago)
- Topics: angular, angular-directive
- Language: JavaScript
- Homepage: https://srph.github.io/angular-infinite-scroll
- Size: 426 KB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# angular-infinite-scroll
[](https://travis-ci.org/srph/angular-infinite-scroll) [](http://badge.fury.io/bo/angular-srph-infinite-scroll) [](http://opensource.org/licenses/MIT) [](http://semver.org/spec/v2.0.0.html) [](http://twitter.com/_srph)
A simple infinite scroll solution for AngularJS weighing < ```1 KB``` (minified).
## Content
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [API](#api)
- [Examples](#examples)
- [Support](#support)
- [Contribution](#contributing)
- [Building](#building)
- [Alternatives](#alternatives)
- [Changelogs](#changelogs)
## Getting Started
Getting started is very easy!
**Requirements**
- AngularJS ```>=v1.2.0``` (Should work with)
- jQuery (at least) ```>=v.1.7``` (Planned in the future to be removed)
### Installation
```angular-infinite-scroll``` is available on [**Bower**]:
```
$ bower install angular-srph-infinite-scroll --save
```
\* *The purpose of the ```--save``` argument is to add it your bower file's dependencies.*
```angular-infinite-scroll``` is also available on [**CDN**(s)]:
- **Raw GIT**
```html
```
**Include the script to your HTML file after jQuery and AngularJS (*must be in proper order*).**
```html
```
**Add the library module to one of your app module's dependencies.**
```js
angular.module('myApp', [/** other dependencies */, 'srph.infinite-scroll']);
```
### Usage
Use the directive on a container element.
```html
{{ apple.name }}
```
\* The `{ .. }` enclosures indicate that the parameter is optional.
### API
Head over to the [API Documentation](https://github.com/srph/angular-infinite-scroll/blob/master/docs/api.md) to see accepted parameters, and how to use each.
### Examples
Head over to the [examples page](http://srph.github.io/angular-infinite-scroll/) to help you get started!
## Contribution
All contributions are appreciated. Please simply file an issue first for any inquiry, proposal, or question to avoid closed pull-requests; useless work. Thanks!
```
========= ================
| issue | -> | pull-request |
========= ================
```
Pull-requests with test or without are both appreciated!
### Building
Please check [`docs/building`](https://github.com/srph/angular-infinite-scroll/edit/master/README.md)
## Alternatives
- [ng-scroller (`jankuca/ng-scroller`)](https://github.com/jankuca/ng-scroller)
- [ngInfiniteScroll (`sroze/ngInfiniteScroll`)](https://github.com/sroze/ngInfiniteScroll)
- [lrInfiniteScroll (`lorenzofox3/lrInfiniteScroll`](https://github.com/lorenzofox3/lrInfiniteScroll)
## Changelogs
See the [CHANGELOGS.md](https://github.com/srph/angular-infinite-scroll/blob/master/docs/CHANGELOG.md)
## Acknowledgement
Primarily motivated and almost based on [sroze/ngInfiniteScroll](https://github.com/sroze/ngInfiniteScroll).
**angular-infinite-scroll** © 2014+, Kier Borromeo (srph). Released under the [MIT](http://mit-license.org/) License.
> [srph.github.io](http://srph.github.io) ·
> GitHub [@srph](https://github.com/srph) ·
> Twitter [@_srph](https://twitter.com/_srph)