0.2.2 • Published 7 years ago

jroll-viewer v0.2.2

Weekly downloads
1
License
MIT
Repository
github
Last release
7 years ago

JRollViewer

一款基于JRoll开发的图集查看器插件

注意!!!

  1. 必须 JRoll v2.4.x 以上

  2. document.body高度超出一屏,即当document.body.scrollTop不为0时会影响本插件的滚动效果。

  3. 请将document.body的css样式设为overflow:hidden;height:100%,超出内容使用JRoll进行滑动

Tips:html的height为100%时,body的高度才能占满全屏

引入

支持标签、CommonJS、AMD、CMD方式引入

标签

<!-- 先引入JRoll再引入JRollViewer -->
<script src="jroll.js"></script>
<script src="jroll-viewer.js"></script>

AMD

define(['jroll', 'jroll-viewer'], function (JRoll, JRollViewer) {
  var viewer = new JRollViewer('#viewer'{
    JRoll: JRoll //不能确定引入顺序时可以参数形式将JRoll传给JRollViewer
  })
})

使用说明

<!-- 基本用法 -->
<div id="viewer">
  <img src="http://www.cdn.cn/1.png" jroll-viewer-image>
  <img src="../images/2.jpg" jroll-viewer-image>
  <img src="../images/3.gif">
</div>

<script>
var viewer = new JRollViewer('#viewer')
</script>
  1. div#viewer容器里存放img图片,图片必须带jroll-viewer-image标记
  2. new JRollViewer('#viewer')div#viewer创建为JRollViewer实例容器
  3. 点击带jroll-viewer-image标记的图片即可打开图片查看器

选项

new JRollViewer(el [, options])
键名默认值说明
dataundefined小图dataset的属性作为大图读取的图片路径,若不指定该选项,默认读取小图src
zoomMax图片原始值图片最大缩放倍数,以window.innerWidth为1
afterSwitchundefined图片切换后执行的回调函数,function (i) {...} i为切换后图片的索引值,索引从0开始
JRollwindow.JRoll用于异步引入JRoll,不能确保window.JRoll比window.JRollViewer先加载完成时使用

例:

<div id="viewer">
  <img src="http://www.cdn.cn/1.png" data-big="http://www.cdn.cn/b1.png" jroll-viewer-image>
</div>

<script>
var viewer = new JRollViewer('#viewer', {
  data: 'big',
  zoomMax: 3,
  JRoll: window.JRoll
})
</script>

方法

show

// 打开第一张图片
viewer.show(0)

// or 打开src为`../images/2.jpg`的图片
viewer.show('../images/2.jpg')

// or 打开指定 img dom 的图片
viewer.show(document.getElementById('viewer').children[0])

一个参数,打开选中的图片

hide

收起图片查看器

viewer.hide()

switch

手动切换图片,可利用该方法做图片自动轮播

viewer.switch(1, 200)

viewer.switch(index, duration)

  • index 必填,索引值,要切换到哪张图片
  • duration 可选,过渡时间,当该值转为布尔类型不为false时会执行选项的afterSwitch方法

技巧

自定义点击退出事件

目前默认点击图集查看器时会自动退出,如果需要点击时不退出,而是显示自己的头部导航等内容时,可以自行改写点击事件

在自己的退出按钮点击执行hide方法即可退出图集查看器

document.getElementById('jroll_viewer').onclick = function () {
  // 你的代码
}

Log

v0.2.2 (2017-03-10)

  • 使用JRoll v2.4.7 新增的edgeRelease选项,修复body.scrollTop不为0时图片滑动失效的问题

v0.2.1 (2017-03-09)

  • 优化滑动体验
  • 修复屏幕旋转时报undefined的错误

v0.2.0 (2017-03-08)

  • 添加afterSwitch方法
  • 修改滑动阀值

v0.1.3 (2016-12-02)

  • 超过5张图,将小圆点改为数字

v0.1.2 (2016-12-01)

  • 添加data选项

v0.1.1 (2016-11-29)

  • 修改了使用方式
  • 允许多实例并存
  • 每次打开查看器,重新生成要查看的图片,避免不断创建查看器
  • 修复body.scrollTop不为0时错位的问题

v0.0.2 (2016-11-25)

  • 完成