自定义指令

Vue.directive()注册定义指令

Vue.directive()函数注册全局自定义指令

// 注册一个全局自定义指令 `v-focus`
Vue.directive('focus', {
  // 当被绑定的元素插入到 DOM 中时……
  inserted: function (el) {
    // 聚焦元素
    el.focus()
  }
})

如果想注册局部指令，使用directives选项, 然后就可以在模板中任何元素上使用新的 v-focus 属性

directives: {
  focus: {
    // 指令的定义
    inserted: function (el) {
      el.focus()
    }
  }
}

自定义指令的钩子函数

上面用到了inserted钩子函数，当被绑定的元素插入到DOM里时执行

• bind 只调用一次，指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。
• inserted 被绑定元素插入父节点时调用 (仅保证父节点存在，但不一定已被插入文档中)。
• update 所在组件的 VNode 更新时调用，但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变，也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)。
• componentUpdated 指令所在组件的 VNode 及其子 VNode 全部更新后调用。
• unbind 只调用一次，指令与元素解绑时调用。

钩子函数的参数

• 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 来进行。

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(', ')}
    `
  }
})
var app = new Vue({
  el: '#app',
  data: {
    message: 'hello!'
  }
})

动态指令参数

<div id="dynamicexample">
  <h3>Scroll down inside this section ↓</h3>
  <p v-pin:[direction]="200">I am pinned onto the page at 200px to the left.</p>
</div>

<script>
Vue.directive('pin', {
  bind: function (el, binding, vnode) {
    el.style.position = 'fixed'
    var s = (binding.arg == 'left' ? 'left' : 'top')
    el.style[s] = binding.value + 'px'
  }
})

new Vue({
  el: '#dynamicexample',
  data: function () {
    return {
      direction: 'left'
    }
  }
})

</script>

函数简写

Vue.directive第二个参数直接为函数，bind和update时同时触发相同行为

Vue.directive('color-swatch', function (el, binding) {
  el.style.backgroundColor = binding.value
})

指令参数值可以是JS表达式

<div v-demo="{ color: 'white', text: 'hello!' }"></div>
<script>
Vue.directive('demo', function (el, binding) {
  console.log(binding.value.color) // => "white"
  console.log(binding.value.text)  // => "hello!"
})
</script>