今天给大家分享的是vue3系列之自定义桌面端对话框组件v3layer。

v3layer 基于vue3.0构建的多功能pc网页端弹窗组件。拥有超过10+种弹窗类型、30+种参数配置，支持拖拽(自定义拖拽区域)、缩放、最大化、全屏及自定义置顶层叠等功能。

快速引入

在main.js中引入v3layer组件。

import { createapp } from 'vue'
import app from './app.vue'

// 引入element-plus组件库
import elementplus from 'element-plus'
import 'element-plus/lib/theme-chalk/index.css'

// 引入弹窗组件v3layer
import v3layer from './components/v3layer'

createapp(app).use(elementplus).use(v3layer).mount('#app')

v3layer支持组件式+函数式两种调用方式。

• 组件式

<v3-layer 
    v-model="showdialog"
    title="标题内容"
    content="<div style='color:#f57b16;padding:30px;'>这里是内容信息！</div>"
    z-index="2021"
    lockscroll="false"
    xclose
    resize
    dragout
    :btns="[
        {text: '取消', click: () => showdialog=false},
        {text: '确认', style: 'color:#f90;', click: handlesure},
    ]"
/>
    <template v-slot:content>这里是自定义插槽内容信息！</template>
</v3-layer>

• 函数式

let $el = v3layer({
    title: '标题内容',
    content: '<div style='color:#f57b16;padding:30px;'>这里是内容信息！</div>', 
    shadeclose: false,
    zindex: 2021,
    lockscroll: false,
    xclose: true,
    resize: true,
    dragout: true,
    btns: [
        {text: '取消', click: () => { $el.close() }},
        {text: '确认', click: () => handlesure},
    ]
});

当弹窗类型为 message | notify | popover，调用方法如下：

v3layer.message({...})
v3layer.notify({...})
v3layer.popover({...})

vue3.0中提供了
app.config.globalproperties 或 app.provide 两种方式挂载全局函数。

• 如果是 app.config.globalproperties 方式创建：

// vue2中调用
methods: {
    showdialog() {
        this.$v3layer({...})
    }
}

// vue3中调用
setup() {
    // 获取上下文
    const { ctx } = getcurrentinstance()
    ctx.$v3layer({...})
}

• 如果是 app.provide 方式创建：

// vue2中调用
methods: {
    showdialog() {
        this.v3layer({...})
    }
}

// vue3中调用
setup() {
    const v3layer = inject('v3layer')
    
    const showdialog = () => {
        v3layer({...})
    }

    return {
        v3layer,
        showdialog
    }
}

参数配置

v3layer支持如下30+参数灵活配置，实现各种弹窗场景。

|props参数|
v-model         是否显示弹框
id              弹窗唯一标识
title           标题
content         内容（支持string、带标签内容、自定义插槽内容）***如果content内容比较复杂，推荐使用标签式写法
type            弹框类型（toast|footer|actionsheet|actionsheetpicker|android|ios|contextmenu|drawer|iframe）
layerstyle      自定义弹窗样式
icon            toast图标（loading | success | fail）
shade           是否显示遮罩层
shadeclose      是否点击遮罩时关闭弹窗
lockscroll      是否弹窗出现时将body滚动锁定
opacity         遮罩层透明度
xclose          是否显示关闭图标
xposition       关闭图标位置（left | right | top | bottom）
xcolor          关闭图标颜色
anim            弹窗动画（scalein | fadein | footer | fadeinup | fadeindown | fadeinleft | fadeinright）
position        弹出位置（auto | ['100px','50px'] | t | r | b | l | lt | rt | lb | rb）
drawer          抽屉弹窗（top | right | bottom | left）
follow          跟随元素定位弹窗（支持元素.kk #kk 或 [e.clientx, e.clienty]）
time            弹窗自动关闭秒数（1、2、3）
zindex          弹窗层叠（默认8080）
teleport        指定挂载节点（默认是挂载组件标签位置，可通过teleport自定义挂载位置） teleport="body | #xxx | .xxx"
topmost         置顶当前窗口（默认false）
area            弹窗宽高（默认auto）设置宽度area: '300px' 设置高度area:['', '200px'] 设置宽高area:['350px', '150px']
maxwidth        弹窗最大宽度（只有当area:'auto'时，maxwidth的设定才有效）
maximize        是否显示最大化按钮（默认false）
fullscreen      全屏弹窗（默认false）
fixed           弹窗是否固定
drag            拖拽元素（可定义选择器drag:'.xxx' | 禁止拖拽drag:false）
dragout         是否允许拖拽到窗口外（默认false）
lockaxis        限制拖拽方向可选: v 垂直、h 水平，默认不限制
resize          是否允许拉伸尺寸（默认false）
btns            弹窗按钮（参数：text|style|disabled|click）
++++++++++++++++++++++++++++++++++++++++++++++
|emit事件触发|
success         层弹出后回调（@success="xxx"）
end             层销毁后回调（@end="xxx"）
++++++++++++++++++++++++++++++++++++++++++++++
|event事件|
onsuccess       层打开回调事件
onend           层关闭回调事件

v3layer弹窗模板

<template>
    <div ref="elref" v-show="opened" class="vui__layer" :class="{'vui__layer-closed': closecls}" :id="id">
        <!-- //蒙版 -->
        <div v-if="json.parse(shade)" class="vlayer__overlay" @click="shadeclicked" :style="{opacity}"></div>
        <div class="vlayer__wrap" :class="['anim-'+anim, type&&'popui__'+type, tiparrow]" :style="[layerstyle]">
            <div v-if="title" class="vlayer__wrap-tit" v-html="title"></div>
            <div v-if="type=='toast'&&icon" class="vlayer__toast-icon" :class="['vlayer__toast-'+icon]" v-html="toasticon[icon]"></div>
            <div class="vlayer__wrap-cntbox">
                <!-- 判断插槽是否存在 -->
                <template v-if="$slots.content">
                    <div class="vlayer__wrap-cnt"><slot name="content" /></div>
                </template>
                <template v-else>
                    <template v-if="content">
                        <iframe v-if="type=='iframe'" scrolling="auto" allowtransparency="true" frameborder="0" :src="content"></iframe>
                        <!-- message|notify|popover -->
                        <div v-else-if="type=='message' || type=='notify' || type=='popover'" class="vlayer__wrap-cnt">
                            <i v-if="icon" class="vlayer-msg__icon" :class="icon" v-html="messageicon[icon]"></i>
                            <div class="vlayer-msg__group"><div v-if="title" class="vlayer-msg__title" v-html="title"></div><div v-html="content"></div></div>
                        </div>
                        <div v-else class="vlayer__wrap-cnt" v-html="content"></div>
                    </template>
                </template>
                <slot />
            </div>
            <div v-if="btns" class="vlayer__wrap-btns">
                <span v-for="(btn,index) in btns" :key="index" class="btn" :style="btn.style" @click="btnclicked($event,index)" v-html="btn.text"></span>
            </div>
            <span v-if="xclose" class="vlayer__xclose" :class="!maximize&&xposition" :style="{'color': xcolor}" @click="close"></span>
            <span v-if="maximize" class="vlayer__maximize" @click="maximizeclicked($event)"></span>
            <span v-if="resize" class="vlayer__resize"></span>
        </div>
        <!-- 优化拖拽卡顿 -->
        <div class="vlayer__dragfix"></div>
    </div>
</template>

<script>
    import { onmounted, onunmounted, ref, reactive, watch, torefs, nexttick } from 'vue'
    import domutils from './utils/dom.js'
    // 索引，蒙层控制，定时器
    let $index = 0, $locknum = 0, $timer = {}, $closetimer = null
    export default {
        props: {
            // ...
        },
        emits: [
            'update:modelvalue'
        ],
        setup(props, context) {
            const elref = ref(null);

            const data = reactive({
                opened: false,
                closecls: '',
                toasticon: {
                    // ...
                },
                messageicon: {
                    // ...
                },
                vlayeropts: {},
                tiparrow: null,
            })

            onmounted(() => {
                if(props.modelvalue) {
                    open();
                }
                window.addeventlistener('resize', autopos, false);
            })

            onunmounted(() => {
                window.removeeventlistener('resize', autopos, false);
                cleartimeout($closetimer);
            })

            // 监听弹层v-model
            watch(() => props.modelvalue, (val) => {
                // console.log('v3layer is now [%s]', val ? 'show' : 'hide')
                if(val) {
                    open();
                }else {
                    close();
                }
            })

            // 打开弹窗
            const open = () => {
                if(data.opened) return;
                data.opened = true;
                typeof props.onsuccess === 'function' && props.onsuccess();

                const dom = elref.value;
                // 弹层挂载位置
                if(props.teleport) {
                    nexttick(() => {
                        let teleportnode = document.queryselector(props.teleport);
                        teleportnode.appendchild(dom);

                        auto();
                    })
                }

                callback();
            }

            // 关闭弹窗
            const close = () => {
                if(!data.opened) return;

                let dom = elref.value;
                let vlayero = dom.queryselector('.vlayer__wrap');
                let ocnt = dom.queryselector('.vlayer__wrap-cntbox');
                let omax = dom.queryselector('.vlayer__maximize');

                data.closecls = true;
                cleartimeout($closetimer);
                $closetimer = settimeout(() => {
                    data.opened = false;
                    data.closecls = false;
                    if(data.vlayeropts.lockscroll) {
                        $locknum--;
                        if(!$locknum) {
                            document.body.style.paddingright = '';
                            document.body.classlist.remove('vui__body-hidden');
                        }
                    }
                    if(props.time) {
                        $index--;
                    }
                    // 清除弹窗样式
                    vlayero.style.width = vlayero.style.height = vlayero.style.top = vlayero.style.left = '';
                    ocnt.style.height = '';
                    omax && omax.classlist.contains('maximized') && omax.classlist.remove('maximized');
                    
                    data.vlayeropts.isbodyoverflow && (document.body.style.overflow = '');

                    context.emit('update:modelvalue', false);
                    typeof props.onend === 'function' && props.onend();
                }, 200)
            }

            // 弹窗位置
            const auto = () => {
                // ...

                autopos();

                // 全屏弹窗
                if(props.fullscreen) {
                    full();
                }

                // 弹窗拖动|缩放
                move();
            }

            const autopos = () => {
                if(!data.opened) return;
                let ol, ot
                let pos = props.position;
                let isfixed = json.parse(props.fixed);
                let dom = elref.value;
                let vlayero = dom.queryselector('.vlayer__wrap');

                if(!isfixed || props.follow) {
                    vlayero.style.position = 'absolute';
                }
                
                let area = [domutils.client('width'), domutils.client('height'), vlayero.offsetwidth, vlayero.offsetheight]
                
                ol = (area[0] - area[2]) / 2;
                ot = (area[1] - area[3]) / 2;

                if(props.follow) {
                    offset();
                }else {
                    typeof pos === 'object' ? (
                        ol = parsefloat(pos[0]) || 0, ot = parsefloat(pos[1]) || 0
                    ) : (
                        pos == 't' ? ot = 0 : 
                        pos == 'r' ? ol = area[0] - area[2] : 
                        pos == 'b' ? ot = area[1] - area[3] : 
                        pos == 'l' ? ol = 0 : 
                        pos == 'lt' ? (ol = 0, ot = 0) : 
                        pos == 'rt' ? (ol = area[0] - area[2], ot = 0) : 
                        pos == 'lb' ? (ol = 0, ot = area[1] - area[3]) :
                        pos == 'rb' ? (ol = area[0] - area[2], ot = area[1] - area[3]) : 
                        null
                    )

                    vlayero.style.left = parsefloat(isfixed ? ol : domutils.scroll('left') + ol) + 'px';
                    vlayero.style.top = parsefloat(isfixed ? ot : domutils.scroll('top') + ot) + 'px';
                }
            }

            // 元素跟随定位
            const offset = () => {
                let ow, oh, ps
                let dom = elref.value
                let vlayero = dom.queryselector('.vlayer__wrap');

                ow = vlayero.offsetwidth;
                oh = vlayero.offsetheight;
                ps = domutils.getfollowrect(props.follow, ow, oh);
                data.tiparrow = ps[2];
                
                vlayero.style.left = ps[0] + 'px';
                vlayero.style.top = ps[1] + 'px';
            }

            // 最大化弹窗
            const full = () => {
                // ...
            }

            // 恢复弹窗
            const restore = () => {
                let dom = elref.value;
                let vlayero = dom.queryselector('.vlayer__wrap');
                let otit = dom.queryselector('.vlayer__wrap-tit');
                let ocnt = dom.queryselector('.vlayer__wrap-cntbox');
                let obtn = dom.queryselector('.vlayer__wrap-btns');
                let omax = dom.queryselector('.vlayer__maximize');

                let t = otit ? otit.offsetheight : 0
                let b = obtn ? obtn.offsetheight : 0

                if(!data.vlayeropts.lockscroll) {
                    data.vlayeropts.isbodyoverflow = false;
                    document.body.style.overflow = '';
                }
                
                props.maximize && omax.classlist.remove('maximized')
                
                vlayero.style.left = parsefloat(data.vlayeropts.rect[0]) + 'px';
                vlayero.style.top = parsefloat(data.vlayeropts.rect[1]) + 'px';
                vlayero.style.width = parsefloat(data.vlayeropts.rect[2]) + 'px';
                vlayero.style.height = parsefloat(data.vlayeropts.rect[3]) + 'px';
            }

            // 拖动|缩放弹窗
            const move = () => {
                // ...
            }

            // 事件处理
            const callback = () => {
                // 倒计时关闭
                if(props.time) {
                    $index++
                    // 防止重复点击
                    if($timer[$index] !== null) cleartimeout($timer[$index])
                    $timer[$index] = settimeout(() => {
                        close();
                    }, parseint(props.time) * 1000)
                }
            }

            // 点击最大化按钮
            const maximizeclicked = (e) => {
                let o = e.target
                if(o.classlist.contains('maximized')) {
                    // 恢复
                    restore();
                } else {
                    // 最大化
                    full();
                }
            }
            // 点击遮罩层
            const shadeclicked = () => {
                if(json.parse(props.shadeclose)) {
                    close();
                }
            }
            // 按钮事件
            const btnclicked = (e, index) => {
                let btn = props.btns[index]
                if(!btn.disabled) {
                    typeof btn.click === 'function' && btn.click(e)
                }
            }
            
            return {
                ...torefs(data),
                elref,
                close,
                maximizeclicked,
                shadeclicked,
                btnclicked,
            }
        }
    }
</script>

v3layer支持自定义拖拽区域 (drag:’#aaa’)，拖动到窗口外 (dragout:true)。支持iframe弹窗类型 (type:’iframe’)。

配置 topmost:true 当前窗口会保持置顶。

ok，基于vue3.0开发pc端对话框组件就分享到这里。希望对大家有所帮助哈！