useFormikContext()

useFormikContext() is a custom React hook that will return all Formik state and helpers via React Context.

Example

Here's an example of a form that works similarly to Stripe's 2-factor verification form. As soon as you type a 6 digit number, the form will automatically submit (i.e. no enter keypress is needed).

1 import React from 'react';
2 import { useFormikContext, Formik, Form, Field } from 'formik';
3 
4 const AutoSubmitToken = () => {
5   // Grab values and submitForm from context
6   const { values, submitForm } = useFormikContext();
7   React.useEffect(() => {
8     // Submit the form imperatively as an effect as soon as form values.token are 6 digits long
9     if (values.token.length === 6) {
10       submitForm();
11     }
12   }, [values, submitForm]);
13   return null;
14 };
15 
16 const TwoFactorVerificationForm = () => (
17   <div>
18     <h1>2-step Verification</h1>
19     <p>Please enter the 6 digit code sent to your device</p>
20     <Formik
21       initialValues={{ token: '' }}
22       validate={values => {
23         const errors = {};
24         if (values.token.length < 5) {
25           errors.token = 'Invalid code. Too short.'
26         }
27         return errors
28       }}
29       onSubmit={(values, actions) => {
30         setTimeout(() => {
31           alert(JSON.stringify(values, null, 2));
32           actions.setSubmitting(false);
33         }, 1000);
34       }}
35     >
36         <Form>
37           <Field name="token" type="tel" />
38           <AutoSubmitToken />
39         </Form>
40     </Formik>
41   </div>
42 );

Reference

useFormikContext(): FormikProps<Values>

A custom React Hook that returns Formik states and helpers via React Context. Thus, this hook will only work if there is a parent Formik React Context from which it can pull from. If called without a parent context (i.e. a descendent of a <Formik> component or withFormik higher-order component), you will get a warning in your console.