Vue插件从封装到发布

插件的分类

• 添加全局的方法或者属性 好比：vue-element
• 添加全局的资源 好比：指令 v-bind
• 经过mixin方法添加的一些混合
• 添加Vue实例方法 Vue.prototype上面

插件的使用

经过全局方法 Vue.use() 使用插件。它须要在你调用 new Vue() 启动应用以前完成：

// 调用 `MyPlugin.install(Vue)`
Vue.use(MyPlugin)

new Vue({
  //... options
})``` 也能够传入一个选项对象： ``` javascript
Vue.use(MyPlugin, { someOption: true })
复制代码

插件开发

Vue.js 的插件有一个公开方法 install。这个方法的第一个参数是 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) {
    // 逻辑...
  }

  //5.直接注册组件
  Vue.use();
}
复制代码

其实不管采用什么方式，最终的目的则是在项目中可使用，借助install 的Vue参数具体本身进行封装

从零开始的组件封装

需求： 封装一个微博表情的enoji插件

准备

node环境 vue环境 vue-cli脚手架 等等

建立工程

使用vue init 建立简单脚手架，简单修改就能够适合插件开发

vue init webpack-simple weibo-emoji

cd weibo-emoji

npm install

开发目录以下:

插件实现

项目具体逻辑实现能够去这里查看源码 咱们正常webpack的entry入口通常会设置为main.js 作一些依赖引入和视图挂载等的操做, 当咱们编写插件的时候理所固然的就会省去挂载这一步操做了。 这里咱们能够将index.js做为咱们的入口文件，暴露出去的则是一个有这install方法的插件对象 代码以下:

import weiboEmoji from './compontent/weibo_emoji'
const emoji = {
    install(Vue, options) {
        Vue.component(weiboEmoji.name, weiboEmoji);
    }
}
if (typeof window !== 'undefined' && window.Vue) {
    window.Vue.use(emoji);
}
export default emoji 
复制代码

发布

1. 发布以前检查一下webconfig配置：

entry: './src/index.js',// 入口
    output: {
        path: path.resolve(__dirname, './dist'),//打包输出目录
        publicPath: '/dist/',// 静态资源前缀
        filename: 'vue-weibo-emoji.js', //打包生成文件的名字
        library: 'WeiboEmoji', //umd 打包的时候模块的名字
        libraryTarget: 'umd',//打包方式 amd
        umdNamedDefine: true //打包未定义的时候使用默认名字
    },
复制代码

2. 检查发布配置：

"name": "weibo-emoji", // 打包的项目名，也就是modemodules里面的文件夹名字 也就是import from以后跟的名字
    "main": "dist/vue-weibo-emoji.js", // 是访问到nodemodules依赖，实际引入的文件 至关于入口
    "repository": {// 仓库 貌似仓库内容也不影响发布内容，填对就行
        "type": "git",
        "url": "https://github.com/icebluesky2666/weibo-emoji"
    },
    "description": "A Weibo emoji plugn",// 描述
    "version": "1.0.2",// 版本
    "author": "jhqin",// 做者
    "license": "MIT",// license 类型
复制代码

对于屡次发布，必须每次的版本号都不一样

3. 最后：

npm build
  npm login
  npm publish
复制代码

使用

npm install weibo-emoji
import WeiboEmoji from 'weibo-emoji'
Vue.use(WeiboEmoji)
复制代码

<weibo-emoji class="emoji" :weiboIcon="weiboIcon" @changeEmoji="selsctEmoji = arguments[0].phrase" ref="emoji"> </weibo-emoji> 复制代码

效果：

源码

Weibo-Emoji

经验所致，若有错误，欢迎指正！