vbenjs / vue-vben-admin

A modern vue admin panel built with Vue3, Shadcn UI, Vite, TypeScript, and Monorepo. It's fast!
https://www.vben.pro
MIT License
25.54k stars 6.96k forks source link

Bug: form在弹窗中使用时无法正确触发校验 #4837

Closed RanMaoting closed 2 weeks ago

RanMaoting commented 2 weeks ago

Version

Vben Admin V5

Describe the bug?

image 直接使用表单内部的提交按钮时会先触发校验,校验不通过时不会提交表单,这个表现是符合预期的 image 但是在使用弹窗时,如果使用formApi.submitForm来触发表单的提交行为则不管校验是否通过都会导致提交表单

Reproduction

/

System Info

/

Relevant log output

No response

Validations

youtao531 commented 2 weeks ago

贴代码,应该是写错了。我这边是可以正常校验的。

RanMaoting commented 2 weeks ago
<script lang="ts" setup>
import { useVbenModal } from '@vben/common-ui';

import { useVbenForm } from '#/adapter/form';

defineOptions({
  name: 'FormModelDemo',
});

function onSubmit(values: Record<string, any>) {
  console.log(values);
}

const [Form, formApi] = useVbenForm({
  handleSubmit: onSubmit,
  schema: [
    {
      component: 'Input',
      componentProps: {
        placeholder: '请输入',
      },
      fieldName: 'field1',
      label: '字段1',
      rules: 'required',
    },
    {
      component: 'Input',
      componentProps: {
        placeholder: '请输入',
      },
      fieldName: 'field2',
      label: '字段2',
      rules: 'required',
    },
    {
      component: 'Select',
      componentProps: {
        options: [
          { label: '选项1', value: '1' },
          { label: '选项2', value: '2' },
        ],
        placeholder: '请输入',
      },
      fieldName: 'field3',
      label: '字段3',
      rules: 'required',
    },
  ],
  showDefaultActions: false,
});

const [Modal, modalApi] = useVbenModal({
  fullscreenButton: false,
  onCancel() {
    modalApi.close();
  },
  onConfirm: async () => {
    await formApi.submitForm();
  },
  onOpenChange(isOpen: boolean) {
    if (isOpen) {
      const { values } = modalApi.getData<Record<string, any>>();
      if (values) {
        formApi.setValues(values);
      }
    }
  },
  title: '内嵌表单示例',
});
</script>
<template>
  <Modal>
    <Form />
  </Modal>
</template>

直接使用演示环境的代码,点击确认按钮,查看log输出,可以看到校验未通过,但是函数被执行了 image image

youtao531 commented 2 weeks ago

我的方法是在 onSubmit 方法内添加以下校验:

 const validateResult = await formApi.validate(values);
  if (!validateResult.valid) {
    return;
  }

成功后在最后位置关闭弹窗 modalApi.close();

RanMaoting commented 2 weeks ago

这样做是可以做到,但是行为和直接使用表单里面的按钮就不一致, 而且submitForm在内部也进行了校验, 感觉没必要进行多次校验, 或许在submitForm可以加一个参数来控制是否进行校验,当然 一切以作者为准:)

anncwb commented 2 weeks ago

新增了一个 validateAndSubmitForm函数,拉取最新代码即可。