-
Notifications
You must be signed in to change notification settings - Fork 26
/
ui.ariaLightbox.js
551 lines (509 loc) · 17.8 KB
/
ui.ariaLightbox.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
/*!
* jQuery UI AriaLightbox (29.03.10)
* http://github.com/fnagel/jQuery-Accessible-RIA
*
* Copyright (c) 2009 Felix Nagel for Namics (Deustchland) GmbH
* Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
*
* Depends: ui.core.js
*/
/*
USAGE:::::::::::::
* Take a look in the html file or the (german) pdf file delivered with this example
* The widget gets all the elements in the document which matches choosen selector
* There are to modes: singleview and galleryview defined with imageArray: []
* Options
imageArray: activates galleryview of set to imageArray: []
altText: which attr (within the image) as alt attr
descText: which attr (within the image) as description text
prevText: text on the button
nextText: see above
titleText: titleText of the lightbox
pictureText: string: picture
ofText: string: of
closeText: string: close element
pos: position of the lightbox, possbible values: auto, offset, or [x,y]
autoHeight: margin to top when pos: auto is used
offsetX: number: if pos:"offset" its the distance betwen lightbox and mousclick position
offsetY: see above
disableWidth: min width of the screen (otherwise widget is disabled)
disableHeight: max width of the screen
useDimmer: boolean, activate or deactivate dimmer
animationSpeed: in millseconds or jQuery keywors aka "slow", "fast"
zIndex: number: z-index for overlay elements
background: color in HTML notation
opacity: decimal betwen 1-0
em: muliplicator for relative width (em) calculation, normally not to be edited
* Callbacks
onShow
onChangePicture
onClose
onPrev
onNext
* public Methods
startGallery parameter: event
close
next
prev
disable
enable
disable
destroy
*/
(function($) {
$.widget("ui.ariaLightbox", {
_init: function() {
var options = this.options, self = this;
// save all elements if its a gallery
if (options.imageArray) {
options.imageArray[options.imageArray.length] = this.element;
var index = options.imageArray.length;
}
// set trigger events
this.element.click(function (event) {
// only activate when widget isnt disabled and screen isn't to small
if (!options.disabled && $(window).width()-options.disableWidth > 0 && $(window).height()-options.disableHeight > 0) {
// set active element if gallery mode is activated
if (options.imageArray) self.options.activeImage = index-1;
event.preventDefault();
self._open($(this), event);
}
});
// only set resize event when lightbox is activated
if (options.useDimmer)
$(window).resize(function(){
if (!options.disabled) self._dimmerResize();
});
self._makeHover(self.element);
},
// call gallery from link
startGallery: function (event){
var options = this.options, self = this;
self._open($(options.imageArray[0]), event);
},
// check if lightbox is already opened
_open: function (element, event){
var options = this.options, self = this;
// save clicked element (needed if lightbox is controlled by keyboard only)
options.clickedElement = event.currentTarget;
// if wrapper element isnt found, create it
options.wrapperElement = $("#ui-lightbox-wrapper");
if(!options.wrapperElement.length){
self._show(element, event);
} else {
self._changePicture(element, event);
}
},
// called if lightbox wrapper element is not injected yet
_show: function (element, event){
var options = this.options, self = this;
// build html
var html = "\n";
html += '<div id="ui-lightbox-wrapper" style="z-index:'+options.zIndex+1+';" class="ui-dialog ui-widget ui-widget-content ui-corner-all" tabindex="-1" role="dialog" aria-labelledby="ui-dialog-title-dialog">'+"\n";
html += ' <div class="ui-dialog-titlebar ui-widget-header ui-corner-all ui-helper-clearfix">'+"\n";
html += ' <span class="ui-dialog-title" id="ui-dialog-title-dialog">'+ options.titleText +'</span>'+"\n";
html += ' <a href="#nogo" id="ui-lightbox-close" class="ui-dialog-titlebar-close ui-corner-all" title="'+ options.closeText +'" role="button">'+"\n";
html += ' <span class="ui-icon ui-icon-closethick">'+ options.closeText +'</span>'+"\n";
html += ' </a>'+"\n";
html += ' </div>'+"\n";
html += ' <div id="ui-lightbox-content">'+"\n";
html += ' <div id="ui-lightbox-image"><img src="" aria-describedby="ui-lightbox-description" /></div>'+"\n";
html += ' <p id="ui-lightbox-description"></p>'+"\n";
// show pager and range description if its an array of images
if (options.imageArray) {
html += ' <p id="ui-lightbox-pager"></p>'+"\n";
html += ' <div id="ui-dialog-buttonpane" class="ui-dialog-buttonpane ui-widget-content ui-helper-clearfix">'+"\n";
html += ' <button id="ui-lightbox-next" type="button" class="ui-state-default ui-corner-all">'+ options.prevText +'</button>'+"\n";
html += ' <button id="ui-lightbox-prev" type="button" class="ui-state-default ui-corner-all">'+ options.nextText +'</button>'+"\n";
html += ' </div>'+"\n";
}
html += ' </div> '+"\n";
html += '</div>'+"\n";
// create dimmer
if (options.useDimmer) self._lightboxCreate();
// inject HTML
$("body").append(html);
// Callback
self._trigger("onShow", 0);
// get lightbox element
options.wrapperElement = $("#ui-lightbox-wrapper");
// enable keyboard navigation
if(options.imageArray) {
options.wrapperElement.keydown( function(event){
if(event.keyCode == $.ui.keyCode.RIGHT) self.next();
if(event.keyCode == $.ui.keyCode.DOWN) self.next();
if(event.keyCode == $.ui.keyCode.UP) self.prev();
if(event.keyCode == $.ui.keyCode.LEFT) self.prev();
if(event.keyCode == $.ui.keyCode.SPACE) self.next();
if(event.keyCode == $.ui.keyCode.END) {
options.activeImage = options.imageArray.length-2;
event.preventDefault();
self.next();
}
if(event.keyCode == $.ui.keyCode.HOME) {
options.activeImage = 1;
event.preventDefault();
self.prev();
}
});
options.buttonpane = options.wrapperElement.find("#ui-dialog-buttonpane")
// check button state
self._setButtonState();
// add events for paging and hover if necassary
var prev = options.buttonpane.find("#ui-lightbox-prev");
prev.click( function() { self.prev(); });
self._makeHover(prev);
var next = options.buttonpane.find("#ui-lightbox-next");
next.click( function() { self.next(); });
self._makeHover(next);
}
options.wrapperElement.keydown( function(event){
if(event.keyCode == $.ui.keyCode.ESCAPE) self.close();
});
// add hover and close event
var closeElement = options.wrapperElement.find("#ui-lightbox-close");
closeElement.click( function() { self.close(); return false; });
self._makeHover(closeElement);
// decide which position is set
switch (options.pos) {
case "auto":
var viewPos = self._pageScroll();
var posLeft = (($(document).width() - options.wrapperElement.width())/2);
var posTop = viewPos[1]+options.autoHeight;
break;
case "offset":
var posLeft = event.pageX+options.offsetX;
var posTop = event.pageY-options.offsetY;
break;
default:
var position = options.pos.split(",");
var posLeft = position[0];
var posTop = position[1];
break;
}
// set inital position, fade in and focus
options.wrapperElement
.css({
left: posLeft+"px",
top: posTop+"px"
})
.fadeIn(options.animationSpeed)
.focus();
// set picture and meta data
self._changePicture(element, event);
},
// called whenever a picture should be changed
_changePicture: function (element, event){
var options = this.options, self = this;
// get elements for reuse
var contentWrapper = options.wrapperElement.find("#ui-lightbox-content");
var imageWrapper = contentWrapper.find("#ui-lightbox-image");
var imageElement = imageWrapper.find("img");
// fade out the picture, then set new properties and animate elements
imageElement.fadeOut(options.animationSpeed, function() {
// ARIA | set attributes and begin manipulations
contentWrapper
.attr("aria-live", "assertive")
.attr("aria-relevant", "additions removals text")
.attr("aria-busy", true);
// preload image
var image = new Image();
image.onload = function() {
// set new picture properties
imageElement
.attr('src', element.attr("href"))
.attr('alt', options.altText.call(element));
// if em isnt deactivated calculate relative size
var calculatedX = (options.em) ? image.width*options.em+"em" : image.width;
var calculatedY = (options.em) ? image.height*options.em+"em" : image.height;
// set image dimension | set always cause of display problems with relative dimension setting
imageElement.css({
width: calculatedX,
height: calculatedY
});
// decide which position is set and animate the width of the ligthbox element
switch (options.pos) {
case "offset":
options.wrapperElement.animate({
left: event.pageX+options.offsetX+"px",
top: event.pageY+options.offsetY+"px",
width: calculatedX
}, options.animationSpeed);
break;
case "auto":
options.wrapperElement.animate({
left: (($(document).width() - image.width)/2)+"px",
width: calculatedX
}, options.animationSpeed);
break;
}
// resize the hight of the image wrapper to resize the lightbox element | wait till finished
imageWrapper.animate({
height: calculatedY
},
options.animationSpeed,
function () {
// fade in the picture
imageElement.fadeIn(options.animationSpeed);
// change description of the picture
options.wrapperElement.find("#ui-lightbox-description")
.text(options.descText.call(element));
// if it is a gallery change the pager text
if (options.imageArray)
options.wrapperElement.find("#ui-lightbox-pager")
.text(options.pictureText +' '+ (options.activeImage+1) +' '+ options.ofText +' '+ options.imageArray.length);
// check if lightbox popup changed body dimension
if (options.useDimmer) self._dimmerResize();
// update screenreader buffer
self._updateVirtualBuffer();
// ARIA | manipulations finished
contentWrapper.attr("aria-busy", false);
// Callback
self._trigger("onChangePicture", 0);
// END of image changing
}
);
// IE specific, prevent animate gif failures | unload onload
image.onload = function(){};
};
// load image
image.src = element.attr("href");
});
},
// set button attributes
_setButtonState: function (){
var options = this.options;
// activate both buttons
options.buttonpane.find("#ui-lightbox-next, #ui-lightbox-prev")
.removeAttr("disabled")
.removeClass("ui-state-disabled")
.removeClass("ui-state-focus");
switch (options.activeImage) {
// disable prev
case 0:
options.buttonpane.find("#ui-lightbox-prev")
.attr("disabled", "disabled")
.removeClass("ui-state-hover")
.addClass("ui-state-disabled");
options.buttonpane.find("#ui-lightbox-next").focus();
break;
// disable next
case options.imageArray.length-1:
options.buttonpane.find("#ui-lightbox-next")
.attr("disabled", "disabled")
.removeClass("ui-state-hover")
.addClass("ui-state-disabled");
options.buttonpane.find("#ui-lightbox-prev").focus();
break;
}
},
// close wrappper element
close: function (){
var options = this.options, self = this;
// focus back to first clicked element
$(options.clickedElement).parent().focus();
options.wrapperElement.fadeOut(options.animationSpeed, function () {
$(this).remove();
});
// remove dimmer
if (options.useDimmer) $("#ui-lightbox-screendimmer").fadeOut(options.animationSpeed, function() { $(this).remove(); });
// refocus original clicked element
$(options.clickedElement).focus();
// Callback
self._trigger("onClose", 0);
},
// change picture to previous image
prev: function (){
var options = this.options, self = this;
if(options.imageArray && options.activeImage > 0) {
options.activeImage = options.activeImage-1;
self._changePicture($(options.imageArray[options.activeImage]));
self._setButtonState();
// Callback
self._trigger("onPrev", 0);
}
},
// change picture to next image
next: function (){
var options = this.options, self = this;
if(options.imageArray && options.activeImage < (options.imageArray.length-1)) {
options.activeImage = options.activeImage+1;
self._changePicture($(options.imageArray[options.activeImage]));
self._setButtonState();
// Callback
self._trigger("onNext", 0);
}
},
// create lightbox
_lightboxCreate: function() {
var options = this.options, self = this;
// inject html
var html = '<div id="ui-lightbox-screendimmer" style="display: none;"></div>';
$("body").append(html);
// set attributes
$("#ui-lightbox-screendimmer")
.css({
width: self._dimmerWidth() + 'px',
height: self._dimmerHeight() + 'px',
zIndex: options.zIndex,
background: options.background,
position: "absolute",
top: "0px",
left: "0px",
opacity: options.opacity
})
.fadeIn(options.animationSpeed)
// if dimmer is clicked, close lightbox
.click( function() {
self.close();
});
},
// resize dimmer
_dimmerResize: function() {
var self = this;
var dimmer = $("#ui-lightbox-screendimmer");
if (dimmer.length) {
// make dimmer div small | necassary to check if content is smaller than the dimmer div
dimmer.css({
width: 0,
height: 0
});
// check real body dimension
var dimension = self._pageScroll();
// if page is not scrolled without dimmer div use normal width
var dimensionX = (dimension[0] == 0) ? self._dimmerWidth() : dimension[0];
dimmer.css({
width: dimensionX + 'px',
height: self._dimmerHeight() + 'px'
});
}
},
// get body hight
_dimmerHeight: function() {
// handle IE 6
if ($.browser.msie && $.browser.version < 7) {
var scrollHeight = Math.max(
document.documentElement.scrollHeight,
document.body.scrollHeight
);
var offsetHeight = Math.max(
document.documentElement.offsetHeight,
document.body.offsetHeight
);
if (scrollHeight < offsetHeight) {
return $(window).height();
} else {
return scrollHeight;
}
// handle "good" browsers
} else {
return $(document).height();
}
},
// get body width
_dimmerWidth: function() {
// handle IE 6
if ($.browser.msie && $.browser.version < 7) {
var scrollWidth = Math.max(
document.documentElement.scrollWidth,
document.body.scrollWidth
);
var offsetWidth = Math.max(
document.documentElement.offsetWidth,
document.body.offsetWidth
);
if (scrollWidth < offsetWidth) {
return $(window).width();
} else {
return scrollWidth;
}
// handle "good" browsers
} else {
return $(document).width();
}
},
// get scrolling of the page
_pageScroll: function() {
var xScroll, yScroll;
if (self.pageYOffset) {
yScroll = self.pageYOffset;
xScroll = self.pageXOffset;
// Explorer 6 Strict
} else if (document.documentElement && document.documentElement.scrollTop) {
yScroll = document.documentElement.scrollTop;
xScroll = document.documentElement.scrollLeft;
// all other Explorers
} else if (document.body) {
yScroll = document.body.scrollTop;
xScroll = document.body.scrollLeft;
}
arrayPageScroll = new Array(xScroll,yScroll);
return arrayPageScroll;
},
// make hover and focus effects
_makeHover: function(element) {
element.bind("mouseenter", function(){ $(this).addClass('ui-state-hover'); })
.bind("mouseleave", function(){ $(this).removeClass('ui-state-hover'); })
.bind("focus", function(){ $(this).addClass('ui-state-focus'); })
.bind("blur", function(){ $(this).removeClass('ui-state-focus'); });
},
// updates virtual buffer of older screenreader
_updateVirtualBuffer: function() {
var form = $("#virtualBufferForm");
if(form.length) {
(form.val() == "1") ? form.val("0") : form.val("1")
} else {
var html = '<form><input id="virtualBufferForm" type="hidden" value="1" /></form>';
$("body").append(html);
}
},
destroy: function() {
var options = this.options;
this.element
// remove events
.unbind(".ariaLightbox")
.unbind("click")
// remove data
.removeData('ariaLightbox');
$("#virtualBufferForm").parent().remove();
$("#ui-lightbox-screendimmer").remove();
$("#ui-lightbox-wrapper").unbind("keydown").remove();
}
});
$.extend($.ui.ariaLightbox, {
version: "1.7.1",
defaults: {
// text strings
altText: function() {
// $(this) is the triggered element (in this case the link element)
return $(this).find("img").attr("alt");
},
descText: function() {
return $(this).find("img").attr("title");
},
prevText: "previous picture",
nextText: "next picture",
titleText: "Lightbox",
pictureText: "Picture",
ofText: "of",
closeText: "Close [ESC]",
// positioning
pos: "auto",
autoHeight: 50,
offsetX: 10,
offsetY: 10,
// disable lightbox if screens below:
disableWidth: 550,
disableHeight: 550,
// config screen dimmer
useDimmer: true,
animationSpeed: "slow",
zIndex: 1000,
background: "black",
opacity: 0.8,
em: 0.0568182,
// don not alter this var
activeImage: 0
}
});
})(jQuery);