feat(PageModal): 支持drawer模式

This commit is contained in:
cshaptx4869
2024-05-14 15:03:38 +08:00
parent f0b843fd3c
commit e5098decfd
3 changed files with 301 additions and 222 deletions

View File

@@ -0,0 +1,147 @@
<template>
<el-form
ref="formRef"
label-width="auto"
v-bind="form"
:model="formData"
:rules="formRules"
>
<template v-for="item in formItems" :key="item.prop">
<el-form-item v-show="!item.hidden" :label="item.label" :prop="item.prop">
<!-- Label -->
<template #label v-if="item.tips">
<span>
{{ item.label }}
<el-tooltip
placement="bottom"
effect="light"
:content="item.tips"
:raw-content="true"
>
<el-icon style="vertical-align: -0.15em" size="16">
<QuestionFilled />
</el-icon>
</el-tooltip>
</span>
</template>
<!-- Input 输入框 -->
<template v-if="item.type === 'input' || item.type === undefined">
<template v-if="item.attrs?.type === 'number'">
<el-input
v-model.number="formData[item.prop]"
v-bind="item.attrs"
/>
</template>
<template v-else>
<el-input v-model="formData[item.prop]" v-bind="item.attrs" />
</template>
</template>
<!-- Select 选择器 -->
<template v-else-if="item.type === 'select'">
<el-select v-model="formData[item.prop]" v-bind="item.attrs">
<template v-for="option in item.options" :key="option.value">
<el-option v-bind="option" />
</template>
</el-select>
</template>
<!-- Radio 单选框 -->
<template v-else-if="item.type === 'radio'">
<el-radio-group v-model="formData[item.prop]" v-bind="item.attrs">
<template v-for="option in item.options" :key="option.value">
<el-radio v-bind="option" />
</template>
</el-radio-group>
</template>
<!-- Checkbox 多选框 -->
<template v-else-if="item.type === 'checkbox'">
<el-checkbox-group v-model="formData[item.prop]" v-bind="item.attrs">
<template v-for="option in item.options" :key="option.value">
<el-checkbox v-bind="option" />
</template>
</el-checkbox-group>
</template>
<!-- Input Number 数字输入框 -->
<template v-else-if="item.type === 'input-number'">
<el-input-number v-model="formData[item.prop]" v-bind="item.attrs" />
</template>
<!-- TreeSelect 树形选择 -->
<template v-else-if="item.type === 'tree-select'">
<el-tree-select v-model="formData[item.prop]" v-bind="item.attrs" />
</template>
<!-- DatePicker 日期选择器 -->
<template v-else-if="item.type === 'date-picker'">
<el-date-picker v-model="formData[item.prop]" v-bind="item.attrs" />
</template>
<!-- 自定义 -->
<template v-else-if="item.type === 'custom'">
<slot
:name="item.slotName ?? item.prop"
:prop="item.prop"
:formData="formData"
:attrs="item.attrs"
></slot>
</template>
</el-form-item>
</template>
</el-form>
</template>
<script setup lang="ts">
import type { FormInstance, FormRules } from "element-plus";
import { reactive, ref, watch } from "vue";
import { IForm, IFormItems, IObject } from "./types";
// 定义接收的属性
const props = withDefaults(
defineProps<{
// 主键名(主要用于编辑数据,默认为id)
pk?: string;
// form组件属性
form?: IForm;
// 表单项
formItems: IFormItems;
}>(),
{
pk: "id",
}
);
const formRef = ref<FormInstance>();
const formData = reactive<IObject>({});
const formRules: FormRules = {};
// 初始化
for (const item of props.formItems) {
formData[item.prop] = item.initialValue ?? "";
formRules[item.prop] = item.rules ?? [];
if (item.watch !== undefined) {
watch(
() => formData[item.prop],
(newValue, oldValue) => {
item.watch?.(newValue, oldValue, formData);
}
);
}
}
// 获取表单数据
function getFormData(key?: string) {
return key === undefined ? formData : formData[key] ?? undefined;
}
// 设置表单值
function setFormData(data: IObject) {
for (const key in formData) {
if (Object.hasOwn(formData, key) && key in data) {
formData[key] = data[key];
}
}
if (Object.hasOwn(data, props.pk)) {
formData[props.pk] = data[props.pk];
}
}
// 设置表单项值
function setFormItemData(key: string, value: any) {
formData[key] = value;
}
// 暴露的属性和方法
defineExpose({ formRef, getFormData, setFormData, setFormItemData });
</script>

View File

@@ -1,193 +1,87 @@
<template> <template>
<el-dialog <!-- drawer -->
v-model="dialogVisible" <template v-if="props.modalConfig.component === 'drawer'">
:align-center="true" <el-drawer
:append-to-body="true" v-model="modalVisible"
width="70vw" :append-to-body="true"
v-bind="modalConfig.dialog" v-bind="modalConfig.drawer"
style="padding-right: 0" @open="handleOpenModal"
@close="closeDialog" @close="handleCloseModal"
> >
<!-- 滚动 -->
<el-scrollbar max-height="65vh">
<!-- 表单 --> <!-- 表单 -->
<el-form <page-form
ref="formRef" ref="pageFormRef"
label-width="auto" :form="modalConfig.form"
v-bind="modalConfig.form" :form-items="modalConfig.formItems"
style="padding-right: var(--el-dialog-padding-primary)" />
:model="formData" <!-- 弹窗底部操作按钮 -->
:rules="formRules" <template #footer>
> <div>
<template v-for="item in modalConfig.formItems" :key="item.prop"> <el-button type="primary" @click="handleSubmit"> </el-button>
<el-form-item <el-button @click="handleCloseModal"> </el-button>
v-show="!item.hidden" </div>
:label="item.label" </template>
:prop="item.prop" </el-drawer>
> </template>
<!-- Label --> <!-- dialog -->
<template #label v-if="item.tips"> <template v-else>
<span> <el-dialog
{{ item.label }} v-model="modalVisible"
<el-tooltip :align-center="true"
placement="bottom" :append-to-body="true"
effect="light" width="70vw"
:content="item.tips" v-bind="modalConfig.dialog"
:raw-content="true" style="padding-right: 0"
> @open="handleOpenModal"
<el-icon style="vertical-align: -0.15em" size="16"> @close="handleCloseModal"
<QuestionFilled /> >
</el-icon> <!-- 滚动 -->
</el-tooltip> <el-scrollbar max-height="65vh">
</span> <!-- 表单 -->
</template> <page-form
<!-- Input 输入框 --> ref="pageFormRef"
<template v-if="item.type === 'input' || item.type === undefined"> :form="modalConfig.form"
<template v-if="item.attrs?.type === 'number'"> :form-items="modalConfig.formItems"
<el-input style="padding-right: var(--el-dialog-padding-primary)"
v-model.number="formData[item.prop]" />
v-bind="item.attrs" </el-scrollbar>
/> <!-- 弹窗底部操作按钮 -->
</template> <template #footer>
<template v-else> <div style="padding-right: var(--el-dialog-padding-primary)">
<el-input v-model="formData[item.prop]" v-bind="item.attrs" /> <el-button type="primary" @click="handleSubmit"> </el-button>
</template> <el-button @click="handleCloseModal"> </el-button>
</template> </div>
<!-- Select 选择器 --> </template>
<template v-else-if="item.type === 'select'"> </el-dialog>
<el-select v-model="formData[item.prop]" v-bind="item.attrs"> </template>
<template v-for="option in item.options" :key="option.value">
<el-option v-bind="option" />
</template>
</el-select>
</template>
<!-- Radio 单选框 -->
<template v-else-if="item.type === 'radio'">
<el-radio-group v-model="formData[item.prop]" v-bind="item.attrs">
<template v-for="option in item.options" :key="option.value">
<el-radio v-bind="option" />
</template>
</el-radio-group>
</template>
<!-- Checkbox 多选框 -->
<template v-else-if="item.type === 'checkbox'">
<el-checkbox-group
v-model="formData[item.prop]"
v-bind="item.attrs"
>
<template v-for="option in item.options" :key="option.value">
<el-checkbox v-bind="option" />
</template>
</el-checkbox-group>
</template>
<!-- Input Number 数字输入框 -->
<template v-else-if="item.type === 'input-number'">
<el-input-number
v-model="formData[item.prop]"
v-bind="item.attrs"
/>
</template>
<!-- TreeSelect 树形选择 -->
<template v-else-if="item.type === 'tree-select'">
<el-tree-select
v-model="formData[item.prop]"
v-bind="item.attrs"
/>
</template>
<!-- DatePicker 日期选择器 -->
<template v-else-if="item.type === 'date-picker'">
<el-date-picker
v-model="formData[item.prop]"
v-bind="item.attrs"
/>
</template>
<!-- 自定义 -->
<template v-else-if="item.type === 'custom'">
<slot
:name="item.slotName ?? item.prop"
:prop="item.prop"
:formData="formData"
:attrs="item.attrs"
></slot>
</template>
</el-form-item>
</template>
</el-form>
</el-scrollbar>
<!-- 弹窗底部操作按钮 -->
<template #footer>
<div style="padding-right: var(--el-dialog-padding-primary)">
<el-button type="primary" @click="handleSubmit"> </el-button>
<el-button @click="closeDialog"> </el-button>
</div>
</template>
</el-dialog>
</template> </template>
<script setup lang="ts"> <script setup lang="ts">
import { ref, reactive, watch } from "vue";
import { useThrottleFn } from "@vueuse/core"; import { useThrottleFn } from "@vueuse/core";
import type { import { ref } from "vue";
DialogProps, import PageForm from "./Form.vue";
FormProps, import { IDialog, IDrawer, IForm, IFormItems, IObject } from "./types";
FormRules,
FormItemRule,
} from "element-plus";
// 对象类型
type IObject = Record<string, any>;
// 定义接收的属性 // 定义接收的属性
export interface IModalConfig<T = any> { export interface IModalConfig<T = any> {
// 页面名称 // 页面名称
pageName?: string; pageName?: string;
// 主键名(主要用于编辑数据,默认为id) // 主键名(主要用于编辑数据,默认为id)
pk?: string; pk?: string;
// 组件类型
component?: "dialog" | "drawer";
// dialog组件属性 // dialog组件属性
dialog?: Partial<Omit<DialogProps, "modelValue">>; dialog?: IDialog;
// drawer组件属性
drawer?: IDrawer;
// form组件属性 // form组件属性
form?: Partial<Omit<FormProps, "model" | "rules">>; form?: IForm;
// 提交的网络请求函数(需返回promise) // 表单项
formAction: (data: T) => Promise<any>; formItems: IFormItems<T>;
// 提交之前处理 // 提交之前处理
beforeSubmit?: (data: T) => void; beforeSubmit?: (data: T) => void;
// 表单项 // 提交的网络请求函数(需返回promise)
formItems: Array<{ formAction: (data: T) => Promise<any>;
// 组件类型(如input,select,radio,custom等默认input)
type?:
| "input"
| "select"
| "radio"
| "checkbox"
| "tree-select"
| "date-picker"
| "input-number"
| "custom";
// 组件属性
attrs?: IObject;
// 组件可选项(适用于select,radio,checkbox组件)
options?: Array<{
label: string;
value: any;
disabled?: boolean;
[key: string]: any;
}>;
// 插槽名(适用于组件类型为custom)
slotName?: string;
// 标签文本
label: string;
// 标签提示
tips?: string;
// 键名
prop: string;
// 验证规则
rules?: FormItemRule[];
// 初始值
initialValue?: any;
// 是否隐藏
hidden?: boolean;
// 监听函数
watch?: (newValue: any, oldValue: any, data: T) => void;
}>;
} }
const props = defineProps<{ const props = defineProps<{
modalConfig: IModalConfig; modalConfig: IModalConfig;
@@ -196,72 +90,53 @@ const props = defineProps<{
const emit = defineEmits<{ const emit = defineEmits<{
submitClick: []; submitClick: [];
}>(); }>();
// 暴露的属性和方法
defineExpose({ setModalVisible, getFormData, setFormData });
const pk = props.modalConfig.pk ?? "id"; const modalVisible = ref(false);
const dialogVisible = ref(false); const pageFormRef = ref<InstanceType<typeof PageForm>>();
const formRef = ref<InstanceType<typeof ElForm>>(); let initialFormData = {};
const formData = reactive<IObject>({});
const formRules: FormRules = {};
// 初始化
for (const item of props.modalConfig.formItems) {
formData[item.prop] = item.initialValue ?? "";
formRules[item.prop] = item.rules ?? [];
if (item.watch !== undefined) {
watch(
() => formData[item.prop],
(newValue, oldValue) => {
item.watch?.(newValue, oldValue, formData);
}
);
}
}
// 显示dialog // 显示dialog
function setModalVisible(initData: IObject = {}) { function setModalVisible(data: IObject = {}) {
dialogVisible.value = true; modalVisible.value = true;
for (const key in formData) { initialFormData = data;
if (Object.hasOwn(formData, key) && key in initData) {
formData[key] = initData[key];
}
}
if (Object.hasOwn(initData, pk)) {
formData[pk] = initData[pk];
}
} }
// 表单提交 // 表单提交
const handleSubmit = useThrottleFn(() => { const handleSubmit = useThrottleFn(() => {
formRef.value?.validate((valid: boolean) => { pageFormRef.value?.formRef?.validate((valid: boolean) => {
if (valid) { if (valid) {
const formData = pageFormRef.value?.getFormData();
if (typeof props.modalConfig.beforeSubmit === "function") { if (typeof props.modalConfig.beforeSubmit === "function") {
props.modalConfig.beforeSubmit(formData); props.modalConfig.beforeSubmit(formData);
} }
props.modalConfig.formAction(formData).then(() => { props.modalConfig.formAction(formData).then(() => {
ElMessage.success( let msg = "操作成功";
props.modalConfig.dialog?.title if (props.modalConfig.component === "drawer") {
? `${props.modalConfig.dialog.title}成功` if (props.modalConfig.drawer?.title) {
: "操作成功" msg = props.modalConfig.drawer?.title;
); }
} else {
if (props.modalConfig.dialog?.title) {
msg = props.modalConfig.dialog?.title;
}
}
ElMessage.success(msg);
emit("submitClick"); emit("submitClick");
closeDialog(); handleCloseModal();
}); });
} }
}); });
}, 3000); }, 3000);
// 打开弹窗
function handleOpenModal() {
pageFormRef.value?.setFormData(initialFormData);
}
// 关闭弹窗 // 关闭弹窗
function closeDialog() { function handleCloseModal() {
dialogVisible.value = false; modalVisible.value = false;
formRef.value?.resetFields(); pageFormRef.value?.formRef?.resetFields();
formRef.value?.clearValidate(); pageFormRef.value?.formRef?.clearValidate();
}
// 获取表单数据
function getFormData(key?: string) {
return key === undefined ? formData : formData[key] ?? undefined;
}
// 设置表单值
function setFormData(key: string, value: any) {
formData[key] = value;
} }
// 暴露的属性和方法
defineExpose({ setModalVisible });
</script> </script>
<style lang="scss" scoped></style> <style lang="scss" scoped></style>

View File

@@ -0,0 +1,57 @@
import type {
DialogProps,
DrawerProps,
FormProps,
FormItemRule,
} from "element-plus";
// dialog组件属性
export type IDialog = Partial<Omit<DialogProps, "modelValue">>;
// drawer组件属性
export type IDrawer = Partial<Omit<DrawerProps, "modelValue">>;
// form组件属性
export type IForm = Partial<Omit<FormProps, "model" | "rules">>;
// 对象类型
export type IObject = Record<string, any>;
// 表单项
export type IFormItems<T = any> = Array<{
// 组件类型(如input,select,radio,custom等默认input)
type?:
| "input"
| "select"
| "radio"
| "checkbox"
| "tree-select"
| "date-picker"
| "input-number"
| "custom";
// 组件属性
attrs?: IObject;
// 组件可选项(适用于select,radio,checkbox组件)
options?: Array<{
label: string;
value: any;
disabled?: boolean;
[key: string]: any;
}>;
// 插槽名(适用于组件类型为custom)
slotName?: string;
// 标签文本
label: string;
// 标签提示
tips?: string;
// 键名
prop: string;
// 验证规则
rules?: FormItemRule[];
// 初始值
initialValue?: any;
// 是否隐藏
hidden?: boolean;
// 监听函数
watch?: (newValue: any, oldValue: any, data: T) => void;
}>;