从零开始的vue插件封装

vue插件的封装方法。

插件开发

详情：插件开发

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

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

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

插件调用

详情：使用插件

通过全局方法 Vue.use() 使用插件：

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

也可以传入一个选项对象：

Vue.use(MyPlugin, { someOption: true })

Vue.use 会自动阻止多次注册相同插件，届时只会注册一次该插件。

Vue.js 官方提供的一些插件 (例如 vue-router) 在检测到 Vue 是可访问的全局变量时会自动调用 Vue.use()。然而在例如 CommonJS 的模块环境中，你应该始终显式地调用 Vue.use()：

// 用 Browserify 或 webpack 提供的 CommonJS 模块环境时
var Vue = require('vue')
var VueRouter = require('vue-router')

// 不要忘了调用此方法
Vue.use(VueRouter)

DEMO -- 指令

插件JS文件：red.js，功能：使文字变红。

let red = {}
red.install = function (Vue) {
  Vue.directive('red', {
    bind(el, binding) {
        el.style.color = 'red';
    }
  })
}
export default red;

使用：

1. 在main.js中引入并注册插件

import red from 'red' //文件地址根据实际路径而定

Vue.use(vueScrollwatch)

2. 在组件中使用

<p v-red>hello world</p>

3. 效果

• before

  
  before

• after

  
  after

参考

• Vue官方文档-插件