Vue 插件的概述和开发

63 阅读2分钟

Vue 插件

概述

官网描述

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

  1. 添加全局方法或者 property。如:vue-custom-element

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

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

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

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

使用

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

// 调用 `MyPlugin.install(Vue)`
Vue.use(MyPlugin)

new Vue({
  // ...组件选项
})

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

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

例如我们常用的 element-ui。

import ElementUI from 'element-ui'
import 'element-ui/lib/theme-chalk/index.css'Vue.use(ElementUI)​

new 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) {
    // 逻辑...
  }
}

例如以下是一个自定义插件,该插件可以使每一个使用该插件的 input 标签自动获取焦点,即封装了一个全局指令。

export default {
  install (Vue) {
    Vue.directive('demo', {
      inserted (el, bind) {
        el.focus()
        // el 代表当前 dom ,bind 表示传递的参数
        console.log(el, bind)
      }
    })
  }
}

在 main.js 中注册插件后即可使用。

import Demo from '@/plugins/directives'
Vue.use(Demo)

组件中使用封装好的自定义指令

<template>
  <div class="about">
    <h1>This is an about page</h1>
    <input type="text" v-demo='count'>
  </div>
</template>

例如在 element-ui 中我们可以看到,作者定义了一个 install 方法并导出。install 方法中将所有的组件都注册为全局组件,且在 vue 原型上挂载了一些方法如 messagemessage、aleart 等。由此我们也可以理解,使用 element-ui 时为什么可以全局使用组件以及原型上的方法使用。

总结

Vue 的插件主要是用于增强功能,可以把它看作是一个工具库,可以提供很多强大的功能,比如一些强大的自定义指令,一些强大的工具方法,过滤器等,我们可以编写或者直接引入别人写的插件,就能获得强大的功能。

Vue 插件的本质是一个包含 install 方法的对象,install 方法的第一个参数是 Vue 构造函数对象,第二个及以后的参数是插件使用者传递的数据。