React formik form validation: How to initially have submit button disabled

Question

Below is my React form validation code in which I am using formik. By default when the form loads, I want to keep the submit button disabled:

import { useFormik } from "formik";
import * as Yup from "yup";

const formik = useFormik({
    initialValues: {
      firstName: "",
      lastName: "",
      email: ""
    },
    validationSchema: Yup.object({
      firstName: Yup.string()
        .max(15, "Must be 15 characters or less")
        .min(3, "Must be at least 3 characters")
        .required("Required"),
      lastName: Yup.string()
        .min(3, "Must be at least 3 characters")
        .max(20, "Must be 20 characters or less")
        .required("Required"),
      email: Yup.string()
        .email("Invalid email address")
        .required("Required")
    }),
    onSubmit: values => {
      handleSubmit(values);
    }
  });

I have tried to use this on my button:

 disabled={!formik.isValid}

But it only actually works if I try to submit the form. So, if I leave the form blank and hit submit, all the validation errors show up and then the button is disabled. But, it should be disabled already from the start. I checked the documentation but didn't see anything obvious there.

Rahul Gupta · Accepted Answer · 2020-01-21T04:39:20.897

116

If you want to keep the submit button disabled initially when the form loads, you can use the use the dirty : boolean property of Formik something as below:

disabled={!formik.dirty}

If you want to keep the submit button disabled until all the field values are valid then you can use isValid: boolean which works as below:

Returns true if there are no errors (i.e. the errors object is empty) and false otherwise.

So you may use it as:

disabled={!formik.isValid}

Now, if you want the submit button to be disabled until all the fields are valid and if the fields values have been changed from their initial values then you would have to use both of the above attributes in conjunction as below:

disabled={!(formik.isValid && formik.dirty)}

edited Jan 21 '20 at 04:39

answered Jan 10 '20 at 06:50

Rahul Gupta

9,775
7
56
69

Thanks, this almost works, but not quite. When the page first loads the button is disabled. However, as soon as one text field is correct the button is enabled. This should only happen once all fields are filled in correctly. – user8463989 Jan 14 '20 at 18:11
I have edited my answer and added some more useful code. Please let me know if this works and please consider accepting my answer if it has helped you :) – Rahul Gupta Jan 21 '20 at 04:40
2

If there is some initial value that is valid, button will never be enabled. – Sasha Omelchenko Jul 23 '20 at 09:59
As @SashaOmelchenko pointed out, this does not validate initialValues. Use `validateOnMount` with `isValid` instead. See https://stackoverflow.com/a/61896771/1631828 – cgat May 21 '21 at 15:58
I do exactly like this, but isValid toggles true/false literally after every type of keyboard. Does anybody face this problem too? – Tigran Petrosyan Oct 09 '21 at 18:46
Don't use `dirty`, you'll run into problems if you need to have a default value set. Suppose you want 4 as default value for a rating and user also want to select 4. As per formik, its valid but not dirty `!(true & false)` hence making `disable={true}` – Ankur Parihar Feb 08 '22 at 12:25
My company uses old syntax so I had to insert the attributes before the return statement for the Form. Now it works. Example: ```{({isValid, isSubmitting, dirty})} => {
```
– Evan Erickson Jan 18 '23 at 00:55

score 14 · Answer 2 · edited Sep 27 '20 at 14:15

14

To have the button initially disabled just check if the touch object is empty and keep it this way until all the fields are validated with !isValid

disabled={!isValid || (Object.keys(touched).length === 0 && touched.constructor === Object)}

edited Sep 27 '20 at 14:15

David Buck

3,752
35
31
35

answered Sep 27 '20 at 13:31

kvba

309
3
8

Both this and the accepted answer are great solutions. I'd like to mention that you should also include `isSubmitting` to also disable button clicks during submission. `disabled={!isValid || isSubmitting || (Object.keys(touched).length === 0 && touched.constructor === Object)}` – Sam T Aug 24 '22 at 15:04

Paul Taiwo · Answer 3 · 2023-04-17T08:55:13.447

You can add validateOnMount and set it to true

const formik = useFormik({
    validateOnMount: true, // <================= Add this
    initialValues: {
      firstName: "",
      lastName: "",
      email: ""
    },
    validationSchema: Yup.object({
      firstName: Yup.string()
        .max(15, "Must be 15 characters or less")
        .min(3, "Must be at least 3 characters")
        .required("Required"),
      lastName: Yup.string()
        .min(3, "Must be at least 3 characters")
        .max(20, "Must be 20 characters or less")
        .required("Required"),
      email: Yup.string()
        .email("Invalid email address")
        .required("Required")
    }),
    onSubmit: values => {
      handleSubmit(values);
    }
  });

Use on button

disabled={!formik.isValid}

score 3 · Answer 4 · answered Dec 27 '19 at 12:27

Formik keeps track of field values and errors however exposes them for your use, this used to be done via formProps using the render props pattern however now seems to be part of the formik variable returned by the useFormik hook.

I would recomend to start by removing the initial values to a constant. Then you need to access the formik's error object. I have not done this using the new hook syntax, however, looking at the docs I would expect "formik.errors" to work (this is exposed in formProps.errors using render props). Finally the submit buttion disabled should be a check that either formik.values is equal to the initial values OR the errors object is not empty.

score 0 · Answer 5 · answered Dec 22 '21 at 12:26

I'm using

"formik": "^2.2.6"

and in my case I did it like this. I was not interested to show the messages in the validation messages in initial so I did in this way.

I'm using class based components

<Formik
......
validateOnBlur={true}
validateOnChange={true}

{({handleChange, values, touched, errors, handleBlur }) => (<>
    ..........
    <Form.Control
        placeholder="Name"
        type="text"
        name="field_dba"
        value={values.name}
        onChange={handleChange}
        onFocus={handleBlur} // It plays a role to change the touched property 
        isInvalid={touched.name && !!errors.name}
        isValid={!errors.name}
        className="form-input"
    />
    <label className="modal-lab">Name *</label>
    // Here i'm checking the field is touched or not 
    {touched.name ? <Form.Control.Feedback type="invalid" className="text-capitalize"> {errors.name} </Form.Control.Feedback> : null}

at the end for disabling the button till it's all validated. I'm using this

<button disabled={Array.isArray(errors) || Object.values(errors).toString() != ""} type="submit"> Submit </button>

If this will work with same version please do a upvote.

React formik form validation: How to initially have submit button disabled

5 Answers5

Linked