记录使用vue3自定义指令

前言:

vue 中提供了很多内置的指令 比如 v-for、v-if、v-show … 等等 vue 也提供了自定义指令的语法 今天来探究一下vue3 自定义指令

自定义指令的使用前提

实现所需功能只能通过直接的dom操作实现时 才应该使用指令。

基本语法

1.在全局使用
const app = createApp({})
app.directive('focus', {
  /* ... */
})

可以在所有的组件中使用 v-focus

2.在setup 标签中使用 
const vFocus = {
	/* .... */
}
在当前的组件中使用v-focus 指令

指令的生命周期

  // 在绑定元素的 attribute 前
  // 或事件监听器应用前调用
  created(el, binding, vnode, prevVnode) {
    // 下面会介绍各个参数的细节
  },
  // 在元素被插入到 DOM 前调用
  beforeMount(el, binding, vnode, prevVnode) {},
  // 在绑定元素的父组件
  // 及他自己的所有子节点都挂载完成后调用
  mounted(el, binding, vnode, prevVnode) {},
  // 绑定元素的父组件更新前调用
  beforeUpdate(el, binding, vnode, prevVnode) {},
  // 在绑定元素的父组件
  // 及他自己的所有子节点都更新后调用
  updated(el, binding, vnode, prevVnode) {},
  // 绑定元素的父组件卸载前调用
  beforeUnmount(el, binding, vnode, prevVnode) {},
  // 绑定元素的父组件卸载后调用
  unmounted(el, binding, vnode, prevVnode) {}

生命周期函数的参数

el:  指令绑定到的元素。这可以用于直接操作 DOM。

binding: 一个对象，包含以下属性。
	value: 传递给指令的值。例如在 v-my-directive="1" 中，值是 1
	oldvalue: 之前的值，仅在 beforeUpdate 和 updated 中可用。无论值是否更改，它都可用。
	arg: 传递给指令的参数 (如果有的话)。例如在 v-my-directive:foo 中，参数是 "foo"。
	dir: 指令的定义对象。
	modifiers: 一个包含修饰符的对象 (如果有的话)。例如在 v-my-directive.foo.bar 中，修饰符对象是 { foo: true, bar: true }。
	instance: 使用该指令的组件实例。

vNode: 代表绑定元素的底层 VNode。

preNode: 代表之前的渲染中指令所绑定元素的 VNode。仅在 beforeUpdate 和 updated 钩子中可用。

注意点

1.参数 除了el 其他的都是只读的
2.简写形式 默认简写只在 mounted updated 生命周期执行

app.directive('focus', {
  /* ... */
})

3.在组件上使用 指令
3.1.当在组件上使用自定义指令时，它会始终应用于组件的根节点
3.2.需要注意的是组件可能含有多个根节点。当应用到一个多根组件时，指令将会被忽略且抛出一个警告
3.3 和attribute 不同，指令不能通过 v-bind=“$attrs” 来传递给一个不同的元素
3.4 不推荐在组件上使用自定义指令