Feat: Improve onReset to get the new values provided by resetForm

.changeset/afraid-garlics-destroy.md

@@ -0,0 +1,5 @@
+---
+'formik': major
+---
+
+Feat: Improve onReset to get the new values provided by resetForm

docs/api/formik.md

@@ -380,10 +380,10 @@ an input from uncontrolled to controlled.
 Note: `initialValues` not available to the higher-order component, use
 `mapPropsToValues` instead.
 
-### `onReset?: (values: Values, formikBag: FormikBag) => void`
+### `onReset?: (values: Values, formikBag: FormikBag, initialValues: Values) => void`
 
 Your optional form reset handler. It is passed your forms `values` and the
-"FormikBag".
+"FormikBag" and the `initialValues`.
 
 ### `onSubmit: (values: Values, formikBag: FormikBag) => void | Promise<any>`
 

packages/formik/src/Formik.tsx

@@ -406,7 +406,8 @@ export function useFormik<Values extends FormikValues = FormikValues>({
       if (props.onReset) {
         const maybePromisedOnReset = (props.onReset as any)(
           state.values,
-          imperativeMethods
+          imperativeMethods,
+          values
         );
 
         if (isPromise(maybePromisedOnReset)) {

packages/formik/src/types.tsx

@@ -214,7 +214,7 @@ export interface FormikConfig<Values> extends FormikSharedConfig {
   /**
    * Reset handler
    */
-  onReset?: (values: Values, formikHelpers: FormikHelpers<Values>) => void;
+  onReset?: (values: Values, formikHelpers: FormikHelpers<Values>, initialValues?: Values) => void;
 
   /**
    * Submission handler

packages/formik/test/Formik.test.tsx

@@ -1009,7 +1009,39 @@ describe('<Formik>', () => {
           setSubmitting: expect.any(Function),
           setTouched: expect.any(Function),
           setValues: expect.any(Function),
-        })
+        }),
+        InitialValues
+      );
+    });
+
+    it('should call onReset with values and actions and initialValues when form is reset with values', () => {
+      const onReset = jest.fn();
+      const { getProps } = renderFormik({
+        initialValues: InitialValues,
+        onSubmit: noop,
+        onReset,
+      });
+
+      const NewInitialValues = { name: 'jared', age: 31,}
+
+      act(() => {
+        getProps().resetForm({values: NewInitialValues});
+      });
+
+      expect(onReset).toHaveBeenCalledWith(
+        InitialValues,
+        expect.objectContaining({
+          resetForm: expect.any(Function),
+          setErrors: expect.any(Function),
+          setFieldError: expect.any(Function),
+          setFieldTouched: expect.any(Function),
+          setFieldValue: expect.any(Function),
+          setStatus: expect.any(Function),
+          setSubmitting: expect.any(Function),
+          setTouched: expect.any(Function),
+          setValues: expect.any(Function),
+        }),
+        NewInitialValues
       );
     });