官方文档
插件通常用来为 Vue 添加全局功能。插件的功能范围没有严格的限制——一般有下面几种:
-
添加全局方法或者属性。如:
vue-custom-element
-
添加全局资源:指令/过滤器/过渡等。如
vue-touch
-
通过全局混入来添加一些组件选项。如
vue-router
-
添加 Vue 实例方法,通过把它们添加到
Vue.prototype
上实现。 -
一个库,提供自己的 API,同时提供上面提到的一个或多个功能。如 vue-router
使用插件
通过全局方法Vue.use()使用插件。 调用new Vue() 启动之前。
Vue.use(MyPlugin) //拦截器,类似
new Vue({
})
可传入一个选项对象,用于全局配置
Vue.use(MyPlugin, {
someOption: true
})
开发插件
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(data){
...
}
}
官方解释太笼统且不清晰,以下个人实战理解
步骤
- 新建文件夹plugin,里面存放插件文件夹,例如:toast: index.js toast.vue
- 编写index.js , 主要暴露
install
方法,以及逻辑处理 - main.js 引入,使用
Vue.use(MyPlugin)
拦截使用
- 编写index.js , toast.vue相当于普通的组件,此处不展示
import Toast from './toast'
export default {
/**
* @Vue Vue vue实例
* @config options配置,对应Vue.use(xx, options)
* */
install(Vue, config){
/**
*添加的方法
*@data 传入的参数
* */
Vue.prototype.$toast = function (data) {
//必须使用extend,将配置转化为dom
let ToastConstructor = Vue.extend(Toast) ;
let dom = document.createElement('div');
//进行实例化,且挂载视图。
let vm = new ToastConstructor().$mount(dom) ;
//现在可以调用 toast.vue 的属性或方法,在这就可以操作 赋值 等操作
vm.message = msg ;
//将元素添加 body的后面。 vm.$el 为真实dom
document.body.appendChild(vm.$el) ;
// 如果想不添加到body元素后,可以将 需要添加的dom 传递进来。
}
}
}
利用插件注册全局组件
<!--globalComponents.js-->
//引入
import BaseComponentA from '@/components/BaseComponentA'
import BaseComponentB from '@/components/BaseComponentA'
const plugins = {
//注册
install(Vue) {
Vue.component('BaseComponentA',BaseComponentA); //第一个参数:组件名称,第二个参数:要注册的组件
Vue.component('BaseComponentB',BaseComponentB);
}
}
export default plugins;
- main.js
import toast from '../..'
Vue.use(toast, {
someOptions
})
- 使用
//对应 install 里,Vue.prototype.$toast = function(){} ....
<div @click="$toast"></div>