Vue 自定义指令

在之前 Vue 学习中有篇笔记记录了项目中常用的内置指令，此外 Vue 也允许注册自定义指令。

全局自定义指令

在全局作用域下自定义指令，同时这个指令也能够用于全局，即任何组件都能够使用这个全局指令。如要声明多个全局指令，多次调用 Vue.directive。

// 声明全局指令，注意在全局作用域下
// 注册
Vue.directive('my-directive', {
  bind: function () {},
  inserted: function () {},
  update: function () {},
  componentUpdated: function () {},
  unbind: function () {}
})

// 注册 (指令函数)
Vue.directive('my-directive-fun', function () {
  // 这里将会被 `bind` 和 `update` 调用
})

// getter，返回已注册的指令
var myDirective = Vue.directive('my-directive')

// 使用全局指令，在任何组件中都可以使用 v-my-directive
<myComponent v-my-directive ></myComponent>

局部自定义指令

在某个组件 Vue 组件下进行声明，只能在该 Vue 组件的实例中使用。

// 声明局部指令
<script>
    export default {
        ...
        directives: {
        	"my-directive": {
                bind: function () {},
                inserted: function () {},
                update: function () {},
                componentUpdated: function () {},
                unbind: function () {}
            }
    	}
    }
</script>

// 只能在该组件中使用局部指令
<template>
	<div v-my-directive ></div>
</template>

注意区分：全局是 Vue.directive，局部是 directives

钩子函数

摘抄自文档

• bind：只调用一次，指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。

• inserted：被绑定元素插入父节点时调用 (仅保证父节点存在，但不一定已被插入文档中)。

• update：所在组件的 VNode 更新时调用，但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变，也可能没有。可以通过比较更新前后的值来忽略不必要的模板更新。

• componentUpdated：指令所在组件的 VNode 及其子 VNode 全部更新后调用。

• unbind：只调用一次，指令与元素解绑时调用。

钩子函数参数

• el：指令所绑定的元素，可以用来直接操作 DOM。
• binding：一个对象，包含以下 property：
  • name：指令名，不包括 v- 前缀。
  • value：指令的绑定值，例如：v-my-directive=”1 + 1” 中，绑定值为 2。
  • oldValue：指令绑定的前一个值，仅在 update 和 componentUpdated 钩子中可用。无论值是否改变都可用。
  • expression：字符串形式的指令表达式。例如 v-my-directive=”1 + 1” 中，表达式为 “1 + 1”。
  • arg：传给指令的参数，可选。例如 v-my-directive:foo 中，参数为 “foo”。
  • modifiers：一个包含修饰符的对象。例如：v-my-directive.foo.bar 中，修饰符对象为 { foo: true, bar: true }。
• vnode：Vue 编译生成的虚拟节点。
• oldVnode：上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。

Vue.directive('demo', {
  bind: function (el, binding, vnode) {
    var s = JSON.stringify
    el.innerHTML =
      'name: '       + s(binding.name) + '<br>' +
      'value: '      + s(binding.value) + '<br>' +
      'expression: ' + s(binding.expression) + '<br>' +
      'argument: '   + s(binding.arg) + '<br>' +
      'modifiers: '  + s(binding.modifiers) + '<br>' +
      'vnode keys: ' + Object.keys(vnode).join(', ')
  }
})

new Vue({
  el: '#hook-arguments-example',
  data: {
    message: 'hello!'
  }
})

<div id="hook-arguments-example" v-demo:foo.a.b="message"></div>

指令的作用以及使用场景

• 用于 DOM 操作

Vue 组件/实例的主要用于数据绑定、事件监听、DOM 更新，而指令的作用主要是完成原生DOM操作。

• 减少重复

当我们需要重复多次相同的原生 DOM 操作，或者是进行一些比较复杂的原生 DOM 操作时，可以借助指令来完成。