前言

在平常开发中,弹出层算是一个最常用的组件了,尤其是后台的表单页,详情页,用户端的各种确认都很适合使用弹出层组件展示,但是一般组件库提供给我们的一般还是组件的形式,或者是一个简单的服务。

组件形式的弹出层,在我看来应该是组件库提供给我们二次封装用的,如果直接其实很不符合直觉

  • 写在页面结构里,但是却不是在页面结构中展示,放在那个位置都不合适只能放在最下边

  • 一个页面如果只有一个弹出层还好维护,多几个先不说放在那里,光维护弹出层的展示隐藏变量都是件头大的事情

  • 弹出层中间展示的如果是一个表单或者一个业务很重的页面,逻辑就会跟页面混在一起不好维护,如果抽离成组件,在后台这种全是表格表单的时候,都抽离成组件太过麻烦

那么有没有更符合思维的方式使用弹窗呢,嘿嘿还真有,那就是服务创建弹出层

服务式弹出层

等等!如果是服务创建弹出层每个ui组件库基本都提供了,为什么还要封装呢?因为组件库提供的服务一般都是用于简单的确认弹窗,如果是更重的表单弹窗就难以用组件库提供的服务创建了,我们以ant-design-vue的modal为例子看看。

<template> 
    <a-button @click="showConfirm">Confirm</a-button>
</template>
<script lang="ts">
import { ExclamationCircleOutlined } from '@ant-design/icons-vue';
import { createVNode, defineComponent } from 'vue';
import { Modal } from 'ant-design-vue';

export default defineComponent({ 
    setup() {
     const showConfirm = () => { 
       Modal.confirm({ 
          title: 'Do you want to delete these items?',
          icon: createVNode(ExclamationCircleOutlined),
          content: 'When clicked the OK button, this dialog will be closed after 1 second', 
          onOk() { 
            return new Promise((resolve, reject) => { 
              setTimeout(Math.random() > 0.5 ? resolve : reject, 1000); 
             }).catch(() => console.log('Oops errors!')); }, 
              // eslint-disable-next-line @typescript-eslint/no-empty-function 
          onCancel() {},
        });
       }; 
     return { showConfirm, };
     },
    }); 
</script>

可以看到modal提供了属性content,在文档里我们可以看到他的类型是可以传vue组件,但是这样写是有弊端的,我们无法在content中的组件关闭modal,想要在子组件关闭Modal需要把Modal本身传递给子组件,然后触发destroy();

显然modal中是一个表单和重业务的组件时,是很难支持我们的工作的,一是没法简单直接的在子组件关闭弹出层,二是content中的组件传递值给父组件使用也比较麻烦。

用Promise来创建吧!

promise来创建,我们通过在close时触发resolve,还可以通过resolve传值,来触发then,这样非常符合逻辑和语意。
事不宜迟我们以element-plusdialog为例子,来看看如何用Promise封装弹出层。

// useDialog.ts
import {
  createApp,
  createVNode,
  defineComponent,
  h,
  ref,
  onUnmounted,
} from "vue";

import { ElDialog } from "element-plus";

import type { App, Component, ComputedOptions, MethodOptions } from "vue";
//引入dialog的类型
import type { DialogProps } from "element-plus";

export type OverlayType = {
  component: Component<any, any, any, ComputedOptions, MethodOptions>;
  options?: Partial<DialogProps>;
  params?: any;
};

export class OverlayService {
  //overlay的vue实例
  private OverlayInstance!: App;
  
  // ui库的组件一般都带有动画效果,所以需要维护一个布尔值,来做展示隐藏
  public show = ref<boolean>(false);

  // 组件库的options
  private options: Partial<DialogProps> = {};

  //在open中传递给子组件的参数
  private params: any = {};

  //挂载的dom
  public overlayElement!: Element | null;

  //子组件
  private childrenComponent!: Component<
    any,
    any,
    any,
    ComputedOptions,
    MethodOptions
  >;

  //close触发的resolve,先由open创建赋予
  private _resolve: (value?: unknown) => void = () => {};

  private _reject: (reason?: any) => void = () => {};

  constructor() {
    this.overlayElement = document.createElement("div");
    document.body.appendChild(this.overlayElement);
    onUnmounted(() => {
      //离开页面时卸载overlay vue实例
      this.OverlayInstance?.unmount();
      if (this.overlayElement?.parentNode) {
        this.overlayElement.parentNode.removeChild(this.overlayElement);
      }
      this.overlayElement = null;
    });
  }
 
  private createdOverlay() {
    const vm = defineComponent(() => {
      return () =>
        h(
          ElDialog,
          {
            //默认在弹窗关闭时销毁子组件
            destroyOnClose: true,
            ...this.options,
            modelValue: this.show.value,
            onClose: this.close.bind(this),
          },
          {
            default: () =>
              createVNode(this.childrenComponent, {
                close: this.close.bind(this),
                params: this.params,
              }),
          }
        );
    });
    if (this.overlayElement) {
      this.OverlayInstance = createApp(vm);
      this.OverlayInstance.mount(this.overlayElement);
    }
  }
  //打开弹窗的方法 返回promsie
  public open(overlay: OverlayType) {
    const { component, params, options } = overlay;
    this.childrenComponent = component;
    this.params = params;
    if (options) {
      this.options = options;
    }
    return new Promise((resolve, reject) => {
      this._resolve = resolve;
      this._reject = reject;
      //判断是否有overlay 实例
      if (!this.OverlayInstance) {
        this.createdOverlay();
      }
      this.show.value = true;
    });
  }

  //弹窗的关闭方法,可以传参触发open的promise下一步
  public close(msg?: any) {
    if (!this.overlayElement) return;
    this.show.value = false;
    if (msg) {
      this._resolve(msg);
    } else {
      this._resolve();
    }
  }
}

//创建一个hooks 好在setup中使用
export const useDialog = () => {
  const overlayService = new OverlayService();
  return {
    open: overlayService.open.bind(overlayService),
    close: overlayService.close.bind(overlayService),
  };
};

封装好dialog服务之后,现在我们先创建一个子组件,传递给open的子组件会接受到close,params两个props

<!--ChildDemo.vue -->
<template>
  <div>
   {{params}}
   
   <button @click="close('关闭了弹窗')" >关闭弹窗</button>
  </div>
</template>
<script lang="ts" setup>
const props = defineProps<{
  close: (msg?: any) => void;
  params: any;
}>();
</script>

然后我们在页面使用open

<template>
  <div>
   <button @click="openDemo" >打开弹窗</button>
  </div>
</template>
<script lang="ts" setup>
import ChildDemo from './ChildDemo.vue' 
import { useDialog } from "./useDialog";

const { open } = useDialog();

const openDemo = () => {
  open({
    component: ChildDemo,
    options: { title: "弹窗demo" },
    params:{abc:'1'}
  }).then((msg)=>{
    console.log('关闭弹窗触发',msg)
  });
};
</script>

好了到此我们就封装了一个简单实用的弹窗服务。

写在后头

其实这样封装的还是有一个小问题,那就是没法拿到vue实例,只能拿到overlay的实例,因为overlay是重新创建的vue实例,所以不要使用全局注册的组件,在子组件上单独引入,pinia,vuex,router这些当params做传入子组件。

如果不想自己封装,可以用我写的库vdi useOverlay hook搭配任意的ui组件库,vdi还提供了更好的依赖注入嗷。如果搭配vdi的vueModule使用,就没有上面说的问题了

到此这篇关于用vue3封装一个符合思维且简单实用的弹出层的文章就介绍到这了,更多相关vue3封装弹出层内容请搜索Devmax以前的文章或继续浏览下面的相关文章希望大家以后多多支持Devmax!

用vue3封装一个符合思维且简单实用的弹出层的更多相关文章

  1. vue3获取当前路由地址

    本文详细讲解了vue3获取当前路由地址的方法,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

  2. 十分钟带你快速上手Vue3过渡动画

    在开发中我们想要给一个组件的显示和消失添加某种过渡动画,可以很好的增加用户体验,下面这篇文章主要给大家介绍了关于如何快速上手Vue3过渡动画的相关资料,需要的朋友可以参考下

  3. 用vue3封装一个符合思维且简单实用的弹出层

    最近新项目中需要一个弹窗组件,所以我就做了一个,下面这篇文章主要给大家介绍了关于如何利用vue3封装一个符合思维且简单实用的弹出层,文中通过实例代码介绍的非常详细,需要的朋友可以参考下

  4. 使用Vite+Vue3+Vant全家桶快速构建项目步骤详解

    这篇文章主要为大家介绍了使用Vite+Vue3+Vant全家桶快速构建项目步骤详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

  5. vue3中$attrs的变化与inheritAttrs的使用详解

    $attrs现在包括class和style属性。 也就是说在vue3中$listeners不存在了,vue2中$listeners是单独存在的,在vue3 $attrs包括class和style属性, vue2中 $attrs 不包含class和style属性,这篇文章主要介绍了vue3中$attrs的变化与inheritAttrs的使用 ,需要的朋友可以参考下

  6. vue3中proxy的基本用法说明

    这篇文章主要介绍了vue3中proxy的基本用法说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

  7. Node.js中对通用模块的封装方法

    这篇文章主要介绍了Node.js中对通用模块的封装方法,封装方法参考了Underscore.js的实现,需要的朋友可以参考下

  8. java封装及四种权限修饰符详解

    这篇文章主要介绍了java封装及四种权限修饰符详解,对属性进行封装,使用户不能直接输入数据,我们需要避免用户再使用"对象.属性"的方式对属性进行赋值

  9. 在vue中如何封装G2图表

    这篇文章主要介绍了在vue中如何封装G2图表,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

  10. JS样式获取的封装方法实例详解

    这篇文章主要介绍了JS样式获取的封装方法,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

随机推荐

  1. js中‘!.’是什么意思

  2. Vue如何指定不编译的文件夹和favicon.ico

    这篇文章主要介绍了Vue如何指定不编译的文件夹和favicon.ico,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

  3. 基于JavaScript编写一个图片转PDF转换器

    本文为大家介绍了一个简单的 JavaScript 项目,可以将图片转换为 PDF 文件。你可以从本地选择任何一张图片,只需点击一下即可将其转换为 PDF 文件,感兴趣的可以动手尝试一下

  4. jquery点赞功能实现代码 点个赞吧!

    点赞功能很多地方都会出现,如何实现爱心点赞功能,这篇文章主要为大家详细介绍了jquery点赞功能实现代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

  5. AngularJs上传前预览图片的实例代码

    使用AngularJs进行开发,在项目中,经常会遇到上传图片后,需在一旁预览图片内容,怎么实现这样的功能呢?今天小编给大家分享AugularJs上传前预览图片的实现代码,需要的朋友参考下吧

  6. JavaScript面向对象编程入门教程

    这篇文章主要介绍了JavaScript面向对象编程的相关概念,例如类、对象、属性、方法等面向对象的术语,并以实例讲解各种术语的使用,非常好的一篇面向对象入门教程,其它语言也可以参考哦

  7. jQuery中的通配符选择器使用总结

    通配符在控制input标签时相当好用,这里简单进行了jQuery中的通配符选择器使用总结,需要的朋友可以参考下

  8. javascript 动态调整图片尺寸实现代码

    在自己的网站上更新文章时一个比较常见的问题是:文章插图太宽,使整个网页都变形了。如果对每个插图都先进行缩放再插入的话,太麻烦了。

  9. jquery ajaxfileupload异步上传插件

    这篇文章主要为大家详细介绍了jquery ajaxfileupload异步上传插件,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

  10. React学习之受控组件与数据共享实例分析

    这篇文章主要介绍了React学习之受控组件与数据共享,结合实例形式分析了React受控组件与组件间数据共享相关原理与使用技巧,需要的朋友可以参考下

返回
顶部