脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 网络编程 → JavaScript → javascript类库 → vue.js → Vue3自定义指令

Vue3自定义指令的实践示例

 更新时间：2023年06月28日 10:10:22   作者：萌萌哒草头将军  
这篇文章主要为大家详细介绍了Vue3中自定义指令的实践，文中的示例代码讲解详细，具有一定的借鉴价值，感兴趣的小伙伴可以了解一下

关键接口介绍

最近想体验下自定义指令功能，看了看文档和 vue2 差异不大，语法如下：

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) {}
}

起初，最大的痛点是需要手动创建 dom ，然后插入 el 中。

const loadingDom = document.createElement('div', {calss: 'loading'})
el.append(loadingDom)

这样好难受啊，我不想写原生 dom ，能不能写个组件渲染到指令里呢？

我想起了我之前看到的几个 vue 接口，

  • h函数，也就是 vue 提供的创建 vNode 的函数
  • render函数：将 vNode 渲染到 真实 dom 里的函数

h函数用法如下：

// 完整参数签名
function h(
    type: string | Component,
    props?: object | null,
    children?: Children | Slot | Slots
): VNode

例如：

import { h } from 'vue'
const vnode = h('div', { class: 'container' }, [
  h('h1', 'Hello, Vue 3'),
  h('p', 'This is a paragraph')
])

我们使用h函数创建了一个 VNode，它表示一个包含 div、h1、p 的 DOM 结构。其中，div 的 class 属性为 container

自定义 loading 组件

然而，当我使用 props 为组件传递值时，发现是徒劳的。

import Loading from './components/Loading.vue';
cconst option = {
    msg: '一大波僵尸来袭',
    loading: true
}
const vnode = h(
    Loading,
    { id: 'loading', ...option}
)

仅仅如下图一样，我以为是给组件的 props，实际上是 dom 的 props。

此时我们的组件只能通过 $attrs 来获取这些 props 了，如下：

<template>
  <div class="loading">
    <div></div>
    <span v-if="$attrs.msg !== false">{{ $attrs.msg }}</span>
  </div>
</template>

接着我们给组件实现 loading 动画，当然你也可以直接使用组件库的 loading 组件。

我的实现如下：

<style>
  @keyframes identifier {
    100% {
      -webkit-transform: rotate(360deg);
      transform: rotate(360deg);
    }
  }
  .loading {
    height: 100px;
    width: 100%;
  }
  .loading div {
    width: 50px;
    height: 50px;
    border-radius: 50%;
    border: 2px solid green;
    margin: 25px auto;
    border-top: none;
    border-left: none;
    animation: identifier 1s infinite linear;
  }
</style>

自定义指令

接下来我们封装自定义指令。

我们的思路是：

  • mounted 阶段，如果是 true，那么渲染组件，否则什么都不做。
  • update 阶段，如果 true 则重新渲染组件，如果 false 则渲染 vnode

为了可以应对更多场景，我们期望可以配置加载中的提示信息，不配置使用默认值，如果是 false ，那么仅展示 loading 图。所以参数类型如下：

interface Props  {loading: boolean, msg?: string | false}
v-loading: boolean | Props

由于可能是布尔值，也可能是对象，我们需要初始化配置参数

function formatOption (value: boolean | Props) {
  const loading = typeof value === 'boolean'
      ? value 
      : value.loading
  const option = typeof value !== 'boolean'
    ? Object.assign(defaultOption, value)
    : {
      loading,
      ...defaultOption
    }
  return { loading, option }
}

接着再 mounted 阶段获取格式化后的 loading 和 option，如果为 true 则直接渲染组件。

const vLoading: Directive<HTMLElement, boolean | Props> = {
  mounted(el, binding) {
    const { loading, option } = formatOption(binding.value)
    loading && renderLoading(el, option)
  }
}
function renderLoading (el: HTMLElement, option: Props) {
  const vnode = h(
    Loading,
    { id: 'loading', ...option}
  )
  el.removeChild(el.children[0])
  render(vnode, el)
}

如果进入 update 阶段，则根据情况选择渲染 laoding 组件还是 vnode。

const vLoading: Directive<HTMLElement, boolean | Props> = {
  mounted(el, binding) {
    const { loading, option } = formatOption(binding.value)
    loading && renderLoading(el, option)
  },
  updated(el: HTMLElement, binding, vnode) {
    const { loading, option } = formatOption(binding.value)
    if (loading) {
      renderLoading(el, option)
    } else {
      renderVNode(el, vnode)
    }
  },
}
function renderLoading (el: HTMLElement, option: Props) {
  const vnode = h(
    Loading,
    { id: 'loading', ...option}
  )
  el.removeChild(el.children[0])
  render(vnode, el)
}
function renderVNode (el: HTMLElement, vnode: VNode) {
  el.querySelector('#loading')?.remove()
  render(vnode, el)
}

我们验证下功能：

1.默认功能

const loading = ref(true)
setTimeout(() => loading.value = false, 2000)
</script>
<template>
  <div style="width: 300px" v-loading=laoding>
    <h1>加载成功</h1>
  </div>
</template>

2.自定义文本

<template>
  <div style="width: 300px" v-loading="{ loading, msg: '一大波僵尸来袭' }">
    <h1>加载成功</h1>
  </div>
</template>

3.不展示文本

<template>
  <div style="width: 300px" v-loading="{ loading, msg: false }">
    <h1>加载成功</h1>
  </div>
</template>

最后

今天的分享就到这了，如果有问题，可以评论区告诉我，我会及时更正。

以下是完整的代码。

<template>
  <div class="loading">
    <div></div>
    <span v-if="$attrs.msg !== false">{{ $attrs.msg }}</span>
  </div>
</template>
<script lang="ts">
export default {  
}
</script>
<style>
  @keyframes identifier {
    100% {
      -webkit-transform: rotate(360deg);
      transform: rotate(360deg);
    }
  }
  .loading {
    height: 100px;
    width: 100%;
  }
  .loading div {
    width: 50px;
    height: 50px;
    border-radius: 50%;
    border: 2px solid green;
    margin: 25px auto;
    border-top: none;
    border-left: none;
    animation: identifier 1s infinite linear;
  }
</style>
<script setup lang="ts">
import { Directive, VNode, h, ref, render  } from 'vue';
import Loading from './components/Loading.vue';
const defaultOption: {msg?: string | false} = {
  msg: '努力加载中'
}
interface Props  {loading: boolean, msg?: string | false}
function formatOption (value: boolean | Props) {
  const loading = typeof value === 'boolean'
      ? value 
      : value.loading
  const option = typeof value !== 'boolean'
    ? Object.assign(defaultOption, value)
    : {
      loading,
      ...defaultOption
    }
  return { loading, option }
}
function renderLoading (el: HTMLElement, option: Props) {
  const vnode = h(
    Loading,
    { id: 'loading', ...option}
  )
  el.removeChild(el.children[0])
  render(vnode, el)
}
function renderVNode (el: HTMLElement, vnode: VNode) {
  el.querySelector('#loading')?.remove()
  render(vnode, el)
}
const vLoading: Directive<HTMLElement, boolean | Props> = {
  mounted(el, binding) {
    const { loading, option } = formatOption(binding.value)
    loading && renderLoading(el, option)
  },
  updated(el: HTMLElement, binding, vnode) {
    const { loading, option } = formatOption(binding.value)
    if (loading) {
      renderLoading(el, option)
    } else {
      renderVNode(el, vnode)
    }
  },
}
const loading = ref(true)
setTimeout(() => loading.value = false, 2000)
</script>
<template>
  <div style="width: 300px" v-loading="{ loading, msg: '一大波僵尸来袭' }">
    <h1>加载成功</h1>
  </div>
</template>

以上就是Vue3自定义指令的实践示例的详细内容，更多关于Vue3自定义指令的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • Vue 设置axios请求格式为form-data的操作步骤

    Vue 设置axios请求格式为form-data的操作步骤

    今天小编就为大家分享一篇Vue 设置axios请求格式为form-data的操作步骤，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2019-10-10
  • Vue的computed计算属性你了解吗

    Vue的computed计算属性你了解吗

    这篇文章主要为大家详细介绍了Vue的computed计算属性，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助
    2022-03-03
  • 如何使用Vue的思想封装一个Storage

    如何使用Vue的思想封装一个Storage

    作为Web Storage API的接口,Storage 提供了访问特定域名下的会话存储或本地存储的功能,例如可以添加、修改或删除存储的数据项,这篇文章主要给大家介绍了关于如何使用Vue的思想封装一个Storage的相关资料,需要的朋友可以参考下
    2021-08-08
  • vue3中使用vuex和vue-router的详细步骤

    vue3中使用vuex和vue-router的详细步骤

    这篇文章主要介绍了vue3中使用vuex和vue-router的步骤，本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-12-12
  • Vue实现Tab标签路由效果并用Animate.css做转场动画效果的代码

    Vue实现Tab标签路由效果并用Animate.css做转场动画效果的代码

    这篇文章主要介绍了Vue实现Tab标签路由效果，并用Animate.css做转场动画效果，本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-07-07
  • Vue下拉选择框Select组件使用详解(二)

    Vue下拉选择框Select组件使用详解(二)

    这篇文章主要为大家详细介绍了Vue下拉选择框Select组件的使用，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2022-03-03
  • vue2实现可复用的轮播图carousel组件详解

    vue2实现可复用的轮播图carousel组件详解

    这篇文章主要为大家详细介绍了vue2实现可复用的轮播图carousel组件，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2017-11-11
  • Vue父子组件通信全面详细介绍

    Vue父子组件通信全面详细介绍

    这篇文章主要介绍了React中父子组件通信详解，在父组件中，为子组件添加属性数据，即可实现父组件向子组件通信，文章通过围绕主题展开详细的内容介绍，具有一定的参考价值，需要的小伙伴可以参考一下
    2022-10-10
  • vue中分割线的实现方式

    vue中分割线的实现方式

    这篇文章主要介绍了vue中分割线的实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-12-12
  • vue-class-setup 编写 class 风格组合式API

    vue-class-setup 编写 class 风格组合式API

    这篇文章主要为大家介绍了vue-class-setup 编写 class 风格组合式API，支持Vue2和Vue3，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2022-09-09

最新评论