vue2.x学习笔记（二十二）

接着前面的内容：https://www.cnblogs.com/yanggb/p/12633051.html。

自定义指令

简介

除了核心功能默认内置的指令（【v-mode】和【v-show】等），vue也允许注册自定义指令。注意，在vue2.x中，代码复用和抽象的主要形式是组件。然而，在有的情况下，我们仍然会需要对普通的dom元素进行底层直接操作，这时候就会用到自定义指令。

举一个聚焦输入框的例子：当页面加载的时候，需要该输入框获得焦点（注意，autofocus属性在移动版的safari上不工作）。事实上，只要你在打开这个页面后还没有点击过任何内容，这个输入框就应当还是处于聚焦的状态。现在让我们用指令来实现这个功能：

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

如果想要注册局部指令，组件中也可以接收一个【directives】的选项：

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

然后你就可以在模板中的任何元素上使用新的v-focus指令属性，如下：

<input v-focus>

可以注意到，指令的使用方式是通过【v-】前缀加上定义好的指令名。

钩子函数

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

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

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

3.update：所在组件的vnode更新时调用，但是可能发生在其子vnode更新之前。

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

5.unbind：只调用一次，指令与元素解绑的时候调用。

钩子函数参数

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

1.el：指令所绑定的元素，可以用来直接操作dom。

2.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}。

3.vnode：vue编译生成的虚拟节点。

4.oldVnode：上一个虚拟节点，仅在【update】和【componentUpdated】两个钩子函数中可用。

提前说明以下，除了【el】之外，其他的参数都应该是只读的，切勿进行修改。如果需要在钩子之间共享数据的话，建议通过元素的dataset来进行。

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

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

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!'
  }
})

动态指令参数

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

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

<div id="baseexample">
  <p>Scroll down the page</p>
  <p v-pin="200">Stick me 200px from the top of the page</p>
</div>

Vue.directive('pin', {
  bind: function (el, binding, vnode) {
    el.style.position = 'fixed'
    el.style.top = binding.value + 'px'
  }
})

new Vue({
  el: '#baseexample'
})

这样就会把该元素固定在距离页面顶部200像素的位置。如果场景是我们需要把元素固定在左侧而不是顶部的话，我们只需要使用动态参数就能非常方便地根据每个组件实例来进行更新。

<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>

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'
    }
  }
})

当然这里的参数值也可以固定，而指令的定义里只需要提供好不传参数的情况下（默认）的处理逻辑即可。

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

而动态参数值也同样可以使得自定义指令的灵活性足以支持一些不同的用例。

函数的简写

在很多的时候，你可能会想在bind和update的时候触发相同的行为，而不关心其他的钩子，则可以这样写：

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

简写的语法省略了第二参数的对象（内含多个钩子函数定义），而直接用函数（bind和update的钩子函数）作为第二参数。

对象字面量

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

Vue.directive('demo', function (el, binding) {
  console.log(binding.value.color) // "white"
  console.log(binding.value.text)  // "hello!"
})

只要你在指令定义的钩子函数中写好对参数的相应处理逻辑即可，十分灵活。

"我还是很喜欢你，像仲夏流萤四起，弦月沉西。"