/
jquery.history.js
493 lines (413 loc) · 12 KB
/
jquery.history.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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
/**
* @depends jquery, core.console
* @name jquery.history
* @package jquery-history {@link http://balupton.com/projects/jquery-history}
*/
// Start of our jQuery Plugin
(function($)
{ // Create our Plugin function, with $ as the argument (we pass the jQuery object over later)
// More info: http://docs.jquery.com/Plugins/Authoring#Custom_Alias
/**
* jQuery History
* @version 1.5.0
* @date August 31, 2010
* @since 0.1.0-dev, July 24, 2008
* @package jquery-history {@link http://balupton.com/projects/jquery-history}
* @author Benjamin "balupton" Lupton {@link http://balupton.com}
* @copyright (c) 2008-2010 Benjamin Arthur Lupton {@link http://balupton.com}
* @license MIT License {@link http://creativecommons.org/licenses/MIT/}
*/
// Check our class exists
if ( !($.History||false) ) {
// Declare our class
$.History = {
// Our Plugin definition
// -----------------
// Options
options: {
debug: false
},
// -----------------
// Variables
state: '',
$window: null,
$iframe: null,
handlers: {
generic: [],
specific: {}
},
// --------------------------------------------------
// Functions
/**
* Extract the Hash from a URL
* @param {String} hash
*/
extractHash: function ( url ) {
// Extract the hash
var hash = url
.replace(/^[^#]*#/, '') /* strip anything before the first anchor */
.replace(/^#+|#+$/, '')
;
// Return hash
return hash;
},
/**
* Get the current state of the application
*/
getState: function ( ) {
var History = $.History;
// Get the current state
return History.state;
},
/**
* Set the current state of the application
* @param {String} hash
*/
setState: function ( state ) {
var History = $.History;
// Format the state
state = History.extractHash(state)
// Apply the state
History.state = state;
// Return the state
return History.state;
},
/**
* Get the current hash of the browser
*/
getHash: function ( ) {
var History = $.History;
// Get the hash
var hash = History.extractHash(window.location.hash || location.hash);
// Return the hash
return hash;
},
/**
* Set the current hash of the browser and iframe if present
* @param {String} hash
*/
setHash: function ( hash ) {
var History = $.History;
// Prepare hash
hash = History.extractHash(hash);
// Write hash
if ( typeof window.location.hash !== 'undefined' ) {
if ( window.location.hash !== hash ) {
window.location.hash = hash;
}
} else if ( location.hash !== hash ) {
location.hash = hash;
}
// Done
return hash;
},
/**
* Go to the specific state - does not force a history entry like setHash
* @param {String} to
*/
go: function ( to ) {
var History = $.History;
// Format
to = History.extractHash(to);
// Get current
var hash = History.getHash(),
state = History.getState();
// Has the hash changed
if ( to !== hash ) {
// Yes, update the hash
// And wait for the next automatic fire
History.setHash(to);
} else {
// Hash the state changed?
if ( to !== state ) {
// Yes, Update the state
History.setState(to);
}
// Trigger our change
History.trigger();
}
// Done
return true;
},
/**
* Handle when the hash has changed
* @param {Event} e
*/
hashchange: function ( e ) {
var History = $.History;
// Get Hash
var hash = History.getHash();
// Handle the new hash
History.go(hash);
// All done
return true;
},
/**
* Bind a handler to a hash
* @param {Object} state
* @param {Object} handler
*/
bind: function ( state, handler ) {
var History = $.History;
// Handle
if ( handler ) {
// We have a state specific handler
// Prepare
if ( typeof History.handlers.specific[state] === 'undefined' ) {
// Make it an array
History.handlers.specific[state] = [];
}
// Push new handler
History.handlers.specific[state].push(handler);
}
else {
// We have a generic handler
handler = state;
History.handlers.generic.push(handler);
}
// Done
return true;
},
/**
* Trigger a handler for a state
* @param {String} state
*/
trigger: function ( state ) {
var History = $.History;
// Prepare
if ( typeof state === 'undefined' ) {
// Use current
state = History.getState();
}
var i, n, handler, list;
// Fire specific
if ( typeof History.handlers.specific[state] !== 'undefined' ) {
// We have specific handlers
list = History.handlers.specific[state];
for ( i = 0, n = list.length; i < n; ++i ) {
// Fire the specific handler
handler = list[i];
handler(state);
}
}
// Fire generics
list = History.handlers.generic;
for ( i = 0, n = list.length; i < n; ++i ) {
// Fire the specific handler
handler = list[i];
handler(state);
}
// Done
return true;
},
// --------------------------------------------------
// Constructors
/**
* Construct our application
*/
construct: function ( ) {
var History = $.History;
// Modify the document
$(document).ready(function() {
// Prepare the document
History.domReady();
});
// Done
return true;
},
/**
* Configure our application
* @param {Object} options
*/
configure: function ( options ) {
var History = $.History;
// Set options
History.options = $.extend(History.options, options);
// Done
return true;
},
domReadied: false,
domReady: function ( ) {
var History = $.History;
// Runonce
if ( History.domRedied ) {
return;
}
History.domRedied = true;
// Define window
History.$window = $(window);
// Apply the hashchange function
History.$window.bind('hashchange', this.hashchange);
// Force hashchange support for all browsers
setTimeout(History.hashchangeLoader, 200);
// All done
return true;
},
/**
* Determines whether or not our browser has native support for the required onhashchange event.
* Unfortunately we have to test against a known range of browsers, as doing a automatic test would require testing the onhashchange functionality
* which would require a state change that we do not want.
* @param {Object} browser [optional]
*/
nativeSupport: function ( browser ) {
// Prepare
browser = browser||$.browser;
var browserVersion = browser.version,
browserVersionInt = parseInt(browserVersion,10),
browserVersionParts = browserVersion.split(/[^0-9]/g),
browserVersionPartsOne = parseInt(browserVersionParts[0],10),
browserVersionPartsTwo = parseInt(browserVersionParts[1],10),
browserVersionPartsThree = parseInt(browserVersionParts[2],10),
nativeSupport = false;
// Determine if we are running under a browser which has nativeSupport for the onhashchange event
// >= MSIE 8
if ( (browser.msie||false) && browserVersionInt >= 8 ) {
nativeSupport = true;
}
// >= Webkit 528
else if ( (browser.webkit||false) && browserVersionInt >= 528 ) {
nativeSupport = true;
}
// >= Gecko 1.9.2.x
else if ( (browser.mozilla||false) ) {
// > Gecko 1
if ( browserVersionPartsOne > 1 ) {
nativeSupport = true;
}
// = Gecko 1
else if ( browserVersionPartsOne === 1 ) {
// > Gecko 1.9
if ( browserVersionPartsTwo > 9 ) {
nativeSupport = true;
}
// = Gecko 1.9
else if ( browserVersionPartsTwo === 9 ) {
// >= Gecko 1.9.2
if ( browserVersionPartsThree >= 2 ) {
nativeSupport = true;
}
}
}
}
// >= Opera 10.60
else if ( (browser.opera||false) ) {
// > Opera 10
if ( browserVersionPartsOne > 10 ) {
nativeSupport = true;
}
// = Opera 10
else if ( browserVersionPartsOne === 10 ) {
// >= Opera 10.60
if ( browserVersionPartsTwo >= 60 ) {
nativeSupport = true;
}
}
}
// Return nativeSupport
return nativeSupport;
},
/**
* Enable hashchange for all browsers
* For browsers which do not have native support, the support must be emulated.
*/
hashchangeLoader: function () {
var History = $.History;
// Fetch nativeSupport
var nativeSupport = History.nativeSupport();
// Check whether or not we need to implement a unfortunate but required workaround for browsers without nativeSupport
if ( !nativeSupport ) {
// We are not IE8, or another browser which supports onhashchange natively
// State our checker function, it is used to constantly check the location to detect a change
var checker;
// Handle depending on the browser
if ( $.browser.msie ) {
// We are still IE
// IE6, IE7, etc
// Append and $iframe to the document, as $iframes are required for back and forward
// Create a hidden $iframe for hash change tracking
History.$iframe = $('<iframe id="jquery-history-iframe" style="display: none;"></$iframe>').prependTo(document.body)[0];
// Create initial history entry
History.$iframe.contentWindow.document.open();
History.$iframe.contentWindow.document.close();
// Define the checker function (for bookmarks)
var iframeHit = false;
checker = function ( ) {
// Fetch
var hash = History.getHash();
var state = History.getState();
var iframeHash = History.extractHash(History.$iframe.contentWindow.document.location.hash);
// Check if the browser hash is different
if ( state !== hash ) {
// Browser hash is different
// Check if we need to update the iframe
if ( !iframeHit ) {
// Write a iframe/history entry in the browsers back and forward
// alert('update iframe entry');
History.$iframe.contentWindow.document.open();
History.$iframe.contentWindow.document.close();
// alert('update iframe entry.');
// Update the iframe hash
// alert('update iframe hash');
History.$iframe.contentWindow.document.location.hash = hash;
// alert('update iframe hash.');
}
// Reset
iframeHit = false;
// Fire
// alert('hashchange');
History.$window.trigger('hashchange');
// alert('hashchange.');
}
else {
// Browser hash is not different
// Check if the iframe hash is different from the iframe state
if ( state !== iframeHash ) {
// Specify we were hit from the iframe
iframeHit = true;
// Update the browser hash
// alert('set hash from iframe');
History.setHash(iframeHash);
// alert('set hash from iframe.');
}
}
};
}
else {
// We are not IE
// Firefox, Opera, Etc
// Define the checker function (for bookmarks, back, forward)
checker = function ( ) {
var hash = History.getHash();
var state = History.getState();
// Check
if ( state !== hash ) {
// State change
History.$window.trigger('hashchange');
}
};
}
// Apply the checker function
setInterval(checker, 200);
}
else {
// We are IE8, or another browser which supports onhashchange natively
// Fire the initial
var hash = History.getHash();
if ( hash ) {
History.$window.trigger('hashchange');
}
}
// Done
return true;
}
}; // We have finished extending/defining our Plugin
// --------------------------------------------------
// Finish up
// Instantiate
$.History.construct();
}
else {
window.console.warn('$.History has already been defined...');
}
// Finished definition
})(jQuery); // We are done with our plugin, so lets call it with jQuery as the argument