summaryrefslogtreecommitdiffstats
path: root/catalog-ui/app/third-party/ng-infinite-scroll/README.md
diff options
context:
space:
mode:
authorMichael Lando <ml636r@att.com>2017-02-19 10:28:42 +0200
committerMichael Lando <ml636r@att.com>2017-02-19 10:51:01 +0200
commit451a3400b76511393c62a444f588a4ed15f4a549 (patch)
treee4f5873a863d1d3e55618eab48b83262f874719d /catalog-ui/app/third-party/ng-infinite-scroll/README.md
parent5abfe4e1fb5fae4bbd5fbc340519f52075aff3ff (diff)
Initial OpenECOMP SDC commit
Change-Id: I0924d5a6ae9cdc161ae17c68d3689a30d10f407b Signed-off-by: Michael Lando <ml636r@att.com>
Diffstat (limited to 'catalog-ui/app/third-party/ng-infinite-scroll/README.md')
-rw-r--r--catalog-ui/app/third-party/ng-infinite-scroll/README.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/catalog-ui/app/third-party/ng-infinite-scroll/README.md b/catalog-ui/app/third-party/ng-infinite-scroll/README.md
new file mode 100644
index 0000000000..aa8d8630e2
--- /dev/null
+++ b/catalog-ui/app/third-party/ng-infinite-scroll/README.md
@@ -0,0 +1,71 @@
+[**Maintainer help needed**: I'm looking for fellows that are willing to help me maintain and improve this project.](https://github.com/sroze/ngInfiniteScroll/issues/267)
+
+---
+
+![logo](http://sroze.github.com/ngInfiniteScroll/images/logo-resized.png)
+
+[![Build Status](https://travis-ci.org/sroze/ngInfiniteScroll.png?branch=master)](https://travis-ci.org/sroze/ngInfiniteScroll)
+
+ngInfiniteScroll is a directive for [AngularJS](http://angularjs.org/) to evaluate an expression when the bottom of the directive's element approaches the bottom of the browser window, which can be used to implement infinite scrolling.
+
+Demos
+-----
+
+Check out the running demos [at the ngInfiniteScroll web site](http://sroze.github.com/ngInfiniteScroll/demos.html).
+
+Version Numbers
+---------------
+
+ngInfinite Scroll follows [semantic versioning](http://semver.org/) and uses the following versioning scheme:
+
+ * Versions starting with 0 (e.g. 0.1.0, 0.2.0, etc.) are for initial development, and the API is not stable
+ * Versions with an even minor version (1.0.0, 1.4.0, 2.2.0, etc.) are stable releases
+ * Versions with an odd minor version (1.1.0, 1.3.0, 2.1.0, etc.) are development releases
+
+The [download page](http://sroze.github.com/ngInfiniteScroll/#download) allows you to pick among various versions and specify which releases are stable (not including pre-release builds).
+
+Getting Started
+---------------
+
+ * Download ngInfiniteScroll from [the download page on the ngInfiniteScroll web site](http://sroze.github.com/ngInfiniteScroll/#download) or install it with:
+ * [Bower](http://bower.io/) via `bower install ngInfiniteScroll`
+ * [NPM](https://www.npmjs.com) via `npm install --save ng-infinite-scroll`
+ * [Nuget](https://www.nuget.org) via `PM> Install-Package ng-infinite-scroll`
+ * Include the script tag on your page after the AngularJS script tag (ngInfiniteScroll *doesn't* require jQuery)
+
+ <script type='text/javascript' src='path/to/angular.min.js'></script>
+ <script type='text/javascript' src='path/to/ng-infinite-scroll.min.js'></script>
+
+ * Ensure that your application module specifies `infinite-scroll` as a dependency:
+
+ angular.module('myApplication', ['infinite-scroll']);
+
+ * Use the directive by specifying an `infinite-scroll` attribute on an element.
+
+ <div infinite-scroll="myPagingFunction()" infinite-scroll-distance="3"></div>
+
+Note that neither the module nor the directive use the `ng` prefix, as that prefix is reserved for the core Angular module.
+
+Detailed Documentation
+----------------------
+
+ngInfiniteScroll accepts several attributes to customize the behavior of the directive; detailed instructions can be found [on the ngInfiniteScroll web site](http://sroze.github.com/ngInfiniteScroll/documentation.html).
+
+Ports
+-----
+
+If you use [AngularDart](https://github.com/angular/angular.dart), Juha Komulainen has [a port of the project](http://pub.dartlang.org/packages/ng_infinite_scroll) you can use.
+
+License
+-------
+
+ngInfiniteScroll is licensed under the MIT license. See the LICENSE file for more details.
+
+Testing
+-------
+
+ngInfiniteScroll uses Protractor for testing. Note that you will need to have Chrome browser, and the `grunt-cli` npm package installed globally if you wish to use grunt (`npm install -g grunt-cli`). Then, install the dependencies with `npm install`.
+
+* `grunt test:protractor-local` - run tests
+
+Thank you very much @pomerantsev for your work on these Protractor tests.