vue3.2 setup 之局部自定义指令

Posted 2023-04-27

参考技术A

vue2 全局自定义指令

在vue2中，全局自定义指令通过 directive 挂载到 Vue 对象上，使用Vue.directive(\'name\',opt)。

inserted 是钩子函数，在绑定元素插入父节点时执行。

vue3 全局自定义指令

在 vue3 中，vue 实例通过createApp 创建，所以全局自定义指令的挂载方式也改变了， directive 被挂载到 app上。

在组件内部，使用 directives 引入的叫做局部自定义指令。

其实，在vue3.2中，自定义指令变得更加的简单，直接上例子。

看到了吗，重点是： 注册一个局部的自定义指令，需要以小写v开头 。

这里做最简单示例，实战中举一反三灵活应用到项目中才是真理。

看完，你的项目需求可能会更复杂，所以系统掌握vue3中指令基础知识才是重点。

一个指令定义对象可以提供如下几个钩子函数（都是可选的，根据需要引入）

eg：测试指令内生命周期函数执行

通过点击按钮，我们发现创建 input 元素的时候，会触发 created、beforeMount 和 mounted 三个钩子函数。

隐藏 input 元素的时候，会触发 beforeUnmount 和 unmounted 。

然而我们添加的 beforeUpdate 和 updated 函数并没有执行。

此时我们把 input 元素上的 v-if 修改成 v-show 就会执行上述两个方法了，具体的执行情况自行验证下。

从 vue2 升级到 vue3 ，自定义指令的生命周期钩子函数发生了改变，具体变化如下：

钩子函数被赋予了以下参数：

binding 包含的属性具体的分别为：

自定义指令的也可以带参数，参数可以是动态的，参数可以根据组件实例数据进行实时更新。

eg：自定义指令动态参数

什么时候需要自定义指令？

参考资料： 传送门

Vue 自定义指令

自定义指令注册分为全局注册和局部注册，比如注册一个 v-focus 指令，用于在<input>，<textarea>元素初始化时自动获得焦点。

1、全局注册方法：

main.js ：

import Vue from ‘vue‘
import App from ‘./App‘

Vue.config.productionTip = false

// 全局注册, 适用于所有实例
Vue.directive(‘focus‘, {
  inserted: function(el) {
    // 聚焦元素
    el.focus();
  }
});

/* eslint-disable no-new */
new Vue({
  el: ‘#app‘,
  render: h => h(App)
  
})

App.vue ：

<template>
  <div id="app">
    <!-- v-focus 为自定义指令 -->
     <input type="text" v-focus>
  </div>
</template>
<script>
// 导入组件
import Learn from "./components/Learn"

export default {
  name: "App",
  components: {
    Learn   // 注入
  },
  data() {
    return {
      
    }
  }
  
};
</script>

2、局部注册用法：

App.vue ：

<template>
  <div id="app">
    <!-- v-focus 为自定义指令 -->
     <input type="text" v-focus>
  </div>
</template>
<script>
// 导入组件
import Learn from "./components/Learn"

export default {
  name: "App",
  components: {
    Learn   // 注入
  },
  data() {
    return {
      
    }
  },
  // 局部注册，仅当前实例有效
  directives: {
    focus: {
      inserted: function(el) {
        el.focus();
      }
    }
  }
  
};
</script>

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

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

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

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

 

 

 

参考：

《Vue.js 实战》

https://cn.vuejs.org/v2/guide/