summaryrefslogtreecommitdiff
path: root/http/3rdParty/jquery-scrollstop-master/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'http/3rdParty/jquery-scrollstop-master/README.md')
-rw-r--r--http/3rdParty/jquery-scrollstop-master/README.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/http/3rdParty/jquery-scrollstop-master/README.md b/http/3rdParty/jquery-scrollstop-master/README.md
new file mode 100644
index 0000000..0a0f2b8
--- /dev/null
+++ b/http/3rdParty/jquery-scrollstop-master/README.md
@@ -0,0 +1,66 @@
+jquery-scrollstop
+=================
+
+This plugin fires two events on `window` when scrolling starts and stops:
+`scrollstart` and `scrollstop`.
+
+## Example
+
+The example shows a small box in the upper left that says "SCROLLING" and
+colors the body different colors when scrolling: http://ssorallen.com/jquery-scrollstop/
+
+## Usage
+
+`scrollstart` fires after the first scroll event and won't fire again until
+after a `scrollstop` event is fired.
+
+`scrollstop` fires after no `scroll` events have fired for 250 milliseconds.
+
+```js
+$(window)
+ .on("scrollstart", function() {
+ // Paint the world yellow when scrolling starts.
+ $(document.body).css({background: "yellow"});
+ })
+ .on("scrollstop", function() {
+ // Paint it all green when scrolling stops.
+ $(document.body).css({background: "green"});
+ })
+```
+
+### Configuration
+
+#### latency
+
+`latency` is the minimum time between the last scroll event and when the
+`scrollstop` event fires. Set `$.event.special.scrollstop.latency` to the
+desired number of milliseconds (default: 250).
+
+```js
+// Configure time between final scroll event and
+// `scrollstop` event to 650ms (default is 250ms).
+$.event.special.scrollstop.latency = 650;
+```
+
+##### latency per element
+
+Latency can be configured per-element by passing options when the event listener
+is bound. If multiple event listeners are bound to the same element, only the
+data from the first event listener will set the configuration.
+
+```js
+// Configure latency to 650ms for #scrolling-div
+$("#scrolling-div").on("scrollstop", {latency: 650}, function() { ... });
+```
+
+### jQuery Version Support
+
+The plugin is tested in jQuery 1.2.3+ and jQuery 2.0.3+.
+
+### Attribution
+
+James Padolsey's jQuery scrollstop plugin that fires an event when scrolling
+stops for minimum amount of time.
+
+Originally code copied from
+http://james.padolsey.com/javascript/special-scroll-events-for-jquery/