vue自定义指令之手写v-loading指令

最新推荐文章于 2024-08-02 01:16:46 发布

井底的蜗牛

最新推荐文章于 2024-08-02 01:16:46 发布

阅读量2.2k

点赞数 1

分类专栏： vue

本文链接：https://blog.csdn.net/weixin_41277748/article/details/117666667

版权

Vue 自定义指令 loading 动画组件复用

关键词由CSDN通过智能技术生成

vue 专栏收录该内容

31 篇文章 2 订阅

订阅专栏

先看效果

自定义加载效果的loading指令

为什么不创建一个组件来加载loading效果：
- 麻烦你得先引入组件，注册挂载组件，然后在通过v-if在空子显示隐藏
为什么要用自定义loading指令：
- 由于项目中很多地方需要用到，在哪个元素或者组件直接使用v-xx就可以了方便
- 不过前提是需要用到的地方多，不然要么不用，要么不要在全局注册，局部注册就行

如何定义

首先得了解自定义指令的钩子函数

bind：只调用一次，指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。
inserted：被绑定元素插入父节点时调用(仅保证父节点存在，但不一定已被插入文档中)。
update：所在组件的 VNode 更新时调用，但是可能发生在其子 VNode 更新之前，如果要用到子的虚拟节点最好不要在这里进行擦走。
componentUpdated：指令所在组件的 VNode 及其子 VNode 全部更新后调用。
unbind：只调用一次，指令与元素解绑时调用(被绑定的Dom元素被Vue移除【v-if移除】)。

了解钩子函数所对应的参数

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 编译生成的虚拟节点。
oldVnode：上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。

当 bind函数所发生的事情和update发生的事情一样时，vue在定义指令时可以简写

Vue.directive('loading', {
    bind(el, binding, vnode) {
    //...
    },
    update(el, binding, vnode) {
    //...
    }
})
//简写
Vue.directive('loading', (el, binding) => {
  //...
})

开始动手【首先声明该指令vue2与vue3都可以使用，只不过是定义的方式不同】

vue2定义指令

  import Vue from 'vue' 
  Vue.directive('loading', (el, binding) => {
      //...
  })

vue3 定义指令

  import { createApp } from 'vue'
  import App from './App.vue'
  const app=createApp(App)
  app.directive('loading',(el, binding)=>{
      //...
  })

分析如何实现

首先得获取到参数el中加载loading图片的img元素
```
  el.querySelector('img[data-role=loading]');
```
考虑给指令的值(binding.value)是否存在或者是否为true

是否有加载loading图片的img元素，没有得创建loadingImg添加到el中

    const img = document.createElement('img');
    img.dataset.role = 'loading';
    img.src = loadingUrl;
    img.className=style.loading
    return img;

4、如果binding.value值为false或者不存在了,就得移除加loading的元素

完整代码定义文件夹其中包含loading的图片【loading.svg】，loading.js，loading.module.css

loading.js

  import loadingUrl from './loading.svg'
  import style from './load.module.css'

  /**以下为辅助函数**/
  /**
  * 得到loading效果的img元素
  * @param el 传入的dom元素
  */
  function getLoadingImg(el) {
    //查找图片中有data-role为loading的图片
    return el.querySelector('img[data-role=loading]');
  }

  /**
  * 创建一个加载loading图片的元素
  */
  function createLoadingImg() {
    const img = document.createElement('img');
    //添加data-role为loading的属性
    img.dataset.role = 'loading';
    //给创建的img元素添加图片地址
    img.src = loadingUrl;
    //给img添加className
    img.className=style.loading
    return img;
  }


  export default function (el, binding) {
      //获取当前的有loading效果的img元素
      const curImg=getLoadingImg(el);
      //根据binding.value的值，决定创建或者删除img元素
      if (binding.value) {
          // 判断loading效果的img元素是否存在
          if (!curImg) {
              //创建该元素
              const loadingImg = createLoadingImg();
              //把创建好的元素加入到dom元素中
              el.appendChild(loadingImg)
          }
      } else {
          //如果binding.value值为false或者不存在
          //判断是否有loadingImg元素
          if(curImg){
              //移除loadingImg元素
              curImg.remove()
          }
      }
  }
  //由于bind和update钩子函数的作用都是根据binding.value的值，决定创建或删除img元素所以就合并为一起
  // export default {
  //     bind(el,binding){
  //         // 根据binding.value的值，决定创建或删除img元素
  //     },
  //     update(el,binding){
  //         // 根据binding.value的值，决定创建或删除img元素
  //     }
  // }

loading.module.css 让其在每个div中间显示

.loading{
    position: absolute;
    left: 50%;
    top: 50%;
    transform: translate(-50%,-50%);
}

图片，这里的图片是用svg的格式

    <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="50px" height="50px" viewBox="0 0 50 50" style="enable-background:new 0 0 50 50" xml:space="preserve">
        <path fill="#409eff" d="M43.935,25.145c0-10.318-8.364-18.683-18.683-18.683c-10.318,0-18.683,8.365-18.683,18.683h4.068c0-8.071,6.543-14.615,14.615-14.615c8.072,0,14.615,6.543,14.615,14.615H43.935z" transform="rotate(275.098 25 25)">
            <animateTransform attributeType="xml" attributeName="transform" type="rotate" from="0 25 25" to="360 25 25" dur=".8s" repeatCount="indefinite"></animateTransform>
        </path>
    </svg>

定义好后在全局自定义指令main.js(这里使用的vue3方式)

import { createApp } from 'vue'
import App from './App.vue'
const app=createApp(App)
import loaded from "./directives/loading/loading";
app.directive('loading',loaded)
app.mount('#app');

页面中直接使用v-loading="true"就可以了