vue3封装弹出层

时间:2022-06-02 LinkandZelda 人气:6

前言

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

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

写在页面结构里，但是却不是在页面结构中展示，放在那个位置都不合适只能放在最下边
一个页面如果只有一个弹出层还好维护，多几个先不说放在那里，光维护弹出层的展示隐藏变量都是件头大的事情
弹出层中间展示的如果是一个表单或者一个业务很重的页面，逻辑就会跟页面混在一起不好维护，如果抽离成组件，在后台这种全是表格表单的时候，都抽离成组件太过麻烦

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

服务式弹出层

等等！如果是服务创建弹出层每个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-plus的dialog为例子，来看看如何用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使用，就没有上面说的问题了

加载全部内容