(资料图)
为什么会有这个想法
在管理后台开发过程中,涉及到太多的弹窗业务弹窗,其中最多的就是“添加XX数据”,“编辑XX数据”,“查看XX详情数据”等弹窗类型最多。【相关推荐:vuejs视频教程、web前端开发】
这些弹窗组件的代码,很多都是相同的,例如组件状态,表单组件相关的方法...
于是,我简单地对Dialog
组件进行的二次封装和hooks
,减少了一些重复的代码
要封装什么
如果是普通弹窗使用的话,直接使用el-dialog
组件已经足够了
但我还是一个比较爱折腾的人,我们先看看官方dialog
文档有什么可以添加的功能
...
大概看了一下,我打算封装一下功能
提供全屏操作按钮(右上角)默认提供“确认”,“关闭”按钮内部添加Loading
效果封装Dialog
确定了要封装的功能之后,先来一个简单的dialog
组件。
把双向绑定处理一下,这样外部就可以直接通过v-model
直接控制弹窗了。
<script setup>interface PropsType { modelValue?: boolean;}const props = withDefaults(defineProps(), { modelValue: false,});const emits = defineEmits<{ (e: "update:modelValue"): void;}>();</script>
登录后复制
header
使用el-dialog
提供的header
插槽,将全屏图表和关闭图标放置到右上角中。给el-dialog
传递show-close
属性关闭默认图标。
{{ props.title }} <script setup>import { FullScreen, Close } from "@element-plus/icons-vue";</script>
登录后复制
弹窗的标题文字内容通过props
进行传递,默认为空(""
)
<script lang="ts" setup>interface PropsType { // 忽略之前的代码 title?: string;}const props = withDefaults(defineProps(), { title: "",});</script>
登录后复制
我们看看现在头部的效果(这里没传入标题,默认为""
)
现在这个按钮只有样式效果,还没有写上对应的功能 ~
给他们先绑定上对应的事件和指令
{{ props.title }} <script setup lang="ts">import { FullScreen, Close } from "@element-plus/icons-vue";interface PropsType { title?: string; modelValue?: boolean; hiddenFullBtn?: boolean;}const props = withDefaults(defineProps(), { title: "", modelValue: false, hiddenFullBtn: false,});const emits = defineEmits<{ (e: "update:modelValue"): void; (e: "close"): void;}>();// 当前是否处于全屏状态const isFullscreen = ref(false);// 是否显示全屏效果图标const isFullScreenBtn = computed(() => { if (props.hiddenFullBtn) return false; if (attrs?.fullscreen) return false; return true;});// 开启、关闭全屏效果const handleFullscreen = () => { if (attrs?.fullscreen) return; isFullscreen.value = !isFullscreen.value;};// 关闭弹窗时向外部发送close事件const handleClose = () => { emits("close");};</script>
登录后复制
再点击下全屏图标看看效果怎么样
NICE 头部功能也就完成了
Footer
接下来,再处理下底部内容,默认提供两个按钮,分别是“确定”和“关闭”,这个名称也是可以通过props
属性修改的。
两个按钮绑定点击事件,向外发送不同的事件。
<script setup lang="ts">import { useSlots } from "vue";// 获取插槽const slots = useSlots();interface PropsType { title?: string; width?: string | number; isDraggable?: boolean; modelValue?: boolean; hiddenFullBtn?: boolean; confirmText?: string; cancelText?: string;}const props = withDefaults(defineProps(), { title: "", isDraggable: false, modelValue: false, hiddenFullBtn: false, confirmText: "确认", cancelText: "关闭",});const handleClose = () => { emits("close");};const handleConfirm = () => { emits("confirm");};</script>
登录后复制
又搞定了一部分了,就剩下Content了 ~
Content
弹窗内容通过默认插槽的方式传入进来,在外层的div
元素上添加v-loading
标签,实现加载态。
<script lang="ts" setup>interface PropsType { loading?: boolean;}const props = withDefaults(defineProps(), { loading: false,});</script>
登录后复制
试试看中间的loading
效果
剩下一些细节处理
在el-dialog
组件提供了很多个props
属性供用户选择,但我们现在封装的dialog
组件只使用到了一小部分props
属性。当用户想要使用其他的props
属性时该怎么办?
例如使用width属性时,难道要在我们封装的组件中接收props.width
再传递给
组件吗?
不不不,还有另外一种方法,还记得刚刚在做全屏操作的时候使用到的useAttrs
辅助函数吗
它可以获取当前组件传递进来的属性。有了这个方法之后,再配合并即可将外部传递进来的函数再传递到el-dialog
组件上面啦
登录后复制
在使用时,可能会给before-close
属性传递一个函数,但到了后面被内部的handleClose
方法给覆盖掉了。
解决方案是在handleClose
函数中,获取attrs.["before-close"]
属性,如果类型是函数函数,先执行它。
const handleClose = () => { if ( Reflect.has(attrs, "before-close") && typeof attrs["before-close"] === "function" ) { attrs["before-close"](); } emits("close");};
登录后复制
有关于el-dialog
组件的封装就到这里了
封装hooks
利用Vue composition Api
再封装一下在使用el-dialog
组件状态的管理hook
useDialog
简单处理显示和加载态开关的hook
import { ref } from "vue";export default function useDialog() { const visible = ref(false); const loading = ref(false); const openDialog = () => (visible.value = true); const closeDialog = () => (visible.value = false); const openLoading = () => (loading.value = true); const closeLoading = () => (loading.value = false); return { visible, loading, openDialog, closeDialog, openLoading, closeLoading, };}
登录后复制
useDialog Demo
普通弹窗 DialogCmp1
<script setup lang="ts">import useDialog from "./components/useDialog";import DialogCmp from "./components/Dialog.vue";const { visible: visible1, openDialog: openDialog1, closeDialog: closeDialog1,} = useDialog();</script>
登录后复制
useDialogState 和 useDialogWithForm
useDialogState
针对开发管理后台弹窗状态封装的一个hook
,搭配下面的useDialogWithForm
使用。
export enum MODE { ADD, EDIT,}
登录后复制
import { ref } from "vue";import { MODE } from "./types";export default function useDialogState() { const mode = ref(MODE.ADD); const visible = ref(false); const updateMode = (target: MODE) => { mode.value = target; }; return { mode, visible, updateMode };}
登录后复制
useDialogWithForm
针对表单弹窗组件封装的hooks
,接收一个formRef
实例,负责控制弹窗内标题及清空表单中的校验结果,减少多余的代码 ~
import { FormInstance } from "element-plus";import { Ref, ref } from "vue";import { MODE } from "./types";import useDialogState from "./useDialogState";export default function useDialogFn( formInstance: Ref) { const { visible, mode, updateMode } = useDialogState(); const closeDialog = () => { formInstance.value.resetFields(); visible.value = false; }; const openDialog = (target: MODE) => { updateMode(target); visible.value = true; }; return { visible, mode, openDialog, closeDialog };}
登录后复制
useDialogWithForm Demo
<script setup>import { ElMessage, FormInstance } from "element-plus";import { Ref, ref } from "vue";import Dialog from "./Dialog.vue";import { MODE } from "./types";import useDialogWithForm from "./useDialogWithForm";const rules = { name: { type: "string", required: true, pattern: /^[a-z]+$/, trigger: "change", message: "只能是英文名称哦", transform(value: string) { return value.trim(); }, }, age: { type: "string", required: true, pattern: /^[0-9]+$/, trigger: "change", message: "年龄只能是数字哦", transform(value: string) { return value.trim(); }, }, mobile: { type: "string", required: true, pattern: /^(?:(?:\+|00)86)?1(?:(?:3[\d])|(?:4[5-79])|(?:5[0-35-9])|(?:6[5-7])|(?:7[0-8])|(?:8[\d])|(?:9[189]))\d{8}$/, trigger: "change", message: "请输入正确的手机号码", transform(value: string) { return value.trim(); }, },};interface FromDataType { name: string; age: string; mobile: string;}const formDataRef = ref(null);let formData = ref({ name: "", age: "", mobile: "",});const { visible, closeDialog, openDialog, mode } = useDialogWithForm( formDataRef as Ref);const confirm = () => { if (!formDataRef.value) return; formDataRef.value.validate((valid) => { if (valid) { console.log("confirm"); ElMessage({ message: "提交成功", type: "success", }); closeDialog(); } });};const customClose = () => { ElMessage({ message: "取消提交", type: "info", }); closeDialog();};defineExpose({ closeDialog, openDialog,});</script>
登录后复制
仓库地址
useDialog
在线demo地址
如果您觉得本文对您有帮助,请帮帮忙点个star
您的反馈 是我更新的动力!
(学习视频分享:vuejs入门教程、编程基础视频)
以上就是聊聊Vue3+hook怎么写弹窗组件更快更高效的详细内容,更多请关注php中文网其它相关文章!