Vue3 自定义指令

除了默认设置的核心指令( v-model 和 v-show ), Vue 也允许注册自定义指令。

下面我们注册一个全局指令 v-focus, 该指令的功能是在页面加载时，元素获得焦点：

实例

<div id="app">
    <p>页面载入时，input 元素自动获取焦点：</p>
    <input v-focus></div>
 <script>const app = Vue.createApp({})
// 注册一个全局自定义指令 `v-focus`
app.directive('focus', {
  // 当被绑定的元素挂载到 DOM 中时……
  mounted(el) {
    // 聚焦元素
    el.focus()
  }
})
app.mount('#app')</script>

尝试一下 »

我们也可以在实例使用 directives 选项来注册局部指令，这样指令只能在这个实例中使用：

实例

<div id="app">
    <p>页面载入时，input 元素自动获取焦点：</p>
    <input v-focus></div>
 <script>const app = {
   data() {
      return {
      }
   },
   directives: {
      focus: {
         // 指令的定义
         mounted(el) {
            el.focus()
         }
      }
   }
}
 
Vue.createApp(app).mount('#app')

尝试一下 »

钩子

钩子函数

指令定义函数提供了几个钩子函数（可选）：

钩子函数

指令定义函数提供了几个钩子函数（可选）：

created : 在绑定元素的属性或事件监听器被应用之前调用。
beforeMount : 指令第一次绑定到元素并且在挂载父组件之前调用。。
mounted : 在绑定元素的父组件被挂载后调用。。
beforeUpdate: 在更新包含组件的 VNode 之前调用。。
updated: 在包含组件的 VNode 及其子组件的 VNode 更新后调用。
beforeUnmount: 当指令与在绑定元素父组件卸载之前时，只调用一次。
unmounted: 当指令与元素解除绑定且父组件已卸载时，只调用一次。

实例

import { createApp } from 'vue'const app = createApp({})
 // 注册app.directive('my-directive', {
  // 指令是具有一组生命周期的钩子：
  // 在绑定元素的 attribute 或事件监听器被应用之前调用
  created() {},  // 在绑定元素的父组件挂载之前调用
  beforeMount() {},  // 绑定元素的父组件被挂载时调用
  mounted() {},  // 在包含组件的 VNode 更新之前调用
  beforeUpdate() {},  // 在包含组件的 VNode 及其子组件的 VNode 更新之后调用
  updated() {},  // 在绑定元素的父组件卸载之前调用
  beforeUnmount() {},  // 卸载绑定元素的父组件时调用
  unmounted() {}})
 // 注册 (功能指令)app.directive('my-directive', () => {
  // 这将被作为 `mounted` 和 `updated` 调用})
 // getter, 如果已注册，则返回指令定义const myDirective = app.directive('my-directive')

钩子函数参数

钩子函数的参数有：

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

binding

binding 是一个对象，包含以下属性：

instance：使用指令的组件实例。
value：传递给指令的值。例如，在 v-my-directive="1 + 1" 中，该值为 2。
oldValue：先前的值，仅在 beforeUpdate 和 updated 中可用。值是否已更改都可用。
arg：参数传递给指令 (如果有)。例如在 v-my-directive:foo 中，arg 为 "foo"。
modifiers：包含修饰符 (如果有) 的对象。例如在 v-my-directive.foo.bar 中，修饰符对象为 {foo: true，bar: true}。
dir：一个对象，在注册指令时作为参数传递。例如，在以下指令中：