-
Notifications
You must be signed in to change notification settings - Fork 2
/
infinite-scroll.js
254 lines (195 loc) · 6.26 KB
/
infinite-scroll.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
(function ($) {
/**
* $.infiniteScroll
*
* @author Frederick Lawler
* @license MIT
*/
$.infiniteScroll = function (element, options) {
var $this = $(element),
plugin = this,
$window = $(window),
$document = $(document),
defaults = {
// Make first ajax call on plugin intialization
loadOnInit: true,
// Element that contains the view
scroller: $(window),
// Pixels from bottom of "scroller" to insert widgets
threshold: 200,
// Delay from ajax call to insert widgets
timeout: 200,
/**
* Use to manipulate data
* @param Mixed data
* @return jQuery/Zepto DOM
*/
modifyResponse: null,
/**
* Callback function to define custom insert function
* @param DOM Element $plugin
* @param DOM Element $widgets
* @return void
*/
insert: null,
/**
* Callback function during the plugin initation process
*/
onInit: null,
/**
* Callback before the ajax function makes a request to server
*/
beforeAjax: null,
/**
* Callback if ajax status == 'success'
*/
onAjaxSuccess: null,
/**
* Callback after widgets have been inserted into DOM
*/
afterInsert: null
},
properties = {
iteration: 1,
scrollOffset: 0
},
is = {
allowedToScroll: true
},
settings,
returnOBJ,
ajax,
$scrollable;
/**
* addData
* Takes the response from ajax and preps it for insertion. Calls
* initiateInsertion function.
*/
function addData (data) {
var $widgets;
if ($.isFunction(settings.modifyResponse)) {
$widgets = settings.modifyResponse(data);
} else {
$widgets = $(data);
}
if (settings.timeout > 0) {
setTimeout(function () {
initiateInsertion($widgets);
}, settings.timeout);
} else {
initiateInsertion($widgets);
}
properties.iteration++;
}
/**
* initiateInsertion
* Inserts the widgets into the view
*/
function initiateInsertion ($widgets) {
if ($.isFunction(settings.insert)) {
settings.insert($this, $widgets);
} else {
$this.append($widgets);
}
if ($.isFunction(settings.afterInsert))
settings.afterInsert();
setOffset();
$scrollable.on('scroll.infiniteScroll', whileScrolling);
is.allowedToScroll = true;
}
/**
* getWidgets
* Makes ajax request to pull in widgets
*
* @precondition setAjax needs to be defined for ajax to work.
*/
function getWidgets () {
var request;
is.allowedToScroll = false;
$window.off('scroll.infiniteScroll');
if ($.isFunction(settings.beforeAjax))
settings.beforeAjax(returnOBJ);
if (typeof ajax === 'undefined')
throw new Error('Please define ajax by calling "setAjax()"');
request = $.ajax(ajax);
request.done(function (data, status, xhr) {
if (status == 'success') {
if ($.isFunction(settings.onAjaxSuccess)) {
settings.onAjaxSuccess(returnOBJ);
}
addData(data);
}
});
}
/**
* bindings
* Called during init to set the bindings
*/
function bindings () {
$scrollable.on('scroll.infiniteScroll', whileScrolling);
$scrollable.on('resize.infiniteScroll', setOffset);
}
/**
* whileScrolling
* Called when the $.scroll event is fired.
*
* @param Event e
* @return Boolean false if scroll is not allowed
*/
function whileScrolling (e) {
if (!is.allowedToScroll)
return false;
if ($scrollable.scrollTop() >= properties.scrollOffset) {
getWidgets();
}
}
/**
* setOffset
*/
function setOffset () {
properties.scrollOffset = $this.height() - $scrollable.height();
properties.scrollOffset -= settings.threshold;
}
/**
* setAjaxObject
*
* @param Plain Object ajaxOptions
*/
function setAjaxObject (ajaxOptions) {
ajax = ajaxOptions;
}
/**
* init
* Initates plugin
*/
var init = function () {
settings = $.extend({}, defaults, options);
$scrollable = settings.scroller;
setOffset();
returnOBJ = {
settings: settings,
properties: properties,
setAjax: setAjaxObject
};
if ($.isFunction(settings.onInit)) {
settings.onInit(settings);
}
if (settings.loadOnInit) {
getWidgets();
}
bindings();
init = function () {
return returnOBJ;
}
}
return init();
};
$.fn.infiniteScroll = function (options) {
return this.each(function() {
if (typeof $(this).data('infiniteScroll') === 'undefined') {
var plugin = new $.infiniteScroll(this, options);
$(this).data('infiniteScroll', plugin);
}
});
}
})(window.jQuery || window.Zepto || window.$);