开发插件
插件通常会为 Vue 添加全局功能。插件的范围没有限制——通常是下面几种:
-
添加全局方法或属性,如 vue-element
-
添加全局资源:指令/过滤器/过渡等,如 vue-touch
-
添加 Vue 实例方法,通过把它们添加到 Vue.prototype 上实现。
- 一个库,提供自己的 API,同时提供上面提到的一个或多个功能,如 vue-router
Vue.js 的插件应当有一个公开方法 install
。这个方法的第一个参数是 Vue
构造器,第二个参数是一个可选的选项对象:
MyPlugin.install = function (Vue, options) {
// 1. 添加全局方法或属性
Vue.myGlobalMethod = ...
// 2. 添加全局资源
Vue.directive('my-directive', {})
// 3. 添加实例方法
Vue.prototype.$myMethod = ...
}
使用插件
通过 Vue.use()
全局方法使用插件:
// 调用 `MyPlugin.install(Vue)`
Vue.use(MyPlugin)
也可以传入一个选项对象:
Vue.use(MyPlugin, { someOption: true })
一些插件,如 vue-router
,如果 Vue
是全局变量则自动调用 Vue.use()
。不过在模块环境中应当始终显式调用 Vue.use()
:
// 通过 Browserify 或 Webpack 使用 CommonJS 兼容模块
var Vue = require('vue')
var VueRouter = require('vue-router')
// 不要忘了调用此方法
Vue.use(VueRouter)