Vue 插件(使用 & … )

插件,通常会为 Vue 添加全局功能,它的范围没有限制,一般有下面几种:

  • 添加全局方法或者属性,如: vue-element
  • 添加全局资源:指令 / 过滤器 / 过渡等,如 vue-touch
  • 通过全局 mixin方法添加一些组件选项,如: vuex
  • 添加 Vue 实例方法,通过把它们添加到 Vue.prototype 上实现。
  • 一个库,提供自己的 API,同时,提供上面提到的一个或多个功能,如 vue-router

插件的使用

Vue.use会自动阻止注册相同插件多次,届时只会注册一次该插件。一些插件,如 vue-router,如果 Vue是全局变量,则自动调用 Vue.use()。不过,在模块环境中应当始终显式调用 Vue.use():

// 通过 Browserify 或 Webpack 使用 CommonJS 兼容模块
var Vue = require('vue')
var VueRouter = require('vue-router')
// 不要忘了调用此方法
Vue.use(VueRouter)

[ 相关资源 ] awesome-vue 集合了来自社区贡献的数以千计的插件和库。


开发插件

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 (options) {
    // 逻辑...
  }
}