PhotoSwipeの設置方法!レスポンシブ対応Lightbox系の決定版!
2016年6月13日
画像ギャラリーでLightboxを使用しているけど、スマートフォンなどのタブレットで見るといまいちと思っている方も
多いと思います。
私もLightboxやLightbox Plusなど色々と使ってきましたが、スマートフォンなどのタブレットが台頭してきて、どうも表示の仕方が気に食わないと思っていました。
そこで今回はレスポンス部対応のLightbox系の決定版!「PhotoSwipe」をご紹介します。
PhotoSwipeのサンプル
まずはどういうものかを見てみないことには、自分のサイトに実装したいようなものかがわかりませんよね。
動作デモはPhotoSwipeの公式サイトでご覧頂けます。
サイト PhotoSwipe公式サイト
いかがですか？
パソコンのブラウザでもスワイプができますが、ぜひスマートフォンでも見ていただきたいです。
私が決定版と言っている意味をわかって頂けると思います。
PhotoSwipeの実装方法
ファイルをダウンロード
まずはファイルをダウンロードしてきましょう。
ファイルはGitHubにあります。
サイト GitHub – dimsemenov/PhotoSwipe:
「ckone of download」ボタンをクリックして「Download ZIP」からダウンロードできます。
使用するファイルを確認
「PhotoSwipe-master.zip」を解凍すると、いくつかファイルがありますが、基本的には「dist」内のファイルを使用します。
自サイトの適当なところにデータ放り込んでください。
私の設置場所はこんな感じです。
/js/PhotoSwipe-master/dist/
ファイルの読み込み
ファイルを読み込むように設定を行います。
<head>内に設置してください。
※JavaScript（追加外部ファイル）部分はあとで解説します。
<!-- CSS --> <link rel="stylesheet" href="js/PhotoSwipe-master/dist/photoswipe.css"> <link rel="stylesheet" href="js/PhotoSwipe-master/dist/default-skin/default-skin.css"> <!-- JavaScript --> <script src="js/PhotoSwipe-master/dist/photoswipe.min.js"></script> <script src="js/PhotoSwipe-master/dist/photoswipe-ui-default.min.js"></script> <!-- JavaScript（追加外部ファイル） --> <script src="js/PhotoSwipe-master/dist/photoswipe-sub.js"></script>
セット用のjavascript
セット用のjavascriptを追加します。
photoswipe-ui-default.min.jsを読み込んだ後に直接<script></script>で囲んで記述してもいいですが、長いので、私は外部ファイル（ひとつ前の項目の「追加外部ファイル」）として読み込みました。
名前は適当でいいのですが、今回はphotoswipe-sub.jsとして下記のコードを記載し、読み込んでいます。
var initPhotoSwipeFromDOM = function(gallerySelector) {
// parse slide data (url, title, size ...) from DOM elements
// (children of gallerySelector)
var parseThumbnailElements = function(el) {
var thumbElements = el.childNodes,
numNodes = thumbElements.length,
items = [],
figureEl,
linkEl,
size,
item;
for(var i = 0; i < numNodes; i++) {
figureEl = thumbElements[i]; // <figure> element
// include only element nodes
if(figureEl.nodeType !== 1) {
continue;
}
linkEl = figureEl.children[0]; // <a> element
size = linkEl.getAttribute('data-size').split('x');
// create slide object
item = {
src: linkEl.getAttribute('href'),
w: parseInt(size[0], 10),
h: parseInt(size[1], 10)
};
if(figureEl.children.length > 1) {
// <figcaption> content
item.title = figureEl.children[1].innerHTML;
}
if(linkEl.children.length > 0) {
// <img> thumbnail element, retrieving thumbnail url
item.msrc = linkEl.children[0].getAttribute('src');
}
item.el = figureEl; // save link to element for getThumbBoundsFn
items.push(item);
}
return items;
};
// find nearest parent element
var closest = function closest(el, fn) {
return el && ( fn(el) ? el : closest(el.parentNode, fn) );
};
// triggers when user clicks on thumbnail
var onThumbnailsClick = function(e) {
e = e || window.event;
e.preventDefault ? e.preventDefault() : e.returnValue = false;
var eTarget = e.target || e.srcElement;
// find root element of slide
var clickedListItem = closest(eTarget, function(el) {
return (el.tagName && el.tagName.toUpperCase() === 'FIGURE');
});
if(!clickedListItem) {
return;
}
// find index of clicked item by looping through all child nodes
// alternatively, you may define index via data- attribute
var clickedGallery = clickedListItem.parentNode,
childNodes = clickedListItem.parentNode.childNodes,
numChildNodes = childNodes.length,
nodeIndex = 0,
index;
for (var i = 0; i < numChildNodes; i++) {
if(childNodes[i].nodeType !== 1) {
continue;
}
if(childNodes[i] === clickedListItem) {
index = nodeIndex;
break;
}
nodeIndex++;
}
if(index >= 0) {
// open PhotoSwipe if valid index found
openPhotoSwipe( index, clickedGallery );
}
return false;
};
// parse picture index and gallery index from URL (#&pid=1&gid=2)
var photoswipeParseHash = function() {
var hash = window.location.hash.substring(1),
params = {};
if(hash.length < 5) {
return params;
}
var vars = hash.split('&');
for (var i = 0; i < vars.length; i++) {
if(!vars[i]) {
continue;
}
var pair = vars[i].split('=');
if(pair.length < 2) {
continue;
}
params[pair[0]] = pair[1];
}
if(params.gid) {
params.gid = parseInt(params.gid, 10);
}
if(!params.hasOwnProperty('pid')) {
return params;
}
params.pid = parseInt(params.pid, 10);
return params;
};
var openPhotoSwipe = function(index, galleryElement, disableAnimation) {
var pswpElement = document.querySelectorAll('.pswp')[0],
gallery,
options,
items;
items = parseThumbnailElements(galleryElement);
// define options (if needed)
options = {
index: index,
// define gallery index (for URL)
galleryUID: galleryElement.getAttribute('data-pswp-uid'),
getThumbBoundsFn: function(index) {
// See Options -> getThumbBoundsFn section of documentation for more info
var thumbnail = items[index].el.getElementsByTagName('img')[0], // find thumbnail
pageYScroll = window.pageYOffset || document.documentElement.scrollTop,
rect = thumbnail.getBoundingClientRect();
return {x:rect.left, y:rect.top + pageYScroll, w:rect.width};
}
};
if(disableAnimation) {
options.showAnimationDuration = 0;
}
// Pass data to PhotoSwipe and initialize it
gallery = new PhotoSwipe( pswpElement, PhotoSwipeUI_Default, items, options);
gallery.init();
};
// loop through all gallery elements and bind events
var galleryElements = document.querySelectorAll( gallerySelector );
for(var i = 0, l = galleryElements.length; i < l; i++) {
galleryElements[i].setAttribute('data-pswp-uid', i+1);
galleryElements[i].onclick = onThumbnailsClick;
}
// Parse URL and open gallery if it contains #&pid=3&gid=1
var hashData = photoswipeParseHash();
if(hashData.pid > 0 && hashData.gid > 0) {
openPhotoSwipe( hashData.pid - 1 , galleryElements[ hashData.gid - 1 ], true );
}
};
// execute above function
window.onload = function(){
initPhotoSwipeFromDOM(".my-gallery");
}
PhotoSwipe表示用のHTML
PhotoSwipe動作表示用のHTMLパーツを追加します。
自分のhtmlファイルの邪魔にならない部分に追加してください。
私はギャラリー画像（小さい画像を並べている部分）を表示しているHTMLの下に追加しました。
<!-- Root element of PhotoSwipe. Must have class pswp. -->
<div class="pswp" tabindex="-1" role="dialog" aria-hidden="true">
<div class="pswp__bg"></div>
<div class="pswp__scroll-wrap">
<div class="pswp__container">
<div class="pswp__item"></div>
<div class="pswp__item"></div>
<div class="pswp__item"></div>
</div>
<div class="pswp__ui pswp__ui--hidden">
<div class="pswp__top-bar">
<div class="pswp__counter"></div>
<button class="pswp__button pswp__button--close" title="Close (Esc)"></button>
<button class="pswp__button pswp__button--share" title="Share"></button>
<button class="pswp__button pswp__button--fs" title="Toggle fullscreen"></button>
<button class="pswp__button pswp__button--zoom" title="Zoom in/out"></button>
<div class="pswp__preloader">
<div class="pswp__preloader__icn">
<div class="pswp__preloader__cut">
<div class="pswp__preloader__donut"></div>
</div>
</div>
</div>
</div>
<div class="pswp__share-modal pswp__share-modal--hidden pswp__single-tap">
<div class="pswp__share-tooltip"></div>
</div>
<button class="pswp__button pswp__button--arrow--left" title="Previous (arrow left)">
</button>
<button class="pswp__button pswp__button--arrow--right" title="Next (arrow right)">
</button>
<div class="pswp__caption">
<div class="pswp__caption__center"></div>
</div>
</div>
</div>
</div>
ギャラリー画像部分のHTML
やっとですが、ギャラリー部分（サムネイル部分）の表示HTMLです。
<div class="my-gallery"> <figure> <a href="[画像のURL]" data-size="[画像サイズ]"><img src="[サムネイルのURL]" /></a> <figcaption>[キャプション]</figcaption> </figure> <figure> <a href="img/photo.jpg" data-size="600x400"><img src="img/photo_s.jpg" /></a> <figcaption>キャプション</figcaption> </figure> </div>
まとめ
PhotoSwipeを使用したギャラリーはいかがでしょうか。
もっといいものが現れるまでは、当分「PhotoSwipe」を使用すると思います。
