feat: add submitOnChange props to vben form (#5032)
							parent
							
								
									05b4b61c6e
								
							
						
					
					
						commit
						fe236ea929
					
				| 
						 | 
				
			
			@ -316,6 +316,7 @@ useVbenForm 返回的第二个参数,是一个对象,包含了一些表单
 | 
			
		|||
| commonConfig | 表单项的通用配置,每个配置都会传递到每个表单项,表单项可覆盖 | `FormCommonConfig` | - |
 | 
			
		||||
| schema | 表单项的每一项配置 | `FormSchema` | - |
 | 
			
		||||
| submitOnEnter | 按下回车健时提交表单 | `boolean` | false |
 | 
			
		||||
| submitOnChange | 字段值改变时提交表单 | `boolean` | false |
 | 
			
		||||
 | 
			
		||||
### TS 类型说明
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -76,6 +76,8 @@ const formOptions: VbenFormProps = {
 | 
			
		|||
  submitButtonOptions: {
 | 
			
		||||
    content: '查询',
 | 
			
		||||
  },
 | 
			
		||||
  // 是否在字段值改变时提交表单
 | 
			
		||||
  submitOnChange: false,
 | 
			
		||||
  // 按下回车时是否提交表单
 | 
			
		||||
  submitOnEnter: false,
 | 
			
		||||
};
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -36,6 +36,7 @@ function getDefaultState(): VbenFormProps {
 | 
			
		|||
    showCollapseButton: false,
 | 
			
		||||
    showDefaultActions: true,
 | 
			
		||||
    submitButtonOptions: {},
 | 
			
		||||
    submitOnChange: false,
 | 
			
		||||
    submitOnEnter: false,
 | 
			
		||||
    wrapperClass: 'grid-cols-1',
 | 
			
		||||
  };
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -342,6 +342,12 @@ export interface VbenFormProps<
 | 
			
		|||
   */
 | 
			
		||||
  submitButtonOptions?: ActionButtonOptions;
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * 是否在字段值改变时提交表单
 | 
			
		||||
   * @default false
 | 
			
		||||
   */
 | 
			
		||||
  submitOnChange?: boolean;
 | 
			
		||||
 | 
			
		||||
  /**
 | 
			
		||||
   * 是否在回车时提交表单
 | 
			
		||||
   * @default false
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -6,7 +6,9 @@ import type { ExtendedFormApi, VbenFormProps } from './types';
 | 
			
		|||
import { useForwardPriorityValues } from '@vben-core/composables';
 | 
			
		||||
// 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 {
 | 
			
		||||
| 
						 | 
				
			
			@ -56,6 +58,14 @@ function handleKeyDownEnter(event: KeyboardEvent) {
 | 
			
		|||
 | 
			
		||||
  formActionsRef.value?.handleSubmit?.();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
watch(
 | 
			
		||||
  () => form.values,
 | 
			
		||||
  useDebounceFn(() => {
 | 
			
		||||
    state.value.submitOnChange && props.formApi?.submitForm();
 | 
			
		||||
  }, 300),
 | 
			
		||||
  { deep: true },
 | 
			
		||||
);
 | 
			
		||||
</script>
 | 
			
		||||
 | 
			
		||||
<template>
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -65,6 +65,8 @@ const formOptions: VbenFormProps = {
 | 
			
		|||
  ],
 | 
			
		||||
  // 控制表单是否显示折叠按钮
 | 
			
		||||
  showCollapseButton: true,
 | 
			
		||||
  // 是否在字段值改变时提交表单
 | 
			
		||||
  submitOnChange: true,
 | 
			
		||||
  // 按下回车时是否提交表单
 | 
			
		||||
  submitOnEnter: false,
 | 
			
		||||
};
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
		Reference in New Issue