FE

Vue 学习笔记（十七）：自定义指令

自定义指令
Custom Directives

简介 Intro

除默认内置指令 (v-model 和 v-show)，Vue 也允许注册自定义指令。Vue2.0 代码复用和抽象的主要形式是组件。然而有时需要使用自定义指令对普通 DOM 元素进行底层操作。例如聚焦输入框，页面加载后输入框默认获得焦点：

渲染结果

下属全局、局部代码都可以达到此效果

注册全局自定义指令

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<div id="simplest-directive-example" class="demo">
  <input v-focus>
</div>
<script>
// 指令的定义：注册一个全局自定义指令 `v-focus`
Vue.directive('focus', {
// 当被绑定的元素插入到 DOM 中时……
  inserted: function (el) {
  // 聚焦元素
    el.focus()
  }
})
new Vue({
  el: '#simplest-directive-example'
})
</script>

注意：autofocus 在移动版 Safari 上不工作

注册局部自定义指令

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<div id="simplest-directive-example" class="demo">
  <!-- 下面定义好局部指令后可以在模板中任何元素上使用新的 v-focus property -->
  <input v-focus>
</div>
<script>

  new Vue({
    el: '#simplest-directive-example',
    // 注册局部指令
    directives: {
      focus: {
        // directive definition 指令的定义
        inserted: function (el) {
          el.focus()
        }
      }
    }
  })
</script>

钩子函数 Hook Functions

指令定义对象的钩子函数 (均为可选)：

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

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

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

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

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

钩子函数的参数 (el、binding、vnode 和 oldVnode)

钩子函数参数 Directive Hook Arguments

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

  • 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 钩子中可用。

除了 el 之外，其它参数都是只读的，切勿修改。如果需要在钩子之间共享数据，建议通过元素的 dataset 来进行

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<div id="hook-arguments-example" v-demo:foo.a.b="message" class="demo"></div>
<script>
  Vue.directive('demo', {
    bind: function (el, binding, vnode) {
      var s = JSON.stringify
      el.innerHTML =
        'name: ' + s(binding.name) + '<br>' +                // "demo"
        'value: ' + s(binding.value) + '<br>' +              // "hello!"
        'expression: ' + s(binding.expression) + '<br>' +    //"message"
        'argument: ' + s(binding.arg) + '<br>' +             // "foo"
        'modifiers: ' + s(binding.modifiers) + '<br>' +      // {"a":true,"b":true}
        'vnode keys: ' + Object.keys(vnode).join(', ')       //  tag, data, children, text, elm, ns, context, fnContext, fnOptions, fnScopeId, key, componentOptions, componentInstance, parent, raw, isStatic, isRootInsert, isComment, isCloned, isOnce, asyncFactory, asyncMeta, isAsyncPlaceholder
    }
  })
  new Vue({
    el: '#hook-arguments-example',
    data: {
      message: 'hello!'
    }
  })
</script>

渲染结果

动态指令参数 Dynamic Directive Arguments

指令的参数可以是动态的。例如，在 v-mydirective:[argument]="value" 中，argument 参数可以根据组件实例数据进行更新！

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

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

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

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

1
2
3
4
<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>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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'
    }
  }
})

渲染结果：

查看代码：https://codepen.io/team/Vue/pen/rgLLzb/

函数简写 Function Shorthand

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

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

对象字面量 Object Literals

如果指令需要多个值，可以传入一个 JavaScript 对象字面量。

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

指令函数能够接受所有合法的 JavaScript 表达式。