vue扩展的终极方案
自定义指令、自定义组件、自定义过滤器、自定义混入等等,其实不适合去分发。这些东西放到github上都不行。
最佳的方式应该是插件(最安全、最有效的方式:如果重复引入可以有效规避,也可以有效管理和更新)
vuex、vue-router 都是典型的插件
插件本质:自己理解就是将自定义指令、自定义组件、自定义过滤器、自定义混入等等,包装后install到vue上。
一、种类
插件通常用来为 Vue 添加全局功能。插件的功能范围没有严格的限制——一般有下面几种:
-
添加全局方法或者属性。如: vue-custom-element
-
添加全局资源:指令/过滤器/过渡等。如 vue-touch
-
通过全局混入来添加一些组件选项。如 vue-router
-
添加 Vue 实例方法,通过把它们添加到 Vue.prototype 上实现。
-
一个库,提供自己的 API,同时提供上面提到的一个或多个功能。如 vue-router
二、插件必备
Vue.js 的插件应该暴露一个 install 方法。
第一个参数是 Vue 构造器,
- Vue.extend (常用)
- Vue.nextTick
- Vue.set
- Vue.delete
- Vue.directive (常用)
- Vue.filter (常用)
- Vue.component (常用)
- Vue.mixin (常用)
- Vue.compile
- Vue.observable
- Vue.version
都能使用做插件内容:
第二个参数是一个可选的选项对象:
MyPlugin.install = function (Vue, options) {
// 1. 添加全局方法或 property
Vue.myGlobalMethod = function () {
// 逻辑...
}
// 1.添加组件-常用
Vue.component('组件名称',{
})
// 1.添加通用过滤器-常用
Vue.filter('capitalize', function (value) {
if (!value) return ''
value = value.toString()
return value.charAt(0).toUpperCase() + value.slice(1)
})
// 2. 添加全局资源
Vue.directive('my-directive', {
bind (el, binding, vnode, oldVnode) {
// 逻辑...
}
...
})
// 3. 注入组件选项
Vue.mixin({
created: function () {
// 逻辑...
}
...
})
// 4. 添加实例方法 (最常用)
Vue.prototype.$myMethod = function (methodOptions) {
// 逻辑...
}
}
三、插件使用
1、通过全局方法 Vue.use() 使用插件。
它需要在你调用 new Vue() 启动应用之前完成:
// 调用 `MyPlugin.install(Vue)`
Vue.use(MyPlugin)
new Vue({
// ...组件选项
})
2、也可以传入一个可选的选项对象。
Vue.use(MyPlugin, { someOption: true })
3、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)
4、awesome-vue 集合了大量由社区贡献的插件和库。
四、完整定义一个插件
// 定义插件
const myPlugin = {
install(Vue,options){
Vue.component('xxx',{
...
})
}
}
// 自动使用
if(typeOf window !== 'undefined' && window.Vue){
Vue.use(myPlugin);
}