• 插件
    • 使用插件
    • 开发插件

    插件

    插件通常用来为 Vue 添加全局功能。插件的功能范围没有严格的限制——一般有下面几种:

    • 添加全局方法或者属性。如: vue-custom-element

    • 添加全局资源:指令/过滤器/过渡等。如 vue-touch

    • 通过全局混入来添加一些组件选项。如 vue-router

    • 添加 Vue 实例方法,通过把它们添加到 Vue.prototype 上实现。

    • 一个库,提供自己的 API,同时提供上面提到的一个或多个功能。如 vue-router

    使用插件

    通过全局方法 Vue.use() 使用插件。它需要在你调用 new Vue() 启动应用之前完成:

    1. // 调用 `MyPlugin.install(Vue)`
    2. Vue.use(MyPlugin)
    3. new Vue({
    4. // ...组件选项
    5. })

    也可以传入一个可选的选项对象:

    1. Vue.use(MyPlugin, { someOption: true })

    Vue.use 会自动阻止多次注册相同插件,届时即使多次调用也只会注册一次该插件。

    Vue.js 官方提供的一些插件 (例如 vue-router) 在检测到 Vue 是可访问的全局变量时会自动调用 Vue.use()。然而在像 CommonJS 这样的模块环境中,你应该始终显式地调用 Vue.use()

    1. // 用 Browserify 或 webpack 提供的 CommonJS 模块环境时
    2. var Vue = require('vue')
    3. var VueRouter = require('vue-router')
    4. // 不要忘了调用此方法
    5. Vue.use(VueRouter)

    awesome-vue 集合了大量由社区贡献的插件和库。

    开发插件

    Vue.js 的插件应该暴露一个 install 方法。这个方法的第一个参数是 Vue 构造器,第二个参数是一个可选的选项对象:

    1. MyPlugin.install = function (Vue, options) {
    2. // 1. 添加全局方法或属性
    3. Vue.myGlobalMethod = function () {
    4. // 逻辑...
    5. }
    6. // 2. 添加全局资源
    7. Vue.directive('my-directive', {
    8. bind (el, binding, vnode, oldVnode) {
    9. // 逻辑...
    10. }
    11. ...
    12. })
    13. // 3. 注入组件选项
    14. Vue.mixin({
    15. created: function () {
    16. // 逻辑...
    17. }
    18. ...
    19. })
    20. // 4. 添加实例方法
    21. Vue.prototype.$myMethod = function (methodOptions) {
    22. // 逻辑...
    23. }
    24. }