從開發到發佈一款基於Vue2x的圖片預覽插件

項目地址: vue-picture-viewer

先來看下Demo

LiveDemo

關於開發Vue插件的幾種方式 （具體請移步官網）Vue官網

MyPlugin.install = function (Vue, options) {
  // 1. 添加全局方法或屬性
  Vue.myGlobalMethod = function () {
    // 邏輯...
  }

  // 2. 添加全局資源
  Vue.directive('my-directive', {
    bind (el, binding, vnode, oldVnode) {
      // 邏輯...
    }
    ...
  })

  // 3. 注入組件
  Vue.mixin({
    created: function () {
      // 邏輯...
    }
    ...
  })

  // 4. 添加實例方法
  Vue.prototype.$myMethod = function (methodOptions) {
    // 邏輯...
  }
}

複製代碼

我採用第一種方式來編寫這個插件

• 1.第一步建立項目 vue init webpack-simple youProjectName(你的項目名稱)具體操做不在贅述

• 2.開始插件開發，編寫index.js

import vuePictureViewer from './vue-picture-viewer'

const pictureviewer = {
  install (Vue, options) {
    Vue.component(vuePictureViewer.name, vuePictureViewer)
  }
}

if (typeof window !== 'undefined' && window.Vue) { // 這段代碼很重要
  window.Vue.use(pictureviewer)
}

export default pictureviewer
複製代碼

• 3.編寫vue-picture-viewer.vue也挺簡單(具體能夠去看源碼)
• 4.如何使用（main.js）

import vuePictureViewer from './lib/index.js'
Vue.use(vuePictureViewer)
複製代碼

App.vue

<template>
  <div id="app">
    <vue-picture-viewer :imgData="imgUrl" :switch="true" v-if="imgUrl"></vue-picture-viewer>
  </div>
</template>

<script>
export default {
  name: 'app',
  data () {
    return {
      imgUrl: [{
          url:'http://p8ny46w8x.bkt.clouddn.com/test1.jpg',
          name: 'test1.jpg'
        },
        {
          url: 'http://p8ny46w8x.bkt.clouddn.com/test2.jpg',
          name: 'test2.jpg'
        }, {
          url: 'http://p8ny46w8x.bkt.clouddn.com/test3.jpg',
          name: 'test3.jpg'
        },
        {
          url: 'http://p8ny46w8x.bkt.clouddn.com/test4.jpg',
          name: 'test4.jpg'
        }]
    }
  }
}
</script>

<style>
* {
  margin: 0;
  padding: 0;
}
html, body {
  width: 100%;
  height: 100%;
}
</style>

複製代碼

• 5.打包前的配置webpack.config.js（很重要！！！）

module.exports = {
  entry: './src/lib/index.js',
  output: {
    path: path.resolve(__dirname, './dist'),
    publicPath: '/dist/',
    // filename: 'build.js',
    filename: 'vue-picture-viewer.js',
    library: 'pictureViewer',
    libraryTarget: 'umd',
    umdNamedDefine: true
  },
複製代碼

• 6.打包成功，配置package.json

"license": "MIT", // 許可證
  "private": false, // 默認是true 私人的 須要改成false, 否則發佈不成功！
  "main": "dist/vue-picture-viewer.js", 這個超級重要 決定了你 import xxx from 「vue-picture-viewer」 它默認就會去找 dist下的vue-picture-viewer 文件
  "repository": {
    "type": "git",
    "url": "https://github.com/sangcz/vue-picture-viewer" // github項目地址
  },
複製代碼

• 7.一切Ok準備發佈！
• 8.首先註冊好npm後 添加用戶

npm adduser 
Username: your name 
Password: your password 
Email: yourmail

// 查看一下登陸的是否是你本身
npm whoami

// 發佈
npm publish

// 這裏我遇到一個問題，發佈失敗了！
什麼緣由呢？

複製代碼

• 9.解決了上面的問題，發佈成功了！開心😊
• 10.記得寫一下README.md(好比像個人同樣，寫的越詳細越好！)
• 11.這個插件其實很簡單的，主要是要把開發到發佈都來了一遍，仍是有收穫的

最後總結

插件還有一點問題，放大縮小的操做也沒有加動畫，不兼容移動端，看起來比較生硬！第二版的時候給加上動畫兼容一下移動端！！！ （歡迎交流，提Issues! 求Star）今天在圖書館待了一天，餓死了，回家吃飯~