Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

pic-viewer

Package Overview
Dependencies
Maintainers
4
Versions
60
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

pic-viewer

Picture viewer.

  • 0.6.3
  • npm
  • Socket score

Version published
Weekly downloads
10
increased by42.86%
Maintainers
4
Weekly downloads
 
Created
Source

Pic Viewer Version Badge

minzipped size code style conventional commits

图片画廊。


特性

  • viewerjs + swiper + qrcode 组合拳
  • 多样的展示形式: 支持文档流、轮播图、自适应瀑布流、嵌套在表格内(兼容 el-table
  • 灵活的数据类型: 支持 stringJSON stringstring[]object[]
  • 图片源支持 URL、Base64、二维码
  • 局部注册 + 局部传参,也可以全局注册 + 全局传参(vue-global-config 提供技术支持)

安装

外置依赖

  • vue@2

局部注册

npm add pic-viewer
<template>
  <PicViewer v-bind="{/* 局部配置 */}" />
</template>

<script>
import 'pic-viewer/dist/style.css'
import PicViewer from 'pic-viewer'

export default {
  components: { PicViewer },
}
</script>

全局注册

npm add pic-viewer
import 'pic-viewer/dist/style.css'
import PicViewer from 'pic-viewer'

Vue.use(PicViewer, {
  // 全局配置
})

CDN + ESM

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8" />
  <link
    rel="stylesheet"
    href="https://unpkg.com/pic-viewer@0.6/dist/style.css"
  >
</head>

<body>
  <div id="app">
    <pic-viewer
      value="xxx"
      qrcode
    ></pic-viewer>
  </div>
  <script type="importmap">
    {
      "imports": {
        "vue": "https://unpkg.com/vue@2/dist/vue.esm.browser.min.js",
        "pic-viewer": "https://unpkg.com/pic-viewer@0.6/dist/pic-viewer.mjs"
      }
    }
  </script>
  <script type="module">
    import Vue from 'vue'
    import PicViewer from 'pic-viewer'

    new Vue({
      components: { PicViewer },
    }).$mount('#app')
  </script>
</body>

</html>

CDN + UMD

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8" />
  <link
    rel="stylesheet"
    href="https://unpkg.com/pic-viewer@0.6/dist/style.css"
  >
</head>

<body>
  <div id="app">
    <pic-viewer
      value="xxx"
      qrcode
    ></pic-viewer>
  </div>
  <script src="https://unpkg.com/vue@2"></script>
  <script src="https://unpkg.com/pic-viewer@0.6"></script>
  <script>
    new Vue({
      components: { PicViewer },
    }).$mount('#app')
  </script>
</body>

</html>

Props

参数名说明类型默认值
value图片源string, string[], object[]
pattern展示模式(waterfall, swipertable-cellstringundefined(即文档流)
viewerjs是否启用 viewerjsbooleantrue
viewerjsPropsviewerjs 的参数object{ zIndex: 5000, zoomRatio: 0.4 }
srcAt指定图片源所在的键(如果 value 为 object[] 类型)string
swiperPropsswiper 的参数object{ observer: true }
qrcode是否将 value 转换为二维码boolean, 'auto'false
qrcodePropsqrcode 的参数object{ margin: 0, errorCorrectionLevel: 'L', width: 444, height: 444 }

qrcode

如果将 qrcode 设为 'auto',pic-viewer 会自动判断是否需要转换(value 为 Base64 或 URL 时不会转换)


Events

名称说明参数
click点击图片后触发{ src, index }

Slots

名称说明
默认插槽自定义 img 标签
<!-- 示例 -->

<PicViewer>
  <template v-slot="{ src, index }">
    <img :src="src" alt="">
    <div>第{{ index + 1 }}张</div>
  </template>
</PicViewer>

Methods

名称说明参数
preview手动预览数组下标,默认值为0

编程式调用预览

手动调用预览,不再外部展示


<PicViewer :value="" v-show="false" ref="PicViewer"/>
<button @click="()=>{$refs.PicViewer.preview(6)}">preview</button>

二维码清晰度

默认的图片 CSS 高度为148px(与 el-upload 保持一致),默认的二维码分辨率为444×444(三倍图),如果你增大了图片的 CSS 尺寸,将导致图片变模糊

解决: 将二维码分辨率设置为展示尺寸的三倍

<!-- 示例 -->

<template>
  <PicViewer
    :qrcodeProps="{
      width: 900,
      height: 900,
    }"
  />
</template>

<style scoped>
::v-deep .pic-viewer img {
  width: 300px;
  height: 300px;
}
</style>

获取 Swiper 实例

<template>
  <PicViewer
    ref="picViewer" pattern="swiper" :swiperProps="{
      on: {
        init: onSwiperInit,
      },
    }"
  />
</template>

<script>
import 'pic-viewer/dist/style.css'
import PicViewer from 'pic-viewer'

export default {
  components: { PicViewer },
  data() {
    return {
      swiper: null
    }
  },
  methods: {
    onSwiperInit() {
      this.$nextTick(() => {
        this.swiper = this.$refs.picViewer.swiper
      })
    }
  }
}
</script>

更新日志

各版本详细改动请参考 release notes


Keywords

FAQs

Package last updated on 30 Nov 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc