Browse Source

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

pull/5045/head
huangxiaomin 1 year ago
committed by GitHub
parent
commit
fe236ea929
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 1
      docs/src/components/common-ui/vben-form.md
  2. 2
      docs/src/demos/vben-vxe-table/form/index.vue
  3. 1
      packages/@core/ui-kit/form-ui/src/form-api.ts
  4. 6
      packages/@core/ui-kit/form-ui/src/types.ts
  5. 12
      packages/@core/ui-kit/form-ui/src/vben-use-form.vue
  6. 2
      playground/src/views/examples/vxe-table/form.vue

1
docs/src/components/common-ui/vben-form.md

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

2
docs/src/demos/vben-vxe-table/form/index.vue

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

1
packages/@core/ui-kit/form-ui/src/form-api.ts

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

6
packages/@core/ui-kit/form-ui/src/types.ts

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

12
packages/@core/ui-kit/form-ui/src/vben-use-form.vue

@ -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>

2
playground/src/views/examples/vxe-table/form.vue

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

Loading…
Cancel
Save