2.2.16 v-is

已在 3.1.0 中废弃，改用:is

3、自定义指令

3.1 如何自定一个指令

3.1.1 全局自定义指令

前言部分我们也说了，在Vue3中可以通过应用实例身上的directive()注册一个全局自定义指令。例如官方给的一个例子

const app = Vue.createApp({})
// 注册一个全局自定义指令 `v-focus`
app.directive('focus', {
  // 当被绑定的元素挂载到 DOM 中时……
  mounted(el) {
    // 聚焦元素
    el.focus()
  }
})

上述代码中，通过Vue.createApp({})得到应用实例app，应用实例app身上有个directive()，用于创建一个全局的自定义指令

用的时候也非常简单，例如

3.1.2 注册局部指令

如果想注册局部指令，可在组件中配置directives选项来注册局部指令；还是以v-focus为例：

directives: {
  focus: {
    // 指令的定义
    mounted(el) {
      el.focus()
    }
  }
}

3.1.3 疑问

通过上述例子，我们可以看到不管是使用directive自定义全局指令，还是使用directives配置局部指令，里头都需要一个指令名，如focus

而具体的配置对象中的mounted是啥？mounted中的el又是啥？除了mounted还有啥，除了el还有哪些参数？

3.1.4 钩子函数（7个）

开门见山，mounted其实就是指令的钩子函数，表示组件被挂载后调用；el则是指令绑定到的元素

这里主要讲讲钩子函数，除了mounted以外，还有其他指令钩子，均为可选

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

3.1.5 钩子函数的4个参数

钩子函数的4个参数都是可选，分别是

• el：用于直接操作 DOM，表示指令绑定到的元素
• binding对象：包含以下6个属性

instance：使用指令的组件实例
value：传递给指令的值
oldValue：先前的值
arg：传递给指令的参数
modifiers：传递给指令的修饰符
dir：一个对象，其实就是注册指令时传递的配置对象

• vnode：虚拟DOM，一个真实 DOM 元素的蓝图，对应el
• prevNode：上一个虚拟节点

3.2 手动封装自定义指令

了解了基本知识，我们可以手动封装一个自定义指令v-pin，表示将一个东西定在页面上

3.2.1 创建Vue项目

首先，使用vite搭建Vue3项目

npm init vite@latest

最后根据提示，使用npm run dev启动项目

当然你也可以用其他方

我们知道Vue 自定义指令有全局注册和局部注册两种方式，为了方便，我就将v-pin注册在全局

3.2.2 实现效果

我要讲任意的定在指定的位置，比如将上图中的logo定位在右上角，代码如下：

//main.js
import { createApp } from 'vue'
import App from './App.vue'
const app = createApp(App)

app.directive('pin', {
    mounted(el, binding) {
        //是否要定住
        var pinned = binding.value;
        //传入的修饰符，表示定在哪里
        var position = binding.modifiers;
        // 传递给指令的参数，可以表示定在的重要度
        var args = binding.arg;
        if (pinned) {
            el.style.position = 'fixed';
            if (args == "warning") {
                //简单设置样式，以示区分
                el.style.backgroundColor = "pink";
            }
            for (var val in position) {
                if (position[val]) {
                    el.style[val] = '10px';
                }
            }
        } else {
            el.style.position = 'static';
            el.style.backgroundColor = "";
        }
    }
})

app.mount('#app')

使用也很简单，如下

结果如图：

3.2.3 完善结构

为了方便以后注册更多的自定义指令，我们修改代码结构

首先，新创建一个专门用于放指令的文件夹directives

然后将每个自定义指令写成一个对象并导出，如下directives\pin.js

const pin = {
  mounted(el, binding) {
    //是否要定住
    var pinned = binding.value;
    //传入的修饰符，表示定在哪里
    var position = binding.modifiers;
    // 传递给指令的参数，可以表示定在的重要度
    var args = binding.arg;
    if (pinned) {
      el.style.position = 'fixed';
      if (args == "warning") {
        el.style.backgroundColor = "pink";
      }
      for (var val in position) {
        if (position[val]) {
          el.style[val] = '10px';
        }
      }
    } else {
      el.style.position = 'static';
      el.style.backgroundColor = "";
    }
  }
}
export default pin

接着，在directives文件夹下创建index.js，将所有的指令都导入到这，放在directives中，然后导出一个install方法

import pin from './pin'
const directives = {
    pin
}
export default {
    install(app) {
        Object.keys(directives).forEach((key) => {
            app.directive(key, directives[key])
        })
    },
}

最后就是在main.js中，通过use()来调用install方法，于是将所有的指令批量注册了

import { createApp } from 'vue'
import App from './App.vue'
import Directives from './directives'


const app = createApp(App)

app.use(Directives)

app.mount('#app')

刷新之后，结果还是一样

好处是，以后再写自定义指令就方便太多了

（学习视频分享：web前端入门、vue视频教程）