-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathinstantclick.js
761 lines (638 loc) · 20.6 KB
/
instantclick.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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
/* InstantClick 3.1.0 | (C) 2014 Alexandre Dieulot | http://instantclick.io/license */
var InstantClick = function(document, location) {
// Internal variables
var $ua = navigator.userAgent,
$isChromeForIOS = $ua.indexOf(' CriOS/') > -1,
$hasTouch = 'createTouch' in document,
$currentLocationWithoutHash,
$urlToPreload,
$preloadTimer,
$lastTouchTimestamp,
// Preloading-related variables
$history = {},
$xhr,
$url = false,
$title = false,
$mustRedirect = false,
$body = false,
$timing = {},
$isPreloading = false,
$isWaitingForCompletion = false,
$trackedAssets = [],
// Variables defined by public functions
$useWhitelist,
$preloadOnMousedown,
$delayBeforePreload,
$eventsCallbacks = {
fetch: [],
receive: [],
wait: [],
change: []
}
////////// HELPERS //////////
function removeHash(url) {
var index = url.indexOf('#')
if (index < 0) {
return url
}
return url.substr(0, index)
}
function getLinkTarget(target) {
while (target && target.nodeName != 'A') {
target = target.parentNode
}
return target
}
function isBlacklisted(elem) {
do {
if (!elem.hasAttribute) { // Parent of <html>
break
}
if (elem.hasAttribute('data-instant')) {
return false
}
if (elem.hasAttribute('data-no-instant')) {
return true
}
}
while (elem = elem.parentNode);
return false
}
function isWhitelisted(elem) {
do {
if (!elem.hasAttribute) { // Parent of <html>
break
}
if (elem.hasAttribute('data-no-instant')) {
return false
}
if (elem.hasAttribute('data-instant')) {
return true
}
}
while (elem = elem.parentNode);
return false
}
function isPreloadable(a) {
var domain = location.protocol + '//' + location.host
if (a.target // target="_blank" etc.
|| a.hasAttribute('download')
|| a.href.indexOf(domain + '/') != 0 // Another domain, or no href attribute
|| (a.href.indexOf('#') > -1
&& removeHash(a.href) == $currentLocationWithoutHash) // Anchor
|| ($useWhitelist
? !isWhitelisted(a)
: isBlacklisted(a))
) {
return false
}
return true
}
function triggerPageEvent(eventType, arg1, arg2, arg3) {
var returnValue = false
for (var i = 0; i < $eventsCallbacks[eventType].length; i++) {
if (eventType == 'receive') {
var altered = $eventsCallbacks[eventType][i](arg1, arg2, arg3)
if (altered) {
/* Update args for the next iteration of the loop. */
if ('body' in altered) {
arg2 = altered.body
}
if ('title' in altered) {
arg3 = altered.title
}
returnValue = altered
}
}
else {
$eventsCallbacks[eventType][i](arg1, arg2, arg3)
}
}
return returnValue
}
function changePage(title, body, newUrl, scrollY) {
document.documentElement.replaceChild(body, document.body)
/* We cannot just use `document.body = doc.body`, it causes Safari (tested
5.1, 6.0 and Mobile 7.0) to execute script tags directly.
*/
if (newUrl) {
history.pushState(null, null, newUrl)
var hashIndex = newUrl.indexOf('#'),
hashElem = hashIndex > -1
&& document.getElementById(newUrl.substr(hashIndex + 1)),
offset = 0
if (hashElem) {
while (hashElem.offsetParent) {
offset += hashElem.offsetTop
hashElem = hashElem.offsetParent
}
}
scrollTo(0, offset)
$currentLocationWithoutHash = removeHash(newUrl)
}
else {
scrollTo(0, scrollY)
}
if ($isChromeForIOS && document.title == title) {
/* Chrome for iOS:
*
* 1. Removes title on pushState, so the title needs to be set after.
*
* 2. Will not set the title if it’s identical when trimmed, so
* appending a space won't do, but a non-breaking space works.
*/
document.title = title + String.fromCharCode(160)
}
else {
document.title = title
}
instantanize()
bar.done()
triggerPageEvent('change', false)
// Real event, useful for combining userscripts, but only for that so it’s undocumented.
var userscriptEvent = document.createEvent('HTMLEvents')
userscriptEvent.initEvent('instantclick:newpage', true, true)
dispatchEvent(userscriptEvent)
}
function setPreloadingAsHalted() {
$isPreloading = false
$isWaitingForCompletion = false
}
function removeNoscriptTags(html) {
/* Must be done on text, not on a node's innerHTML, otherwise strange
* things happen with implicitly closed elements (see the Noscript test).
*/
return html.replace(/<noscript[\s\S]+<\/noscript>/gi, '')
}
////////// EVENT HANDLERS //////////
function mousedown(e) {
if ($lastTouchTimestamp > (+new Date - 500)) {
return // Otherwise, click doesn’t fire
}
var a = getLinkTarget(e.target)
if (!a || !isPreloadable(a)) {
return
}
preload(a.href)
}
function mouseover(e) {
if ($lastTouchTimestamp > (+new Date - 500)) {
return // Otherwise, click doesn’t fire
}
var a = getLinkTarget(e.target)
if (!a || !isPreloadable(a)) {
return
}
a.addEventListener('mouseout', mouseout)
if (!$delayBeforePreload) {
preload(a.href)
}
else {
$urlToPreload = a.href
$preloadTimer = setTimeout(preload, $delayBeforePreload)
}
}
function touchstart(e) {
$lastTouchTimestamp = +new Date
var a = getLinkTarget(e.target)
if (!a || !isPreloadable(a)) {
return
}
if ($preloadOnMousedown) {
a.removeEventListener('mousedown', mousedown)
}
else {
a.removeEventListener('mouseover', mouseover)
}
preload(a.href)
}
function click(e) {
var a = getLinkTarget(e.target)
if (!a || !isPreloadable(a)) {
return
}
if (e.which > 1 || e.metaKey || e.ctrlKey) { // Opening in new tab
return
}
e.preventDefault()
display(a.href)
}
function mouseout() {
if ($preloadTimer) {
clearTimeout($preloadTimer)
$preloadTimer = false
return
}
if (!$isPreloading || $isWaitingForCompletion) {
return
}
$xhr.abort()
setPreloadingAsHalted()
}
function readystatechange() {
if ($xhr.readyState < 4) {
return
}
if ($xhr.status == 0) {
/* Request aborted */
return
}
$timing.ready = +new Date - $timing.start
if ($xhr.getResponseHeader('Content-Type').match(/\/(x|ht|xht)ml/)) {
var doc = document.implementation.createHTMLDocument('')
doc.documentElement.innerHTML = removeNoscriptTags($xhr.responseText)
$title = doc.title
$body = doc.body
var alteredOnReceive = triggerPageEvent('receive', $url, $body, $title)
if (alteredOnReceive) {
if ('body' in alteredOnReceive) {
$body = alteredOnReceive.body
}
if ('title' in alteredOnReceive) {
$title = alteredOnReceive.title
}
}
var urlWithoutHash = removeHash($url)
$history[urlWithoutHash] = {
body: $body,
title: $title,
scrollY: urlWithoutHash in $history ? $history[urlWithoutHash].scrollY : 0
}
var elems = doc.head.children,
found = 0,
elem,
data
for (var i = elems.length - 1; i >= 0; i--) {
elem = elems[i]
if (elem.hasAttribute('data-instant-track')) {
data = elem.getAttribute('href') || elem.getAttribute('src') || elem.innerHTML
for (var j = $trackedAssets.length - 1; j >= 0; j--) {
if ($trackedAssets[j] == data) {
found++
}
}
}
}
if (found != $trackedAssets.length) {
$mustRedirect = true // Assets have changed
}
}
else {
$mustRedirect = true // Not an HTML document
}
if ($isWaitingForCompletion) {
$isWaitingForCompletion = false
display($url)
}
}
////////// MAIN FUNCTIONS //////////
function instantanize(isInitializing) {
document.body.addEventListener('touchstart', touchstart, true)
if ($preloadOnMousedown) {
document.body.addEventListener('mousedown', mousedown, true)
}
else {
document.body.addEventListener('mouseover', mouseover, true)
}
document.body.addEventListener('click', click, true)
if (!isInitializing) {
var scripts = document.body.getElementsByTagName('script'),
script,
copy,
parentNode,
nextSibling
for (i = 0, j = scripts.length; i < j; i++) {
script = scripts[i]
if (script.hasAttribute('data-no-instant')) {
continue
}
copy = document.createElement('script')
if (script.src) {
copy.src = script.src
}
if (script.innerHTML) {
copy.innerHTML = script.innerHTML
}
parentNode = script.parentNode
nextSibling = script.nextSibling
parentNode.removeChild(script)
parentNode.insertBefore(copy, nextSibling)
}
}
}
function preload(url) {
if (!$preloadOnMousedown
&& 'display' in $timing
&& +new Date - ($timing.start + $timing.display) < 100) {
/* After a page is displayed, if the user's cursor happens to be above
a link a mouseover event will be in most browsers triggered
automatically, and in other browsers it will be triggered when the
user moves his mouse by 1px.
Here are the behavior I noticed, all on Windows:
- Safari 5.1: auto-triggers after 0 ms
- IE 11: auto-triggers after 30-80 ms (depends on page's size?)
- Firefox: auto-triggers after 10 ms
- Opera 18: auto-triggers after 10 ms
- Chrome: triggers when cursor moved
- Opera 12.16: triggers when cursor moved
To remedy to this, we do not start preloading if last display
occurred less than 100 ms ago. If they happen to click on the link,
they will be redirected.
*/
return
}
if ($preloadTimer) {
clearTimeout($preloadTimer)
$preloadTimer = false
}
if (!url) {
url = $urlToPreload
}
if ($isPreloading && (url == $url || $isWaitingForCompletion)) {
return
}
$isPreloading = true
$isWaitingForCompletion = false
$url = url
$body = false
$mustRedirect = false
$timing = {
start: +new Date
}
triggerPageEvent('fetch')
$xhr.open('GET', url)
//$xhr.setRequestHeader('X-InstantClick-Container', '#instantclick-container')
$xhr.setRequestHeader('X-INSTANTCLICK', true)
$xhr.send()
}
function display(url) {
if (!('display' in $timing)) {
$timing.display = +new Date - $timing.start
}
if ($preloadTimer || !$isPreloading) {
/* $preloadTimer:
Happens when there’s a delay before preloading and that delay
hasn't expired (preloading didn't kick in).
!$isPreloading:
A link has been clicked, and preloading hasn’t been initiated.
It happens with touch devices when a user taps *near* the link,
Safari/Chrome will trigger mousedown, mouseover, click (and others),
but when that happens we ignore mousedown/mouseover (otherwise click
doesn’t fire). Maybe there’s a way to make the click event fire, but
that’s not worth it as mousedown/over happen just 1ms before click
in this situation.
It also happens when a user uses his keyboard to navigate (with Tab
and Return), and possibly in other non-mainstream ways to navigate
a website.
*/
if ($preloadTimer && $url && $url != url) {
/* Happens when the user clicks on a link before preloading
kicks in while another link is already preloading.
*/
location.href = url
return
}
preload(url)
bar.start(0, true)
triggerPageEvent('wait')
$isWaitingForCompletion = true // Must be set *after* calling `preload`
return
}
if ($isWaitingForCompletion) {
/* The user clicked on a link while a page was preloading. Either on
the same link or on another link. If it's the same link something
might have gone wrong (or he could have double clicked, we don’t
handle that case), so we send him to the page without pjax.
If it's another link, it hasn't been preloaded, so we redirect the
user to it.
*/
location.href = url
return
}
if ($mustRedirect) {
location.href = $url
return
}
if (!$body) {
bar.start(0, true)
triggerPageEvent('wait')
$isWaitingForCompletion = true
return
}
$history[$currentLocationWithoutHash].scrollY = pageYOffset
setPreloadingAsHalted()
changePage($title, $body, $url)
}
////////// PROGRESS BAR FUNCTIONS //////////
var bar = function() {
var $barContainer,
$barElement,
$barTransformProperty,
$barProgress,
$barTimer
function init() {
$barContainer = document.createElement('div')
$barContainer.id = 'instantclick'
$barElement = document.createElement('div')
$barElement.id = 'instantclick-bar'
$barElement.className = 'instantclick-bar'
$barContainer.appendChild($barElement)
var vendors = ['Webkit', 'Moz', 'O']
$barTransformProperty = 'transform'
if (!($barTransformProperty in $barElement.style)) {
for (var i = 0; i < 3; i++) {
if (vendors[i] + 'Transform' in $barElement.style) {
$barTransformProperty = vendors[i] + 'Transform'
}
}
}
var transitionProperty = 'transition'
if (!(transitionProperty in $barElement.style)) {
for (var i = 0; i < 3; i++) {
if (vendors[i] + 'Transition' in $barElement.style) {
transitionProperty = '-' + vendors[i].toLowerCase() + '-' + transitionProperty
}
}
}
var style = document.createElement('style')
style.innerHTML = '#instantclick{position:' + ($hasTouch ? 'absolute' : 'fixed') + ';top:0;left:0;width:100%;pointer-events:none;z-index:2147483647;' + transitionProperty + ':opacity .25s .1s}'
+ '.instantclick-bar{background:#29d;width:100%;margin-left:-100%;height:2px;' + transitionProperty + ':all .25s}'
/* We set the bar's background in `.instantclick-bar` so that it can be
overriden in CSS with `#instantclick-bar`, as IDs have higher priority.
*/
document.head.appendChild(style)
if ($hasTouch) {
updatePositionAndScale()
addEventListener('resize', updatePositionAndScale)
addEventListener('scroll', updatePositionAndScale)
}
}
function start(at, jump) {
$barProgress = at
if (document.getElementById($barContainer.id)) {
document.body.removeChild($barContainer)
}
$barContainer.style.opacity = '1'
if (document.getElementById($barContainer.id)) {
document.body.removeChild($barContainer)
/* So there's no CSS animation if already done once and it goes from 1 to 0 */
}
update()
if (jump) {
setTimeout(jumpStart, 0)
/* Must be done in a timer, otherwise the CSS animation doesn't happen. */
}
clearTimeout($barTimer)
$barTimer = setTimeout(inc, 500)
}
function jumpStart() {
$barProgress = 10
update()
}
function inc() {
$barProgress += 1 + (Math.random() * 2)
if ($barProgress >= 98) {
$barProgress = 98
}
else {
$barTimer = setTimeout(inc, 500)
}
update()
}
function update() {
$barElement.style[$barTransformProperty] = 'translate(' + $barProgress + '%)'
if (!document.getElementById($barContainer.id)) {
document.body.appendChild($barContainer)
}
}
function done() {
if (document.getElementById($barContainer.id)) {
clearTimeout($barTimer)
$barProgress = 100
update()
$barContainer.style.opacity = '0'
/* If you're debugging, setting this to 0.5 is handy. */
return
}
/* The bar container hasn't been appended: It's a new page. */
start($barProgress == 100 ? 0 : $barProgress)
/* $barProgress is 100 on popstate, usually. */
setTimeout(done, 0)
/* Must be done in a timer, otherwise the CSS animation doesn't happen. */
}
function updatePositionAndScale() {
/* Adapted from code by Sam Stephenson and Mislav Marohnić
http://signalvnoise.com/posts/2407
*/
$barContainer.style.left = pageXOffset + 'px'
$barContainer.style.width = innerWidth + 'px'
$barContainer.style.top = pageYOffset + 'px'
var landscape = 'orientation' in window && Math.abs(orientation) == 90,
scaleY = innerWidth / screen[landscape ? 'height' : 'width'] * 2
/* We multiply the size by 2 because the progress bar is harder
to notice on a mobile device.
*/
$barContainer.style[$barTransformProperty] = 'scaleY(' + scaleY + ')'
}
return {
init: init,
start: start,
done: done
}
}()
////////// PUBLIC VARIABLE AND FUNCTIONS //////////
var supported = 'pushState' in history
&& (!$ua.match('Android') || $ua.match('Chrome/'))
&& location.protocol != "file:"
/* The state of Android's AOSP browsers:
2.3.7: pushState appears to work correctly, but
`doc.documentElement.innerHTML = body` is buggy.
See details here: http://stackoverflow.com/q/21918564
Not an issue anymore, but it may fail where 3.0 do, this needs
testing again.
3.0: pushState appears to work correctly (though the URL bar is only
updated on focus), but
`document.documentElement.replaceChild(doc.body, document.body)`
throws DOMException: WRONG_DOCUMENT_ERR.
4.0.2: Doesn't support pushState.
4.0.4,
4.1.1,
4.2,
4.3: pushState is here, but it doesn't update the URL bar.
(Great logic there.)
4.4: Works correctly. Claims to be 'Chrome/30.0.0.0'.
All androids tested with Android SDK's Emulator.
Version numbers are from the browser's user agent.
Because of this mess, the only whitelisted browser on Android is Chrome.
*/
function init() {
if ($currentLocationWithoutHash) {
/* Already initialized */
return
}
if (!supported) {
triggerPageEvent('change', true)
return
}
for (var i = arguments.length - 1; i >= 0; i--) {
var arg = arguments[i]
if (arg === true) {
$useWhitelist = true
}
else if (arg == 'mousedown') {
$preloadOnMousedown = true
}
else if (typeof arg == 'number') {
$delayBeforePreload = arg
}
}
$currentLocationWithoutHash = removeHash(location.href)
$history[$currentLocationWithoutHash] = {
body: document.body,
title: document.title,
scrollY: pageYOffset
}
var elems = document.head.children,
elem,
data
for (var i = elems.length - 1; i >= 0; i--) {
elem = elems[i]
if (elem.hasAttribute('data-instant-track')) {
data = elem.getAttribute('href') || elem.getAttribute('src') || elem.innerHTML
/* We can't use just `elem.href` and `elem.src` because we can't
retrieve `href`s and `src`s from the Ajax response.
*/
$trackedAssets.push(data)
}
}
$xhr = new XMLHttpRequest()
$xhr.addEventListener('readystatechange', readystatechange)
instantanize(true)
bar.init()
triggerPageEvent('change', true)
addEventListener('popstate', function() {
var loc = removeHash(location.href)
if (loc == $currentLocationWithoutHash) {
return
}
if (!(loc in $history)) {
location.href = location.href
/* Reloads the page while using cache for scripts, styles and images,
unlike `location.reload()` */
return
}
$history[$currentLocationWithoutHash].scrollY = pageYOffset
$currentLocationWithoutHash = loc
changePage($history[loc].title, $history[loc].body, false, $history[loc].scrollY)
})
}
function on(eventType, callback) {
$eventsCallbacks[eventType].push(callback)
}
////////////////////
return {
supported: supported,
init: init,
on: on
}
}(document, location);