開發插件
插件通常會為Vue添加全局功能。插件的范圍沒有限制——一般有下面幾種:
-
添加全局方法或者屬性,如: vue-element
-
添加全局資源:指令/過濾器/過渡等,如 vue-touch
-
通過全局 mixin方法添加一些組件選項,如: vuex
-
添加 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 (options) { // 邏輯... } }
使用插件
通過全局方法 Vue.use() 使用插件:
// 調用 `MyPlugin.install(Vue)` Vue.use(MyPlugin)
也可以傳入一個選項對象:
Vue.use(MyPlugin, { someOption: true })
Vue.use
會自動阻止注冊相同插件多次,屆時只會注冊一次該插件。
一些插件,如 vue-router
如果 Vue
是全局變量則自動調用 Vue.use()
。不過在模塊環境中應當始終顯式調用 Vue.use()
:
// 通過 Browserify 或 Webpack 使用 CommonJS 兼容模塊 var Vue = require('vue') var VueRouter = require('vue-router') // 不要忘了調用此方法 Vue.use(VueRouter)
awesome-vue 集合了來自社區貢獻的數以千計的插件和庫。