Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(useForm): Set errors only for touched fields on 'blur' validation mode #31

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 44 additions & 4 deletions packages/core/src/composables/useForm.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import deepmerge from 'deepmerge';
import isEqual from 'fast-deep-equal/es6';
import { klona as deepClone } from 'klona/full';
import { computed, onMounted, provide, reactive, ref } from 'vue';
import { computed, onMounted, provide, reactive, ref, unref } from 'vue';

import toValue from './toValue';
import { FormContextKey } from './useFormContext';
Expand Down Expand Up @@ -49,6 +49,10 @@ interface FieldArrayRegistry {
};
}

interface ValidateHandlerOptions {
onlyBlurred?: boolean;
}

export interface FormSubmitHelper<Values extends FormValues> {
setSubmitting: (isSubmitting: boolean) => void;
readonly initialValues: Values;
Expand Down Expand Up @@ -262,7 +266,7 @@ export function useForm<
});

return validateTiming.value === 'blur'
? runAllValidateHandler(state.values)
? runAllValidateHandler(state.values, { onlyBlurred: true })
: Promise.resolve();
};

Expand Down Expand Up @@ -503,20 +507,56 @@ export function useForm<
});
};

const runAllValidateHandler = (values: Values = state.values) => {
/**
* Creates a new object of errors, but only with the errors of touched fields.
*
* @param errors The union of field and form errors
* @returns The field errors that have been touched
*/
const getTouchedErrors = <
T extends FormErrors<Values>,
F extends FormTouched<Values>,
>(
errors: T,
touched: F,
): Partial<T> => {
const result: any = {};

for (const key in errors) {
if (typeof touched[key] === 'object' && typeof errors[key] === 'object') {
result[key] = getTouchedErrors(
errors[key] as FormErrors<Values>,
touched[key] as FormTouched<Values>,
);
} else if (touched[key] === true && errors[key]) {
result[key] = errors[key];
}
}

return result;
};

const runAllValidateHandler = (
values: Values = state.values,
validateOptions?: ValidateHandlerOptions,
) => {
dispatch({ type: ACTION_TYPE.SET_ISVALIDATING, payload: true });
return Promise.all([
runFieldValidateHandler(values),
options.validate ? runValidateHandler(values) : {},
])
.then(([fieldErrors, validateErrors]) => {
const errors = deepmerge.all<FormErrors<Values>>(
const baseErrors = deepmerge.all<FormErrors<Values>>(
[fieldErrors, validateErrors],
{
arrayMerge,
},
);

const errors = validateOptions?.onlyBlurred
? getTouchedErrors(baseErrors, unref(state.touched))
: baseErrors;

setErrors(errors);

return errors;
Expand Down