插件通常用来为 Vue 添加全局功能。插件的功能范围没有严格的限制——一般有下面几种:
- 添加全局方法或者 property。如:vue-custom-element
- 添加全局资源:指令/过滤器/过渡等。如vue-touch
- 通过全局混入来添加一些组件选项。如vue-router
- 添加 Vue 实例方法,通过把它们添加到Vue.prototype上实现。
- 一个库,提供自己的 API,同时提供上面提到的一个或多个功能。如vue-router
使用插件
通过全局方法Vue.use()使用插件。它需要在你调用new Vue()启动应用之前完成:``jsx // 调用
MyPlugin.install(Vue)` Vue.use(MyPlugin)
//也可以传入一个可选的选项对象: Vue.use(MyPlugin, { someOption: true })
new Vue({ // …组件选项 })
Vue.use会自动阻止多次注册相同插件,届时即使多次调用也只会注册一次该插件。
Vue.js 官方提供的一些插件 (例如vue-router) 在检测到Vue是可访问的全局变量时会自动调用Vue.use()。然而在像 CommonJS 这样的模块环境中,你应该始终显式地调用Vue.use():
```jsx
// 用 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. 添加全局方法或 property
Vue.myGlobalMethod = function () {
// 逻辑...
}
// 2. 添加全局资源
Vue.directive('my-directive', {
bind (el, binding, vnode, oldVnode) {
// 逻辑...
}
...
})
// 3. 注入组件选项
Vue.mixin({
created: function () {
// 逻辑...
}
...
})
// 4. 添加实例方法
Vue.prototype.$myMethod = function (methodOptions) {
// 逻辑...
}
}