https://github.com/fredwu/jquery-endless-scroll
Endless/infinite scrolling/pagination.
https://github.com/fredwu/jquery-endless-scroll
Last synced: about 1 year ago
JSON representation
Endless/infinite scrolling/pagination.
- Host: GitHub
- URL: https://github.com/fredwu/jquery-endless-scroll
- Owner: fredwu
- Created: 2009-12-02T06:46:03.000Z (over 16 years ago)
- Default Branch: master
- Last Pushed: 2017-07-29T13:59:53.000Z (almost 9 years ago)
- Last Synced: 2025-03-28T07:04:03.286Z (about 1 year ago)
- Language: CoffeeScript
- Homepage: http://fredwu.github.com/jquery-endless-scroll/
- Size: 3.93 MB
- Stars: 838
- Watchers: 36
- Forks: 174
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Endless Scroll [](http://coderwall.com/fredwu)
#### If you encounter problems with scrolling up, please use the old [1.6.0 release](https://github.com/fredwu/jquery-endless-scroll/zipball/1.6.0). The code base is currently being rewritten on the [2.0-rewrite branch](https://github.com/fredwu/jquery-endless-scroll/tree/2.0-rewrite).
If you don't already know, [endless scrolling](http://www.google.com/search?q=endless+scroll) (or infinite scrolling or pagination) is a popular technique amongst modern websites such as [Google Reader](http://reader.google.com/) and [Live Image Search](http://www.live.com/?scope=images), whereby instead of paging through items using traditional pagination links, the page just keeps loading with new items attached to the end.
Endless Scroll not only helps you build highly customisable infinite scrolling effects, it also offers features not commonly seen. Such features include:
- The ability to up-scroll and prepend content to the beginning of the page
- The ability to limit the number of available 'pages', i.e. data truncation
- And there are more exciting features in the works, including SEO-friendly URLs!
## Configuration
There are a few options to customise the behaviour of this plugin:
Option
Type
Description
pagesToKeep
Integer
The number of 'pages' to keep before either end of the scrolling content are discarded, by default (value set to `null`) no content will be discarded.
inflowPixels
Integer
The number of pixels from the boundary of the element that triggers the event.
fireOnce
Boolean
Only fire once until the execution of the current event is completed.
fireDelay
Integer
Delays the subsequent firing, in milliseconds, 0 or false to disable delay.
loader
String
The HTML to be displayed during loading.
content
String or Function
Plain HTML content to insert after each call, can be either a string or a function that returns a string, when passed as a function it accepts three arguments:
-
fireSequence the number of times the event triggered during the current page session -
pageSequence a positive or negative value that represents the scroll direction sequence -
scrollDirection a string of either 'prev' or 'next'
insertBefore
String
jQuery selector syntax: where to put the loader as well as the plain HTML data.
insertAfter
String
jQuery selector syntax: where to put the loader as well as the plain HTML data.
intervalFrequency
Integer
Set the frequency of the scroll event checking, the larger the frequency number, the less memory it consumes - but also the less sensitive the event trigger becomes.
ceaseFireOnEmpty
Boolean
Ceases fire automatically when the content is empty, set it to `false` if you are using `callback` instead of `content` for loading content.
resetCounter
Function
Resets the fire sequence counter if the function returns true, this function could also perform hook actions since it is applied at the start of the event.
callback
Function
Callback function, accepts three arguments:
-
fireSequence the number of times the event triggered during the current page session -
pageSequence a positive or negative value that represents the scroll direction sequence -
scrollDirection a string of either 'prev' or 'next'
ceaseFire
Function
Stops the event (no more endless scrolling) if the function returns true, accepts three arguments:
-
fireSequence the number of times the event triggered during the current page session -
pageSequence a positive or negative value that represents the scroll direction sequence -
scrollDirection a string of either 'prev' or 'next'
## Usage
``` js
// using default options
$(window).endlessScroll();
// using some custom options
$("#images").endlessScroll({
fireOnce: false,
fireDelay: false,
loader: '
callback: function(p){
alert("test");
}
});
```
### Custom Loader Styles
You may customise the look and feel of the loader by changing:
- `.endless_scroll_loader` (class, for all Endless Scroll loaders);
- Or `#endless_scroll_loader_` (id, for the specific loader).
### Custom Style for the Most Recently Loaded Content
The most recently loaded content is wrapped in `#endless_scroll_content_current`.
## Demo
[Click here for a simple demo](http://fredwu.github.com/jquery-endless-scroll/).
## CoffeeScript and JavaScript
Endless Scroll, starting from v1.6.0 is written in [CoffeeScript](http://coffeescript.org/). To contribute and/or modify the source code, please edit `src/jquery.endless-scroll.coffee` and recompile the JavaScript. To include Endless Scroll in your webpage, please use the compiled `js/jquery.endless-scroll.js`.
The command for automatically compiling to JavaScript is:
```bash
coffee -w -b -o js/ -c src/
```
## Browser Support
All modern browsers (Firefox, Chrome, Safari, Opera, IE7+) should be supported. Please [open an issue](https://github.com/fredwu/jquery-endless-scroll/issues) if Endless Scroll doesn't work on a particular browser.
## Changelog
v1.8.0 [2012-04-17]
- Added `ceaseFireOnEmpty`.
- Added `pagesToKeep`.
- Fixed `$(window)` uses.
v1.7.1 [2012-04-16]
- Added `scrollDirection` to the callback arguments.
- Fixed the demo.
v1.7.0 [2012-04-16]
- Endless Scroll now supports infinite up-scrolling!
- Renamed `bottomPixels` option to `inflowPixels`.
- Added `insertBefore` option.
- Added `pageSequence` to the callback arguments.
- Fixed the unreliable `#endless_scroll_content_current` wrapper.
v1.6.0 [2012-04-15]
- Refactored the code using CoffeeScript.
- Renamed `data` option to `content`.
- Tweaked the demo page.
v1.5.1 [2012-03-08]
- Added `fireSequence` argument to `ceaseFire`.
- Added a `ceaseFire` example to the demo page.
- Fixed `loader`.
v1.5.0 [2012-03-08]
- Added `intervalFrequency` option.
- Endless Scroll should now consume less memory in most situations.
v1.4.8 [2011-11-18]
- Refactored default options merge to avert side effects.
v1.4.7 [2011-11-08]
- Compatibility fix for IE7 and IE8.
v1.4.6 [2011-10-26]
- Fixed an issue with inner_wrap and the first scroll event.
v1.4.5 [2011-09-25]
- `ceaseFire` now works as expected during a `scroll` event.
v1.4.4 [2011-06-28]
- The AJAX loader should be removed when there's no more results to load.
v1.4.3 [2011-06-28]
- The `data` option now accepts a fireSequence argument too.
v1.4.2 [2011-01-08]
- Fixed a bug where calling the script on `$(document)` would fail.
v1.4.1 [2010-06-18]
- Fixed a bug where the callback fires when the inner wrap hasn't been created.
v1.4 [2010-06-18]
- Endless Scroll now works with any elements, not just `$(document)`!
v1.3 [2009-04-20]
- Fixed a bug caused by `fireDelay`.
v1.2 [2009-01-16]
- Added `resetCounter` option.
v1.1 [2009-01-15]
- Added `fireDelay` option.
v1.0 [2009-01-15]
- Initial release.
## More jQuery Plugins
Check out my other jQuery plugins:
- [Inline Confirmation](https://github.com/fredwu/jquery-inline-confirmation) - One of the less obtrusive ways of implementing confirmation dialogues.
- [Slideshow Lite](https://github.com/fredwu/jquery-slideshow-lite) - An extremely lightweight slideshow plugin for jQuery.
## License
Copyright (c) 2008-2012 Fred Wu
Dual licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php) and [GPL](http://www.gnu.org/licenses/gpl.html) licenses.
[](https://bitdeli.com/free "Bitdeli Badge")