2 * mw.GallerySlideshow: Interface controls for the slideshow gallery
4 ( function ( mw
, $, OO
) {
6 * mw.GallerySlideshow encapsulates the user interface of the slideshow
7 * galleries. An object is instantiated for each `.mw-gallery-slideshow`
10 * @class mw.GallerySlideshow
13 * @param {jQuery} gallery The `<ul>` element of the gallery.
15 mw
.GallerySlideshow = function ( gallery
) {
17 this.$gallery
= $( gallery
);
18 this.$galleryCaption
= this.$gallery
.find( '.gallerycaption' );
19 this.$galleryBox
= this.$gallery
.find( '.gallerybox' );
20 this.$currentImage
= null;
21 this.imageInfoCache
= {};
22 if ( this.$gallery
.parent().attr( 'id' ) !== 'mw-content-text' ) {
23 this.$container
= this.$gallery
.parent();
28 this.setSizeRequirement();
29 this.toggleThumbnails( !!this.$gallery
.attr( 'data-showthumbnails' ) );
30 this.showCurrentImage();
36 this.setSizeRequirement
.bind( this ),
41 // Disable thumbnails' link, instead show the image in the carousel
42 this.$galleryBox
.on( 'click', function ( e
) {
43 this.$currentImage
= $( e
.currentTarget
);
44 this.showCurrentImage();
51 * @property {jQuery} $gallery The `<ul>` element of the gallery.
55 * @property {jQuery} $galleryCaption The `<li>` that has the gallery caption.
59 * @property {jQuery} $galleryBox Selection of `<li>` elements that have thumbnails.
63 * @property {jQuery} $carousel The `<li>` elements that contains the carousel.
67 * @property {jQuery} $interface The `<div>` elements that contains the interface buttons.
71 * @property {jQuery} $img The `<img>` element that'll display the current image.
75 * @property {jQuery} $imgLink The `<a>` element that links to the image's File page.
79 * @property {jQuery} $imgCaption The `<p>` element that holds the image caption.
83 * @property {jQuery} $imgContainer The `<div>` element that contains the image.
87 * @property {jQuery} $currentImage The `<li>` element of the current image.
91 * @property {jQuery} $container If the gallery contained in an element that is
92 * not the main content element, then it stores that element.
96 * @property {Object} imageInfoCache A key value pair of thumbnail URLs and image info.
100 * @property {number} imageWidth Width of the image based on viewport size
104 * @property {number} imageHeight Height of the image based on viewport size
105 * the URLs in the required size.
109 OO
.initClass( mw
.GallerySlideshow
);
113 * Draws the carousel and the interface around it.
115 mw
.GallerySlideshow
.prototype.drawCarousel = function () {
116 var next
, prev
, toggle
, interfaceElements
, carouselStack
;
118 this.$carousel
= $( '<li>' ).addClass( 'gallerycarousel' );
120 // Buttons for the interface
121 prev
= new OO
.ui
.ButtonWidget( {
124 } ).on( 'click', this.prevImage
.bind( this ) );
126 next
= new OO
.ui
.ButtonWidget( {
129 } ).on( 'click', this.nextImage
.bind( this ) );
131 toggle
= new OO
.ui
.ButtonWidget( {
133 icon
: 'imageGallery',
134 title
: mw
.msg( 'gallery-slideshow-toggle' )
135 } ).on( 'click', this.toggleThumbnails
.bind( this ) );
137 interfaceElements
= new OO
.ui
.PanelLayout( {
139 classes
: [ 'mw-gallery-slideshow-buttons' ],
140 $content
: $( '<div>' ).append(
146 this.$interface = interfaceElements
.$element
;
148 // Containers for the current image, caption etc.
149 this.$img
= $( '<img>' );
150 this.$imgLink
= $( '<a>' ).append( this.$img
);
151 this.$imgCaption
= $( '<p>' ).attr( 'class', 'mw-gallery-slideshow-caption' );
152 this.$imgContainer
= $( '<div>' )
153 .attr( 'class', 'mw-gallery-slideshow-img-container' )
154 .append( this.$imgLink
);
156 carouselStack
= new OO
.ui
.StackLayout( {
161 new OO
.ui
.PanelLayout( {
163 $content
: this.$imgContainer
165 new OO
.ui
.PanelLayout( {
167 $content
: this.$imgCaption
171 this.$carousel
.append( carouselStack
.$element
);
173 // Append below the caption or as the first element in the gallery
174 if ( this.$galleryCaption
.length
!== 0 ) {
175 this.$galleryCaption
.after( this.$carousel
);
177 this.$gallery
.prepend( this.$carousel
);
182 * Sets the {@link #imageWidth} and {@link #imageHeight} properties
183 * based on the size of the window. Also flushes the
184 * {@link #imageInfoCache} as we'll now need URLs for a different
187 mw
.GallerySlideshow
.prototype.setSizeRequirement = function () {
190 if ( this.$container
!== undefined ) {
191 w
= this.$container
.width() * 0.9;
192 h
= ( this.$container
.height() - this.getChromeHeight() ) * 0.9;
194 w
= this.$imgContainer
.width();
195 h
= Math
.min( $( window
).height() * ( 3 / 4 ), this.$imgContainer
.width() ) - this.getChromeHeight();
198 // Only update and flush the cache if the size changed
199 if ( w
!== this.imageWidth
|| h
!== this.imageHeight
) {
201 this.imageHeight
= h
;
202 this.imageInfoCache
= {};
208 * Gets the height of the interface elements and the
211 * @return {number} Height
213 mw
.GallerySlideshow
.prototype.getChromeHeight = function () {
214 return this.$interface.outerHeight() + this.$galleryCaption
.outerHeight();
218 * Sets the height and width of {@link #$img} based on the
219 * proportion of the image and the values generated by
220 * {@link #setSizeRequirement}.
222 * @return {boolean} Whether or not the image was sized.
224 mw
.GallerySlideshow
.prototype.setImageSize = function () {
225 if ( this.$img
=== undefined || this.$thumbnail
=== undefined ) {
229 // Reset height and width
231 .removeAttr( 'width' )
232 .removeAttr( 'height' );
234 // Stretch image to take up the required size
235 if ( this.$thumbnail
.width() > this.$thumbnail
.height() ) {
236 this.$img
.attr( 'width', this.imageWidth
+ 'px' );
238 this.$img
.attr( 'height', this.imageHeight
+ 'px' );
241 // Make the image smaller in case the current image
242 // size is larger than the original file size.
243 this.getImageInfo( this.$thumbnail
).done( function ( info
) {
244 // NOTE: There will be a jump when resizing the window
245 // because the cache is cleared and this a new network request.
247 info
.thumbwidth
< this.$img
.width() ||
248 info
.thumbheight
< this.$img
.height()
250 this.$img
.attr( 'width', info
.thumbwidth
+ 'px' );
251 this.$img
.attr( 'height', info
.thumbheight
+ 'px' );
259 * Displays the image set as {@link #$currentImage} in the carousel.
261 mw
.GallerySlideshow
.prototype.showCurrentImage = function () {
262 var imageLi
= this.getCurrentImage(),
263 caption
= imageLi
.find( '.gallerytext' );
265 // Highlight current thumbnail
267 .find( '.gallerybox.slideshow-current' )
268 .removeClass( 'slideshow-current' );
269 imageLi
.addClass( 'slideshow-current' );
271 // Show thumbnail stretched to the right size while the image loads
272 this.$thumbnail
= imageLi
.find( 'img' );
273 this.$img
.attr( 'src', this.$thumbnail
.attr( 'src' ) );
274 this.$img
.attr( 'alt', this.$thumbnail
.attr( 'alt' ) );
275 this.$imgLink
.attr( 'href', imageLi
.find( 'a' ).eq( 0 ).attr( 'href' ) );
281 .append( caption
.clone() );
283 // Load image at the required size
284 this.loadImage( this.$thumbnail
).done( function ( info
, $img
) {
285 // Show this image to the user only if its still the current one
286 if ( this.$thumbnail
.attr( 'src' ) === $img
.attr( 'src' ) ) {
287 this.$img
.attr( 'src', info
.thumburl
);
290 // Keep the next image ready
291 this.loadImage( this.getNextImage().find( 'img' ) );
297 * Loads the full image given the `<img>` element of the thumbnail.
299 * @param {Object} $img
300 * @return {jQuery.Promise} Resolves with the images URL and original
301 * element once the image has loaded.
303 mw
.GallerySlideshow
.prototype.loadImage = function ( $img
) {
304 var img
, d
= $.Deferred();
306 this.getImageInfo( $img
).done( function ( info
) {
308 img
.src
= info
.thumburl
;
309 img
.onload = function () {
310 d
.resolve( info
, $img
);
312 img
.onerror = function () {
315 } ).fail( function () {
323 * Gets the image's info given an `<img>` element.
325 * @param {Object} $img
326 * @return {jQuery.Promise} Resolves with the image's info.
328 mw
.GallerySlideshow
.prototype.getImageInfo = function ( $img
) {
329 var api
, title
, params
,
330 imageSrc
= $img
.attr( 'src' );
332 // Reject promise if there is no thumbnail image
333 if ( $img
[ 0 ] === undefined ) {
334 return $.Deferred().reject();
337 if ( this.imageInfoCache
[ imageSrc
] === undefined ) {
339 // TODO: This supports only gallery of images
340 title
= mw
.Title
.newFromImg( $img
);
344 titles
: title
.toString(),
349 // Check which dimension we need to request, based on
350 // image and container proportions.
351 if ( this.getDimensionToRequest( $img
) === 'height' ) {
352 params
.iiurlheight
= this.imageHeight
;
354 params
.iiurlwidth
= this.imageWidth
;
357 this.imageInfoCache
[ imageSrc
] = api
.get( params
).then( function ( data
) {
358 if ( OO
.getProp( data
, 'query', 'pages', 0, 'imageinfo', 0, 'thumburl' ) !== undefined ) {
359 return data
.query
.pages
[ 0 ].imageinfo
[ 0 ];
361 return $.Deferred().reject();
366 return this.imageInfoCache
[ imageSrc
];
370 * Given an image, the method checks whether to use the height
371 * or the width to request the larger image.
373 * @param {jQuery} $img
376 mw
.GallerySlideshow
.prototype.getDimensionToRequest = function ( $img
) {
377 var ratio
= $img
.width() / $img
.height();
379 if ( this.imageHeight
* ratio
<= this.imageWidth
) {
387 * Toggles visibility of the thumbnails.
389 * @param {boolean} show Optional argument to control the state
391 mw
.GallerySlideshow
.prototype.toggleThumbnails = function ( show
) {
392 this.$galleryBox
.toggle( show
);
393 this.$carousel
.toggleClass( 'mw-gallery-slideshow-thumbnails-toggled', show
);
397 * Getter method for {@link #$currentImage}
401 mw
.GallerySlideshow
.prototype.getCurrentImage = function () {
402 this.$currentImage
= this.$currentImage
|| this.$galleryBox
.eq( 0 );
403 return this.$currentImage
;
407 * Gets the image after the current one. Returns the first image if
408 * the current one is the last.
412 mw
.GallerySlideshow
.prototype.getNextImage = function () {
413 // Not the last image in the gallery
414 if ( this.$currentImage
.next( '.gallerybox' )[ 0 ] !== undefined ) {
415 return this.$currentImage
.next( '.gallerybox' );
417 return this.$galleryBox
.eq( 0 );
422 * Gets the image before the current one. Returns the last image if
423 * the current one is the first.
427 mw
.GallerySlideshow
.prototype.getPrevImage = function () {
428 // Not the first image in the gallery
429 if ( this.$currentImage
.prev( '.gallerybox' )[ 0 ] !== undefined ) {
430 return this.$currentImage
.prev( '.gallerybox' );
432 return this.$galleryBox
.last();
437 * Sets the {@link #$currentImage} to the next one and shows
440 mw
.GallerySlideshow
.prototype.nextImage = function () {
441 this.$currentImage
= this.getNextImage();
442 this.showCurrentImage();
446 * Sets the {@link #$currentImage} to the previous one and shows
449 mw
.GallerySlideshow
.prototype.prevImage = function () {
450 this.$currentImage
= this.getPrevImage();
451 this.showCurrentImage();
454 // Bootstrap all slideshow galleries
455 mw
.hook( 'wikipage.content' ).add( function ( $content
) {
456 $content
.find( '.mw-gallery-slideshow' ).each( function () {
457 // eslint-disable-next-line no-new
458 new mw
.GallerySlideshow( this );
461 }( mediaWiki
, jQuery
, OO
) );