基於Vue3.0開發PC桌面端自定義對話方塊元件V3Layer。
前兩天有分享一個vue3.0移動端彈出層元件，今天分享的是最新開發的vue3.0版pc端彈窗元件。
V3Layer 一款使用vue3.0開發的多功能PC網頁端自定義彈窗元件。擁有超過10+種彈窗型別、30+種引數配置，支援拖拽(自定義拖拽區域)、縮放、最大化、全屏及自定義置頂層疊等功能。
v3layer的開發靈感同樣來自之前v2版本，在功能效果上和之前的保持同步一致性。
◆ 引入元件
// 在main.js中全域性引入元件 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>
- 函式式寫法
v3layer支援30+種引數靈活配置，當彈窗型別為 message | notify | popover 呼叫如下：
v3layer.message({...}) v3layer.notify({...}) v3layer.popover({...})
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}, ] });
大家都知道vue2中可以通過 prototype 原型鏈來實現全域性函式。那麼vue3中如何實現全域性方法呢？
其實vue3中也提供了兩種掛載全域性方法。 app.config.globalProperties 或 app.provide
- 通過 app.config.globalProperties.$v3layer = V3Layer 方式
// vue2中呼叫 methods: { showDialog() { this.$v3layer({...}) } } // vue3中呼叫 setup() { // 獲取上下文 const { ctx } = getCurrentInstance() ctx.$v3layer({...}) }
- 通過 app.provide('v3layer', V3Layer) 方式
// vue2中呼叫 methods: { showDialog() { this.v3layer({...}) } } // vue3中呼叫 setup() { const v3layer = inject('v3layer') const showDialog = () => { v3layer({...}) } return { v3layer, showDialog } }
大家可以根據喜好，選擇一種方式即可。
◆ 預覽圖
◆ 編碼實現
- v3layer預設配置引數
支援如下引數靈活使用，實現個性化彈窗效果。
|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>
/** * @Desc Vue3.0桌面端彈窗元件V3Layer * @Time andy by 2021-1 * @About Q：282310962 wx：xy190310 */ <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>
大家可以看到在vue3中的寫法和vue2中不一樣了，很多都是在setup中處理，最後return出去，不過之前的vue2 optionsAPI寫法仍然可用。
v3layer元件支援自定義拖拽區域 (drag:'#xxx')，是否拖動到視窗外 (dragOut:true)。還支援iframe彈窗型別 (type:'iframe')。
當配置 topmost:true 當前活動視窗會保持置頂狀態。
Okey，基於Vue3開發自定義彈窗元件就分享到這裡。希望對大家有所幫助哈！✍
最後附上一個Nuxt.js例項專案
Nuxt.js+Vue 手機端聊天：https://www.cnblogs.com/xiaoyan2017/p/13823195.html
