基于 Vben Admin 的 FormModal 【表单弹窗】 组件封装实践 (二:组件实现——vue篇)

基于 Vben Admin 的 FormModal 组件封装实践(二:组件实现——vue篇)


前言

上一篇文章中介绍了表单弹窗的用法与优点,现在开始讲实现。

ps:本来想一篇文章写完实现的,但似乎有点长,那么再拆成vue和hook两个部分吧。


正文

先简单回顾一下我们的需求

  1. 将表单和弹窗合二为一作为一个组件去管理
  2. 将常用事件封装在组件内

表单部分

  1. 先按项目的需求,配置好一个基础的表单。
const [Form, formApi] = useVbenForm({
   
   
  commonConfig: {
   
   
    colon: true,
    formItemClass: 'col-span-2 md:col-span-1',
    labelClass: 'justify-start',
    labelWidth: 100,
  },
  schema: schemaData as unknown as VbenFormSchema[],
  showDefaultActions: false,
  wrapperClass: 'grid-cols-2 gap-x-4',
});

const breakpoints = useBreakpoints(breakpointsTailwind);
const isHorizontal = computed(() => breakpoints.greaterOrEqual('md').value);
const formLayout = computed(() => {
   
   
  const {
   
    formConfig } = innerProps.value;
  if (formConfig && formConfig.layout) return formConfig.layout;
  return isHorizontal.value ? 'horizontal' : 'vertical';
});


<Form :class="[innerProps.formClass ?? '']" :layout="formLayout">...</Form>
  1. 允许通过参数控制表单的配置
const schemaData = ref<VbenFormSchema[]>();
function setProps(props: Partial<FormModalProps&g
### Vben Admin v5 中嵌套子表单实现方式 #### 背景介绍 Vben Admin 是一款基于 Vue3 和 TypeScript 构建的企业级管理后台框架,提供了丰富的功能模块和组件支持。其中,`form-design` 模块用于动态表单设计[^2],而嵌套子表单则是复杂业务场景下的常见需求。 为了实现Vben Admin v5 中的嵌套子表单功能,可以利用其内置的 `FormSchema` 定义机制以及动态渲染能力来完成复杂的表单结构定义。 --- #### 解决方案概述 以下是实现嵌套子表单的主要方法: 1. **使用 FormItem 组件** 利用 Vben Admin 提供的 `FormItem` 来定义父表单和子表单的关系。 2. **动态加载子表单数据** 子表单可以通过 JSON Schema 或者动态 API 请求的方式获取字段配置并渲染。 3. **绑定父子关系的数据模型** 使用 Vue 的响应式特性,将父表单中的某个字段作为数组类型,存储多个子表单项的数据。 4. **自定义校验逻辑** 对于嵌套子表单,需确保每个子项都能独立验证,并最终汇总到整个表单的提交状态中。 --- #### 示例代码 以下是一个完整的嵌套子表单实现示例: ```typescript // 导入必要的组件和工具函数 import { useForm } from '@vben/use'; import { FormSchema } from '@/components/Form'; const parentSchemas: FormSchema[] = [ { field: 'parentField', component: 'Input', label: 'Parent Field', colProps: { span: 24 }, }, { field: 'childrenFields', component: 'ArrayItems', // 自定义 Array Items 渲染器 label: 'Children Fields', colProps: { span: 24 }, itemRender: ({ schema }) => ({ schemas: [ { field: 'childName', component: 'Input', label: 'Child Name', }, { field: 'childAge', component: 'InputNumber', label: 'Child Age', }, ], }), }, ]; export function useNestedForm() { const [register, methods] = useForm({ layout: 'vertical', schemas: parentSchemas, actionColOptions: { span: 24, }, }); return { register, ...methods }; } ``` --- #### 关键点解析 1. **动态子表单渲染** 在上面的例子中,`itemRender` 方法被用来定义如何渲染每一个子表单项。它返回一个新的 `schemas` 数组,描述了子表单的具体字段结构。 2. **数据绑定** 父表单中的 `childrenFields` 字段应设置为数组类型,以便能够容纳多个子表单项的数据。当用户新增或删除子项时,该数组会自动更新。 3. **校验规则** 可以为每个子表单项单独指定校验规则,例如: ```typescript { field: 'childAge', component: 'InputNumber', label: 'Child Age', rules: [{ required: true, message: 'Please enter the age' }], } ``` 4. **样式调整** 如果默认的布局不符合需求,可以在 `colProps` 或其他属性中进一步定制样式[^2]。 --- #### 动态交互处理 对于更复杂的场景,比如通过按钮触发新增/删除操作,可以扩展如下逻辑: ```html <template> <BasicForm @register="register"> <!-- 新增按钮 --> <a-button type="primary" @click="addNewItem">Add Child</a-button> <!-- 删除按钮 (假设当前选中索引存放在 selectedChildIndex) --> <a-button danger @click="removeSelectedItem">Remove Selected</a-button> </BasicForm> </template> <script lang="ts"> import { ref } from 'vue'; export default { setup() { const addNewItem = () => { methods.appendSchemaToField( { field: `newChild${Math.random().toString(36).substr(2, 8)}`, component: 'Input', label: 'New Child', }, 'childrenFields' ); }; const removeSelectedItem = () => { const index = selectedChildIndex.value; if (index !== undefined && index >= 0) { methods.removeSchemaByFiled(`childrenFields.${index}`); } }; return { addNewItem, removeSelectedItem }; }, }; </script> ``` --- #### 总结 以上展示了在 Vben Admin v5 中实现嵌套子表单的核心思路和技术细节。通过合理运用 `FormSchema`、动态渲染能力和 Vue 的响应式特性,可以灵活应对各种复杂的表单需求。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值