PhotoSwipe入门（2）
太叔高义
开始之前
- PhotoSwipe不像jquery插件那样简单。你需要有一些javascript基础。
- PhotoSwipe需要预定义图片的尺寸（more about this）
- 如果你在非响应式网站上使用PhotoSwipe,控制器将会被缩放（基于整个页面缩放）。因此你需要自己实现控制器（如右上角的关闭按钮）
- 插件中的所有代码是原汁原味的js并且支持IE8及其以上。如果你的网站或应用使用一些javascript框架（如jQuery或MooTools）或你不需要支持老的浏览器，你可以自由的简化插件代码。
- 避免为移动设备提供大的图片（大于2000X1500px），它们会非常灵异的降低动画性能，更有甚，会引起崩溃，特别是在IOS系统上的safari浏览器上。解决方案：提供响应式图片或在单独的页面打开图片或使用支持图片响应的库（像 Leaflet）
- 更多问题，请参照快问快答页面（more in FAQ）
初始化
第一步：引入JS和CSS文件
你可以在 dist 目录 或 Github仓库 中找到他们。sass 和 编译后的js文件在src目录下，如果你对默认的UI样式或代码结构或注释不满意，我推荐你使用sass。
<!-- Core CSS file -->
<link rel="stylesheet" href="path/to/photoswipe.css">
<!-- Skin CSS file (styling of UI - buttons, caption, etc.)
In the folder of skin CSS file there are also:
- .png and .svg icons sprite,
- preloader.gif (for browsers that do not support CSS animations) -->
<link rel="stylesheet" href="path/to/default-skin/default-skin.css">
<!-- Core JS file -->
<script src="path/to/photoswipe.min.js"></script>
<!-- UI JS file -->
<script src="path/to/photoswipe-ui-default.min.js"></script>
不管你怎么引入或在什么地方JS和CSS文件，代码执行仅仅需要new PhotoSwipe(),所以，你可以在你需要的时候加载文件。
PhotoSwipe也支持AMD加载方式（如：RequireJS）和CommonJS，你可以像下面这样使用他们：
require([
'path/to/photoswipe.js',
'path/to/photoswipe-ui-default.js',
],function(PhotoSwipe, PhotoSwipeUI_default){
//var gallery = new PhotoSwipe( someElement, PhotoSwipeUI_Default ...
// gallery.init()
// ...
})
你也可以通过Bower（bower install photoswipe）或NPM（npm install photoswipe）安装PhotoSwipe
第二步：添加PhotoSwipe（.pswp）元素到DOM结构中
你可以通过js动态的添加HTML代码（在PhotoSwipe初始化之前），或在页面加载的时候，就把photoswipe（.pswp）元素写在页面中随页面一起加载。这段代码可以在任何地方添加，比较理想的是放在body元素中。你可以在多个画廊中使用这段代码，但是必须保证有相同的CSSclass，
<!-- Root element of PhotoSwipe. Must have class pswp. -->
<div class="pswp" tabindex="-1" role="dialog" aria-hidden="true">
<!-- Background of PhotoSwipe.
It's a separate element as animating opacity is faster than rgba(). -->
<div class="pswp__bg"></div>
<!-- Slides wrapper with overflow:hidden. -->
<div class="pswp__scroll-wrap">
<!-- Container that holds slides.
PhotoSwipe keeps only 3 of them in the DOM to save memory.
Don't modify these 3 pswp__item elements, data is added later on. -->
<div class="pswp__container">
<div class="pswp__item"></div>
<div class="pswp__item"></div>
<div class="pswp__item"></div>
</div>
<!-- Default (PhotoSwipeUI_Default) interface on top of sliding area. Can be changed. -->
<div class="pswp__ui pswp__ui--hidden">
<div class="pswp__top-bar">
<!-- Controls are self-explanatory. Order can be changed. -->
<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>
<!-- Preloader demo http://codepen.io/dimsemenov/pen/yyBWoR -->
<!-- element will get class pswp__preloader--active when preloader is running -->
<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>
pswp__bg,pswp__scroll-wrap,pswp__container,pswp__item元素的顺序不许改变。
你可能会问：为什么PhotoSwipe不能动态的添加这段代码
原因也很简单：缩减文件大小，你可能会更改一些布局。
第三步：插件初始化
执行PhotoSwipe构造函数，它接收四个参数：
- 第二步中
.pswp元素必须添加到DOM中 - 提供
PhotoSwipeUIclass。如果你引入了photoswipe-ui-default.js,那么UI类将会是PhotoSwipeUI_Default。否则是false。 - 包含对象的数组（slides）
- options
var pswpElement = document.querySelectorAll('.pswp')[0];
// build items array
var items = [
{
src: 'https://placekitten.com/600/400',
w: 600,
h: 400
},
{
src: 'https://placekitten.com/1200/900',
w: 1200,
h: 900
}
];
// define options (if needed)
var options = {
// optionName: 'option value'
// for example:
index: 0 // start at first slide
};
// Initializes and opens PhotoSwipe
var gallery = new PhotoSwipe( pswpElement, PhotoSwipeUI_Default, items, options);
gallery.init();
然后，就出效果了，如下，你可全屏查看效果：
如果仅仅为了用而用，那么到此就不用继续向下看了
Array(数组) of Slide Objects
数组中的每个对象应该包含slide数据。它可以是你希望展示在PhotoSwipe中的任何东西。
像：图片地址，标题，分享条目，评论等
默认情况下PhotoSwipe使用5个属性：
- src: 图片的地址
- w：图片宽度
- h：图片高度
- msrc：小图片地址占位符
- html：自定义html（more about this）
在图片导航过程中，PhotoSwipe会自添加属性到这个 slide 对象上（如：minZoom,loaded）
var slides = [
// slide 1
{
src: 'path/to/image1.jpg', // path to image
w: 1024, // image width
h: 768, // image height
msrc: 'path/to/small-image.jpg', // small image placeholder,
// main (large) image loads on top of it,
// if you skip this parameter - grey rectangle will be displayed,
// try to define this property only when small image was loaded before
title: 'Image Caption' // used by Default PhotoSwipe UI
// if you skip it, there won't be any caption
// You may add more properties here and use them.
// For example, demo gallery uses "author" property, which is used in the caption.
// author: 'John Doe'
},
// slide 2
{
src: 'path/to/image2.jpg',
w: 600,
h: 600
// etc.
}
// etc.
];
在PhotoSwipe使用数据之前，你可以直接的动态地定义每个slide属性。使用gettingData事件，关于这部分更多请移步到API Section of docs。例如：你可以使用这种技术为不同的屏幕提供不同尺寸的图片。
如何构建一个数组的幻灯片链接列表
假设你有一个链接列表/缩略图是这样的：关于画廊标签的更多信息，SEO优化
<div class="my-gallery" itemscope itemtype="http://schema.org/ImageGallery">
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="large-image.jpg" itemprop="contentUrl" data-size="600x400">
<img src="small-image.jpg" itemprop="thumbnail" alt="Image description" />
</a>
<figcaption itemprop="caption description">Image caption</figcaption>
</figure>
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
<a href="large-image.jpg" itemprop="contentUrl" data-size="600x400">
<img src="small-image.jpg" itemprop="thumbnail" alt="Image description" />
</a>
<figcaption itemprop="caption description">Image caption</figcaption>
</figure>
</div>
如果你需要点击缩略图打开大图片图库
你需要做到如下几点：
- 把链接/缩略图与
click事件绑定 - 用户点击缩略图后，获取缩略图的索引值
- 创建幻灯片对象数组。遍历DOM元素获取所有的链接和检索
href属性(大型图像url),data-size属性, 缩略图的src和标题。
PhotoSwipe不会关心你如何做到上面这些。如果你使用jQuery库或MooTools库，又或者你不需要支持IE8，那么代码将会极其简洁。
下面是原生js实现的，支持IE8：
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);
}
return params;
};
var openPhotoSwipe = function(index, galleryElement, disableAnimation, fromURL) {
var pswpElement = document.querySelectorAll('.pswp')[0],
gallery,
options,
items;
items = parseThumbnailElements(galleryElement);
// define options (if needed)
options = {
// 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};
}
};
// PhotoSwipe opened from URL
if(fromURL) {
if(options.galleryPIDs) {
// parse real index when custom PIDs are used
// http://photoswipe.com/documentation/faq.html#custom-pid-in-url
for(var j = 0; j < items.length; j++) {
if(items[j].pid == index) {
options.index = j;
break;
}
}
} else {
// in URL indexes start from 1
options.index = parseInt(index, 10) - 1;
}
} else {
options.index = parseInt(index, 10);
}
// exit if index not found
if( isNaN(options.index) ) {
return;
}
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 && hashData.gid) {
openPhotoSwipe( hashData.pid , galleryElements[ hashData.gid - 1 ], true, true );
}
};
// execute above function
initPhotoSwipeFromDOM('.my-gallery');
Example on CodePen (focus & history options are disabled due to embed issues):
提示：你可能需要从CodePen下载例子在本地跑一跑。（Edit on CodePen -> Share -> Export .zip)）
- 如果你需要使用不同的标签（自定义UI界面），那么你需要编辑功能函数
parseThumbnailElements - 如果你对原生js经验不足或不知道如何解析DOM，请参考：quirksmode和documentation on MDN.
- IE8不支持html5标签
<figure>和<figcation>元素。你需要在<head>标签中引入html5shiv，如下：
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.2/html5shiv.min.js"></script>
<![endif]-->
类似资料：