钩子函数参数

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

  • el：指令所绑定的元素，可以用来直接操作 DOM 。
  • binding：一个对象，包含以下属性：
    • 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 钩子中可用。 除了 el 之外，其它参数都应该是只读的，切勿进行修改。如果需要在钩子之间共享数据，建议通过元素的 dataset 来进行。

这是一个使用了这些属性的自定义钩子样例：

  1. <div id="hook-arguments-example" v-demo:foo.a.b="message"></div>
  1. Vue.directive('demo', {
  2.   bind: function (el, binding, vnode) {
  3.     var s = JSON.stringify
  4.     el.innerHTML =
  5.       'name: '       + s(binding.name) + '<br>' +
  6.       'value: '      + s(binding.value) + '<br>' +
  7.       'expression: ' + s(binding.expression) + '<br>' +
  8.       'argument: '   + s(binding.arg) + '<br>' +
  9.       'modifiers: '  + s(binding.modifiers) + '<br>' +
  10.       'vnode keys: ' + Object.keys(vnode).join(', ')
  11.   }
  12. })
  14. new Vue({
  15.   el: '#hook-arguments-example',
  16.   data: {
  17.     message: 'hello!'
  18.   }
  19. })

钩子函数参数 - 图1

动态指令参数

指令的参数可以是动态的。例如，在 v-mydirective:[argument]="value" 中，argument 参数可以根据组件实例数据进行更新！这使得自定义指令可以在应用中被灵活使用。

例如你想要创建一个自定义指令，用来通过固定布局将元素固定在页面上。我们可以像这样创建一个通过指令值来更新竖直位置像素值的自定义指令：

  1. <div id="baseexample">
  2.   <p>Scroll down the page</p>
  3.   <p v-pin="200">Stick me 200px from the top of the page</p>
  4. </div>
  1. Vue.directive('pin', {
  2.   bind: function (el, binding, vnode) {
  3.     el.style.position = 'fixed'
  4.     el.style.top = binding.value + 'px'
  5.   }
  6. })
  8. new Vue({
  9.   el: '#baseexample'
  10. })

这会把该元素固定在距离页面顶部 200 像素的位置。但如果场景是我们需要把元素固定在左侧而不是顶部又该怎么办呢？这时使用动态参数就可以非常方便地根据每个组件实例来进行更新。

  1. <div id="dynamicexample">
  2.   <h3>Scroll down inside this section ↓</h3>
  3.   <p v-pin:[direction]="200">I am pinned onto the page at 200px to the left.</p>
  4. </div>
  1. Vue.directive('pin', {
  2.   bind: function (el, binding, vnode) {
  3.     el.style.position = 'fixed'
  4.     var s = (binding.arg == 'left' ? 'left' : 'top')
  5.     el.style[s] = binding.value + 'px'
  6.   }
  7. })
  9. new Vue({
  10.   el: '#dynamicexample',
  11.   data: function () {
  12.     return {
  13.       direction: 'left'
  14.     }
  15.   }
  16. })

结果：

钩子函数参数 - 图2

这样这个自定义指令现在的灵活性就足以支持一些不同的用例了。