feat: passing all values as the second parameter when calling Field's…

… validate
jaredpalmer · Sep 12, 2023 · 5d5a5f0 · 5d5a5f0
1 parent da58b29
commit 5d5a5f0
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 10 deletions.
diff --git a/packages/formik/src/Formik.tsx b/packages/formik/src/Formik.tsx
@@ -126,7 +126,10 @@ const emptyTouched: FormikTouched<unknown> = {};
 // and their validate functions
 interface FieldRegistry {
   [field: string]: {
-    validate: (value: any) => string | Promise<string> | undefined;
+    validate: (
+      value: any,
+      values: FormikValues
+    ) => string | Promise<string> | undefined;
   };
 }
 
@@ -268,9 +271,9 @@ export function useFormik<Values extends FormikValues = FormikValues>({
   );
 
   const runSingleFieldLevelValidation = React.useCallback(
-    (field: string, value: void | string): Promise<string> => {
+    (field: string, value: void | string, values: Values): Promise<string> => {
       return new Promise(resolve =>
-        resolve(fieldRegistry.current[field].validate(value) as string)
+        resolve(fieldRegistry.current[field].validate(value, values) as string)
       );
     },
     []
@@ -286,7 +289,7 @@ export function useFormik<Values extends FormikValues = FormikValues>({
       const fieldValidations: Promise<string>[] =
         fieldKeysWithValidation.length > 0
           ? fieldKeysWithValidation.map(f =>
-              runSingleFieldLevelValidation(f, getIn(values, f))
+              runSingleFieldLevelValidation(f, getIn(values, f), values)
             )
           : [Promise.resolve('DO_NOT_DELETE_YOU_WILL_BE_FIRED')]; // use special case ;)
 
@@ -417,7 +420,12 @@ export function useFormik<Values extends FormikValues = FormikValues>({
         dispatchFn();
       }
     },
-    [props.initialErrors, props.initialStatus, props.initialTouched, props.onReset]
+    [
+      props.initialErrors,
+      props.initialStatus,
+      props.initialTouched,
+      props.onReset,
+    ]
   );
 
   React.useEffect(() => {
@@ -493,7 +501,10 @@ export function useFormik<Values extends FormikValues = FormikValues>({
       isFunction(fieldRegistry.current[name].validate)
     ) {
       const value = getIn(state.values, name);
-      const maybePromise = fieldRegistry.current[name].validate(value);
+      const maybePromise = fieldRegistry.current[name].validate(
+        value,
+        state.values
+      );
       if (isPromise(maybePromise)) {
         // Only flip isValidating if the function is async.
         dispatch({ type: 'SET_ISVALIDATING', payload: true });

diff --git a/packages/formik/src/types.tsx b/packages/formik/src/types.tsx
@@ -105,7 +105,7 @@ export interface FormikHelpers<Values> {
     field: string,
     isTouched?: boolean,
     shouldValidate?: boolean
-  ) =>  Promise<void | FormikErrors<Values>>;
+  ) => Promise<void | FormikErrors<Values>>;
   /** Validate form values */
   validateForm: (values?: any) => Promise<FormikErrors<Values>>;
   /** Validate field value */
@@ -302,9 +302,15 @@ export interface FieldMetaProps<Value> {
 /** Imperative handles to change a field's value, error and touched */
 export interface FieldHelperProps<Value> {
   /** Set the field's value */
-  setValue: (value: Value, shouldValidate?: boolean) => Promise<void | FormikErrors<Value>>;
+  setValue: (
+    value: Value,
+    shouldValidate?: boolean
+  ) => Promise<void | FormikErrors<Value>>;
   /** Set the field's touched value */
-  setTouched: (value: boolean, shouldValidate?: boolean) => Promise<void | FormikErrors<Value>>;
+  setTouched: (
+    value: boolean,
+    shouldValidate?: boolean
+  ) => Promise<void | FormikErrors<Value>>;
   /** Set the field's error value */
   setError: (value: string | undefined) => void;
 }
@@ -326,5 +332,6 @@ export interface FieldInputProps<Value> {
 }
 
 export type FieldValidator = (
-  value: any
+  value: any,
+  values: FormikValues
 ) => string | void | Promise<string | void>;