Vue基础-自定义指令

一、本质

在当前项目中，有一类非常常用的与DOM相关的功能，我们建议使用Vue.directive()封装“自定义指令”。

二、语法

使用 Vue.directive() 或者 directives 选项来封装。

三、全局指令

Vue.directive(),一次定义随处可用

四、局部指令

directives只能在当前组件中使用，不能跨组件使用

五、钩子函数

一个指令定义对象可以提供如下几个钩子函数 (均为可选)：

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

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

3.update：所在组件的 VNode 更新时调用，但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变，也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)。

六、钩子函数参数

指令钩子函数会被传入以下参数：

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 编译生成的虚拟节点。移步 VNode API 来了解更多详情。

oldVnode：上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。

Vue.directive('demo', {

  bind: function(el, binding, vnode){

    var s = JSON.stringify

    el.innerHTML =

      'name: '      + s(binding.name) + '
' +

      'value: '      + s(binding.value) + '
' +

      'expression: ' + s(binding.expression) + '
' +

      'argument: '  + s(binding.arg) + '
' +

      'modifiers: '  + s(binding.modifiers) + '
' +

      'vnode keys: ' + Object.keys(vnode).join(', ')

  }

})new Vue({

  el: '#hook-arguments-example',

  data: {

    message: 'hello!'  }

})

七、函数简写

在很多时候，你可能想在 bind 和 update 时触发相同行为，而不关心其它的钩子。比如这样写：

Vue.directive('color-swatch', function(el, binding){

  el.style.backgroundColor = binding.value

})

八、对象字面量

如果指令需要多个值，可以传入一个 JavaScript 对象字面量。记住，指令函数能够接受所有合法的 JavaScript 表达式。

Vue.directive('demo', function(el, binding){

  console.log(binding.value.color) // => "white"  console.log(binding.value.text)  // => "hello!"

})