* feat(@vben-core/form-ui): add typed form value codecs * test(@vben-core/form-ui): cover codec value boundaries * refactor(project): propagate form codec generics * feat(@vben/plugins): propagate form codecs through vxe grids * refactor(@vben/playground): migrate form codec examples * refactor(@vben/playground): migrate query forms to codecs * docs(@vben/docs): document form value codecs
69 lines
1.9 KiB
TypeScript
69 lines
1.9 KiB
TypeScript
import type {
|
|
VbenFormProps as FormProps,
|
|
VbenFormSchema as FormSchema,
|
|
FormValues,
|
|
} from '@vben/common-ui';
|
|
|
|
import type { ComponentPropsMap, ComponentType } from './component';
|
|
|
|
import { setupVbenForm, useVbenForm as useForm, z } from '@vben/common-ui';
|
|
import { $t } from '@vben/locales';
|
|
|
|
async function initSetupVbenForm() {
|
|
setupVbenForm<ComponentType>({
|
|
config: {
|
|
// ant design vue组件库默认都是 v-model:value
|
|
baseModelPropName: 'value',
|
|
|
|
// 一些组件是 v-model:checked 或者 v-model:fileList
|
|
modelPropNameMap: {
|
|
Checkbox: 'checked',
|
|
Radio: 'checked',
|
|
Switch: 'checked',
|
|
Upload: 'fileList',
|
|
},
|
|
},
|
|
rules: {
|
|
// 输入项目必填国际化适配
|
|
required: (value, _params, ctx) => {
|
|
if (value === undefined || value === null || value.length === 0) {
|
|
return $t('ui.formRules.required', [ctx.label]);
|
|
}
|
|
return true;
|
|
},
|
|
// 选择项目必填国际化适配
|
|
selectRequired: (value, _params, ctx) => {
|
|
if (value === undefined || value === null) {
|
|
return $t('ui.formRules.selectRequired', [ctx.label]);
|
|
}
|
|
return true;
|
|
},
|
|
},
|
|
});
|
|
}
|
|
|
|
function useVbenForm<
|
|
TFormValues extends FormValues = FormValues,
|
|
TSubmitValues extends FormValues = TFormValues,
|
|
>(
|
|
options: FormProps<
|
|
ComponentType,
|
|
ComponentPropsMap,
|
|
TFormValues,
|
|
TSubmitValues
|
|
>,
|
|
) {
|
|
return useForm<TFormValues, ComponentType, ComponentPropsMap, TSubmitValues>(
|
|
options,
|
|
);
|
|
}
|
|
|
|
export { initSetupVbenForm, useVbenForm, z };
|
|
|
|
export type VbenFormSchema<TValues extends FormValues = FormValues> =
|
|
FormSchema<ComponentType, ComponentPropsMap, TValues>;
|
|
export type VbenFormProps<
|
|
TFormValues extends FormValues = FormValues,
|
|
TSubmitValues extends FormValues = TFormValues,
|
|
> = FormProps<ComponentType, ComponentPropsMap, TFormValues, TSubmitValues>;
|