1.0.1 • Published 2 years ago

cellular-img-preview v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

cellular-img-preview 简介

npm.io npm.io npm.io

本组件是一个基于 vue 编写的 vue 图片预览组件,支持 pc 和手机端,支持单图和多图预览,仅传入一个图片地址,即可实现图片预览效果。手机端支持单指拖拽和双指缩放.

使用npm进行安装

npm install cellular-img-preview

在main.js进行全局引入

import cellularImgPreview from 'cellular-img-preview'
Vue.use(cellularImgPreview)

在组件中进行使用

<img :src="url" @click="previewImg(url)">
methods: {
	previewImg (url) {
		this.$cellularImgPreview(url)
	}
}

使用

this.\$cellularImgPreview() 方法可以接收一个字符串类型的 url,或者对象类型的配置,具体使用方法如下

  • 接收一个地址字符串this.$cellularImgPreview(url)
this.$cellularImgPreview('https://fuss10.elemecdn.com/8/27/f01c15bb73e1ef3793e64e6b7bbccjpeg.jpeg') // 线上地址
this.$cellularImgPreview('./img/logo.jpeg') // 本地地址
  • 接收一个对象this.$cellularImgPreview(options)
# 单图预览
this.$cellularImgPreview({
    url: 'https://fuss10.elemecdn.com/8/27/f01c15bb73e1ef3793e64e6b7bbccjpeg.jpeg',
})

# 多图预览
this.$cellularImgPreview({
    multiple: true, // 开启多图预览模式
    nowImgIndex: 1, // 多图预览,默认展示第二张图片
    imgList: ['1.png', '2.png', '3.png'], // 需要预览的多图数组
})

配置项

字段类型默认值备注
urlString预览的图片地址,多图预览时省略
multipleBooleanfalse是否多图预览
nowImgIndexNumber0多图预览时默认显示的图片下标
imgListArray多图预览时传入的图片数组
keyboardBooleanfalse是否开启键盘控制
clickMaskCLoseBooleanfalse是否可以点击遮罩层关闭
controlBarBooleantrue是否显示控制条及页码
closeBtnBooleantrue是否显示关闭按钮
arrowBtnBooleantrue是否显示左右翻页按钮

全局配置

对于某些配置,例如开启键盘事件,点击遮罩层关闭,我们可能要全局保持统一,但却需要在每一次调用时重复配置,为了解决这个问题,我们提供了全局配置项,您可以在引入插件的时候,将全局配置项作为第二个参数传入即可,以免再每次调用的时候重复配置。

// main.js
import cellularImgPreview from 'cellularImgPreview'
Vue.use(cellularImgPreview, {
  keyboard: true,
  clickMaskCLose: true
  ...
})

如开启键盘控制事件后,相对应功能控制按键如下

按键功能
w放大
s缩小
a上一张
d下一张
q逆时针旋转
e顺时针旋转
r图片复位
esc关闭图片预览