feat: add submitOnChange props to vben form (#5032)

pull/58/MERGE
huangxiaomin 2024-12-05 11:23:21 +08:00 committed by GitHub
parent 05b4b61c6e
commit fe236ea929
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 23 additions and 1 deletions

View File

@ -316,6 +316,7 @@ useVbenForm 返回的第二个参数,是一个对象,包含了一些表单
| commonConfig | 表单项的通用配置,每个配置都会传递到每个表单项,表单项可覆盖 | `FormCommonConfig` | - | | commonConfig | 表单项的通用配置,每个配置都会传递到每个表单项,表单项可覆盖 | `FormCommonConfig` | - |
| schema | 表单项的每一项配置 | `FormSchema` | - | | schema | 表单项的每一项配置 | `FormSchema` | - |
| submitOnEnter | 按下回车健时提交表单 | `boolean` | false | | submitOnEnter | 按下回车健时提交表单 | `boolean` | false |
| submitOnChange | 字段值改变时提交表单 | `boolean` | false |
### TS 类型说明 ### TS 类型说明

View File

@ -76,6 +76,8 @@ const formOptions: VbenFormProps = {
submitButtonOptions: { submitButtonOptions: {
content: '查询', content: '查询',
}, },
//
submitOnChange: false,
// //
submitOnEnter: false, submitOnEnter: false,
}; };

View File

@ -36,6 +36,7 @@ function getDefaultState(): VbenFormProps {
showCollapseButton: false, showCollapseButton: false,
showDefaultActions: true, showDefaultActions: true,
submitButtonOptions: {}, submitButtonOptions: {},
submitOnChange: false,
submitOnEnter: false, submitOnEnter: false,
wrapperClass: 'grid-cols-1', wrapperClass: 'grid-cols-1',
}; };

View File

@ -342,6 +342,12 @@ export interface VbenFormProps<
*/ */
submitButtonOptions?: ActionButtonOptions; submitButtonOptions?: ActionButtonOptions;
/**
*
* @default false
*/
submitOnChange?: boolean;
/** /**
* *
* @default false * @default false

View File

@ -6,7 +6,9 @@ import type { ExtendedFormApi, VbenFormProps } from './types';
import { useForwardPriorityValues } from '@vben-core/composables'; import { useForwardPriorityValues } from '@vben-core/composables';
// import { isFunction } from '@vben-core/shared/utils'; // import { isFunction } from '@vben-core/shared/utils';
import { useTemplateRef } from 'vue'; import { useTemplateRef, watch } from 'vue';
import { useDebounceFn } from '@vueuse/core';
import FormActions from './components/form-actions.vue'; import FormActions from './components/form-actions.vue';
import { import {
@ -56,6 +58,14 @@ function handleKeyDownEnter(event: KeyboardEvent) {
formActionsRef.value?.handleSubmit?.(); formActionsRef.value?.handleSubmit?.();
} }
watch(
() => form.values,
useDebounceFn(() => {
state.value.submitOnChange && props.formApi?.submitForm();
}, 300),
{ deep: true },
);
</script> </script>
<template> <template>

View File

@ -65,6 +65,8 @@ const formOptions: VbenFormProps = {
], ],
// //
showCollapseButton: true, showCollapseButton: true,
//
submitOnChange: true,
// //
submitOnEnter: false, submitOnEnter: false,
}; };