Image view plugin
npm install zx-image-view图片预览插件,支持图片切换、旋转、缩放、移动...
浏览器支持:IE10+, (IE9不支持旋转功能)
> 方向键:左left右right前后图片切换,上up下down顺时针逆时针旋转
> 滚动鼠标:缩放
注:支持自定义按键配置,详见参数说明。
npm
```
npm install zx-image-view --save-dev或
npm i zx-image-view -D
ES6+
`javascript`
import { ZxImageView } from 'zx-image-view'
浏览器Brower
`html`




使用方法 1
`javascript
var ziv1 = new ZxImageView(options, imgArray1);
// 点击缩略图,查看大图
var $el = document.getElementById('imgList');
$el.addEventListener('click', function (e) {
if (this.nodeName === 'IMG') {
// 获取图片索引
var index = this.getAttribute('data-index');
// 查看图片
ziv1.view(index);
}
})
`
使用方法 2
`javascript`
var ziv2 = new ZxImageView(imgArray2);
使用方法 3
`javascript`
var ziv3 = new ZxImageView();
ziv3.init(imgArray2);
使用方法 4
`javascript`
var ziv4 = new ZxImageView();
// 业务场景,针对后台管理列表页,每条数据(动态)有多张图片,需独立预览,不需要多次实例化ZxImageView
// 查看imgArray2第3张图片
ziv4.view(2, imgArray2);
开发调试
``
npm run devhttp://localhost:9000/
|参数|类型|说明|
|:--|:--|:--|
|backgroundOpacity|Floor|背景遮罩(黑色)透明度,取值0-1,默认值0.6|true
|iconfont|String|iconfont图标字体css样式url地址(样式名见附录iconfont说明)|
|keyboard|Object|键盘按钮(前/后一张、缩放、旋转、关闭)配置|
|movable|Boolean|移动图片,默认值|true
|paginationable|Boolean|分页mouseover切换图片,默认值|true
|rotatable|Boolean|旋转图片,默认值|true
|scalable|Boolean|缩放图片,默认值|true
|showClose|Boolean|显示关闭预览窗口按钮,默认值|true
|showPagination|Boolean|显示分页栏,默认值|true
|showSwitchArrow|Boolean|显示左右切换箭头按钮,默认值|false
|showToolbar|Boolean|显示工具栏,默认值|['prev', 'enlarge', 'rotate', 'reduce', 'next']
|toolbarButtons|Array|工具栏按钮数量及顺序配置,可选值/默认值|
#### options.keyboard
|参数|类型|可选键名|说明|
|:--|:--|:--|:--|
|close|String|关闭图片查看器|
|next|String|任意键|下一张|
|prev|String|任意键或mousewheel|上一张;为mousewheel时,next无效|mousewheel
|rotate|String或Array|任意键或|图片旋转|mousewheel
|scale|String或Array|任意键或|图片缩放|
注意:参数中只能包含有且一个mousewheel配置;任何配置均不支持组合键。
keyboard参数可选属性见页尾--附录
`javascript`
// 初始化参数
let _config = {
// 分页mouseover切换图片
paginationable: true,
// 显示关闭按钮
showClose: true,
// 显示上一张/下一张箭头
showSwitchArrow: true,
// 显示分页导航栏
showPagination: true,
// 缩放
scalable: true,
// 旋转
rotatable: true,
// 移动
movable: true,
// 键盘配置
keyboard: {
prev: 'a',
next: 'd',
rotate: ['up', 'down'],
scale: 'mousewheel'
}
}
new ZxImageView(_config);
* destroy() 销毁当前图片查看dom对象
* init(imageArray, index) 初始化图片数据
|参数|类型|必须|说明|
|:--|:--|:--|:--|
|imageArray|Array|是|图片url数组|
|index|Number|否|imageArray的索引,默认显示的第index + 1张图片;默认为0; 如果index > imageArray.length将被忽略|
* view(index, angle, imageArray) 查看第index + 1张图片
|参数|类型|必须|说明|
|:--|:--|:--|:--|
|index|Number|是|imageArray的索引,显示的第index + 1张图片|
|angle|Number|否|图片旋转角度,90的整数倍|
|imageArray|Array|否|图片url数组,将更新初始化的图片数组|
* iconfont样式名说明
字体样式.zx,图标样式如下图:
http://www.iconfont.cn/
* 支持自定义键盘按钮名/keyboard参数可选属性
|属性|键名/说明|
|:--|:--|
|escape|Esc键|
|主键盘| |
|backquote| ~ 键|1(!)
|digit1| 键 |2(@)
|digit2| 键 |3(#)
|digit3| 键 |4($)
|digit4| 键 |5(%)
|digit5| 键 |6(^)
|digit6| 键 |7(&)
|digit7| 键 |8(*)
|digit8| 键 |9(()
|digit9| 键 |0())
|digit0| 键 |=(+)
|equal| 键 |-(-)
|minus| 键 |A
|a-z|至Z键|({)
|bracketLeft| 键 |
|bracketRight| 键 |;(:)
|semicolon| 键 |'(")
|quote| 键 |反斜线
|backslash| 键 |,(>)
|period| 键 |.(<)
|comma| 键 |/(?)
|slash| 键 |/
|space| 空格键 |
|数字键盘||
|numpad0| 0 |
|numpad1| 1 |
|numpad2| 2 |
|numpad3| 3 |
|numpad4| 4 |
|numpad5| 5 |
|numpad6| 6 |
|numpad7| 7 |
|numpad8| 8 |
|numpad9| 9 |
|numpadDivide| 分或除 |*
|numpadMultiply| 乘 |-
|numpadSubtract| 减 |+
|numpadAdd| 加 |.`小数点 |
|numpadDecimal|
|编辑键区||
|insert| Insert 键 |
|home| Home 键 |
|end| End 键 |
|pageUp| PageUp 键 |
|pageDown| PageDown |
|delete| Delete 键 |
|left| 方向键左(ArrowLeft) |
|right| 方向键右(ArrowRight) |
|up| 方向键上(ArrowUp) |
|down| 方向键下(ArrowDown) |
|鼠标滚动|说明|
|:--|:--|
|mousewheel|鼠标滚动键|
Code and documentation copyright 2018. capricorncd. Code released under the MIT License.