Vue框架——自定义指令

为什么要自定义指令

Vue的内置指令不满足我们的需求

自定义指令的语法规则

使用Vue.directiveAPI去自定义指令

• 用法——以获取焦点举例

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

  第一个参数为指令名称，第二个参数为一个对象，对象里使用钩子函数去定义功能

钩子函数

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

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

更多内容 -> 官网教程

钩子函数的参数

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

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

自定义指令的使用

• 获取焦点指令

  <div id='app'>
      <input type="text" v-focus>
  </div>
  

  Vue.directive('focus', {
      inserted: function(el) {
          el.focus();
      }
  })
  var vm = new Vue({
      el: '#app',
      data: {
  
      }
  });
  

带参数的自定义指令的使用

• 初始化标签背景色

  <div id='app'>
      <input type="button" value="按钮" v-color="obj">
  </div>
  

  Vue.directive('color', {
      bind: function(el, binding) {
          el.style.backgroundColor = binding.value.color;
      }
  });
  
  var vm = new Vue({
      el: '#app',
      data: {
          obj: {
              color: 'skyblue'
          }
      }
  });
  

  obj为data属性里的元素

自定义局部指令的使用

var vm = new Vue({
    el: '#app',
    data: {
        obj: {
            color: 'skyblue'
        }
    },
    directives: {
        focus: {
            inserted: function(el) {
                el.focus();
            },
        },
        color: {
            bind: function(el, binding) {
                el.style.backgroundColor = binding.value.color;
            }
        }

    }
});

放到Vue的实例对象里，属性名为directives，自定义多个指令用逗号分隔开