FE

Vue 学习笔记（十九）：插件 & 过滤器

插件 & 过滤器
Plugins & Filters

插件

插件可以添加全局功能，常见的插件：

  1. 添加全局方法或者 property。如：vue-custom-element
  2. 添加全局资源：指令/过滤器/过渡等。如 vue-touch
  3. 通过全局混入来添加一些组件选项。如 vue-router
  4. 添加 Vue 实例方法，通过把它们添加到 Vue.prototype 上实现。
  5. 一个库，提供自己的 API，同时提供上面提到的一个或多个功能。如 vue-router

使用插件

Vue.use()，Vue.use 会自动阻止重复注册，即使多次调用也只会注册一次该插件。

1
2
3
4
5
6
// 调用 `MyPlugin.install(Vue)`
Vue.use(MyPlugin)

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

传入可选的选项对象：

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

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

1
2
3
4
5
6
// 用 Browserify 或 webpack 提供的 CommonJS 模块环境时
var Vue = require('vue')
var VueRouter = require('vue-router')

// 不要忘了调用此方法
Vue.use(VueRouter)

开源插件和库：awesome-vue

开发插件

Vue.js 的插件应该暴露一个 install 方法，参数一是 Vue 构造器，参数二是一个可选的选项对象：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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) {
    // 逻辑...
  }
}

过滤器

自定义过滤器，可用于一些常见的文本格式化。
过滤器可以用在两个地方：双花括号插值和 v-bind 表达式。

过滤器使用：

  • 添加在 JavaScript 表达式的尾部，由“管道”符号指示

    1
    2
    3
    4
    5
    <!-- 在双花括号中 -->
    {{ message | capitalize }}

    <!-- 在 `v-bind` 中 -->
    <div v-bind:id="rawId | formatId"></div>

  • 可以串联

    1
    {{ message | filterA | filterB }}

  • 可以接受参数（过滤器是 JavaScript 函数）

    1
    {{ message | filterA('arg1', arg2) }}

  • 全局过滤器和局部过滤器重名时，会采用局部过滤器。

本地过滤器

在组件选项中定义：

1
2
3
4
5
6
7
filters: {
  capitalize: function (value) {
    if (!value) return ''
    value = value.toString()
    return value.charAt(0).toUpperCase() + value.slice(1)
  }
}

全局过滤器

在创建 Vue 实例之前定义：

1
2
3
4
5
6
7
8
9
Vue.filter('capitalize', function (value) {
  if (!value) return ''
  value = value.toString()
  return value.charAt(0).toUpperCase() + value.slice(1)
})

new Vue({
  // ...
})

完整示例

capitalize 过滤器

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<script src="https://unpkg.com/vue"></script>
<div id="example-1" class="demo">
  <input type="text" v-model="message">
  <p>{{ message | capitalize }}</p>
</div>
<script>
  new Vue({
    el: '#example-1',
    data: function () {
      return {
        message: 'john'
      }
    },
    filters: {
      capitalize: function (value) {
        if (!value) return ''
        value = value.toString()
        return value.charAt(0).toUpperCase() + value.slice(1)
      }
    }
  })
</script>

渲染结果：

{{ message | capitalize }}