来封装自定义指令吧,使用自定义指令实现countTo效果

148 阅读3分钟

一.了解自定义指令 =>vue官方文档

首先,自定义指令需要有两个参数,分别是指令名和钩子函数

  • 指令名作为调用指令的引用,默认会添加v-开头(在vue3的setup中定义除外)
  • 钩子函数作为指令的处理函数,需要选择在合适的时机调用的钩子,并且,钩子函数中默认会传入四个参数

钩子函数的参数

指令的钩子会传递以下几种参数:

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

  • binding:一个对象,包含以下属性。

    • value:传递给指令的值。例如在 v-my-directive="1 + 1" 中,值是 2
    • oldValue:之前的值,仅在 beforeUpdate 和 updated 中可用。无论值是否更改,它都可用。
    • arg:传递给指令的参数 (如果有的话)。例如在 v-my-directive:foo 中,参数是 "foo"
    • modifiers:一个包含修饰符的对象 (如果有的话)。例如在 v-my-directive.foo.bar 中,修饰符对象是 { foo: true, bar: true }
    • instance:使用该指令的组件实例。
    • dir:指令的定义对象。
  • vnode:代表绑定元素的底层 VNode。

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

钩子函数有哪些

const myDirective = {
  // 在绑定元素的 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) {}
}

二.如何定义自定义指令

1.1 setup中

在 <script setup> 中,任何以 v 开头的小驼峰命名的变量都可以被用作一个自定义指令。比如,vFocus 即可以在模板中以 v-focus 的形式使用。

<script setup>
// 在模板中启用 v-focus
const vFocus = {
  // 这里是钩子函数,在这里写逻辑
  mounted: (el) => el.focus()
}
</script>

<template>
  <input v-focus />
</template>

1.2 export default 导出的对象中

在没有使用 <script setup> 的情况下,自定义指令需要通过 directives 选项注册:

export default {
  setup() {
    /*...*/
  },
  directives: {
    // 在模板中启用 v-focus
    focus: {
      /* 钩子函数 */
    }
  }
}

1.3单独的js文件中

将一个自定义指令全局注册到应用层级也是一种常见的做法:

const app = createApp({})

// 使 v-focus 在所有组件中都可用
app.directive('focus', {
  /* 钩子函数 */
})

1.4简写,仅使用 mountedupdated钩子的自定义指令

// 封装一个改变颜色的自定义指令
app.directive('color', (el, binding) => {
    // 这会在 `mounted` 和 `updated` 时都调用 
    el.style.color = binding.value 
})

三.做一个案例,实现数字不断增加的跳动效果

// 使用vue2的导入方式
import Vue from 'vue'
Vue.directive('countTo', (el, bind) => {
  console.log(bind.value)
  let count = 0
  const num = Math.floor(bind.value * 50 / 2000)
  const timerId = setInterval(() => {
    if (count >= bind.value) {
      clearInterval(timerId)
      el.innerHTML = bind.value
      return
    }
    el.innerHTML = count += num
  }, 50)
})

// 不在main中,在单独js文件里定义,并且使用vue3和vue.use

// directive.js
export default {
  install(vue) {
    vue.directive('countTo', (el, bind) => {
      let count = 0
      const num = Math.floor(bind.value * 50 / 2000)
      const timerId = setInterval(() => {
        if (count >= bind.value) {
          clearInterval(timerId)
          el.innerHTML = bind.value
          return
        }
        el.innerHTML = count += num
      }, 50)
    })
  }
}

// main.js
import directive from ./directive.js
const app = createApp(App)
app.use(directive)