在vue中实现一个自定义指令

125 阅读2分钟

什么是指令

在vue中,我们看到的 v-开头的行内属性,都是指令,不同的指令可以完成或实现不同的功能。除了核心功能默认内置的指令(v-modelv-show),Vue也允许注册自定义指令。

具体实现

自定义指令有全局注册和局部注册。 全局注册主要是通过Vue.directive方法进行注册。

Vue.directive第一个参数是指令的名字(不需要写上v-前缀),第二个参数可以是对象数据,也可以是一个指令函数。

// 注册一个全局自定义指令 `v-focus` 
Vue.directive('focus', { 
// 当被绑定的元素插入到 DOM 中时…… 
inserted: function (el) { 
// 聚焦元素
el.focus()
// 页面加载完成之后自动让输入框获取到焦点的小功能 
  } 
})

局部注册通过在组件options选项中设置directive属性。

directives: {
    focus: {
    // 指令的定义 
    inserted: function (el) {
    el.focus() 
    // 页面加载完成之后自动让输入框获取到焦点的小功能
    } 
   }
  }

自定义指令也像组件那样存在钩子函数:

  • bind:只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置
  • inserted:被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)
  • update:所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新
  • componentUpdated:指令所在组件的 VNode 及其子 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 }
  • vnodeVue 编译生成的虚拟节点

  • oldVnode:上一个虚拟节点,仅在 update 和 componentUpdated 钩子中可用

例如,设置一个v-debounce自定义指令实现输入框防抖

// 1.设置v-debounce自定义指令 
Vue.directive('debounce', { 
    bind: (el, binding) => {
    let debounceTime = binding.value; // 防抖时间
    if (!debounceTime) { // 用户若不设置防抖时间,则默认2s 
    debounceTime = 2000; 
    } 
    let cbFun;
    el.addEventListener('click', event => {
    if (!cbFun) { // 第一次执行
    cbFun = setTimeout(() => {
    cbFun = null; }, debounceTime);
    } else {
    event && event.stopImmediatePropagation(); 
    }
   }, true);
  }, 
 });
// 2.为button标签设置v-debounce自定义指令
<button @click="sayHello" v-debounce>提交</button>