<FastField />
is meant for performance optimization. However, you really do not need to use it until you do. Only proceed if you are familiar with how React's shouldComponentUpdate()
works. You have been warned.
No. Seriously. Please review the following parts of the official React documentation before continuing
<FastField />
is an optimized version of <Field />
meant to be used on large forms (~30+ fields) or when a field has very expensive validation requirements. <FastField />
has the same exact API as <Field>
, but implements shouldComponentUpdate()
internally to block all additional re-renders unless there are direct updates to the <FastField />
's relevant parts/slice of Formik state.
For example, <FastField name="firstName" />
will only re-render when there are:
values.firstName
, errors.firstName
, touched.firstName
, or isSubmitting
. This is determined by shallow comparison. Note: dotpaths are supported.<FastField name="firstName" />
name
prop changesOther than for these aforementioned situations, <FastField />
will not re-render when other parts of Formik state change. However, all updates triggered by a <FastField />
will trigger re-renders to other "vanilla" <Field />
components.
<FastField />
If a <Field />
is "independent" of all other <Field />
's in your form, then you can use <FastField />
.
More specifically, if the <Field />
does not change behavior or render anything that is based on updates to another <Field />
or <FastField />
's slice of Formik state AND it does not rely on other parts of top-level <Formik />
state (e.g. isValidating
, submitCount
), then you can use <FastField />
as a drop-in replacement to <Field />
.
import React from 'react';import { Formik, Field, FastField, Form } from 'formik';import * as Yup from 'yup';const Basic = () => (<div><h1>Sign Up</h1><FormikinitialValues={{firstName: '',lastName: '',email: '',}}validationSchema={Yup.object().shape({firstName: Yup.string().required(),middleInitial: Yup.string(),lastName: Yup.string().required(),email: Yup.string().email().required(),})}onSubmit={values => {setTimeout(() => {alert(JSON.stringify(values, null, 2));}, 500);}}>{formikProps => (<Form>{/** This <FastField> only updates for changes made tovalues.firstName, touched.firstName, errors.firstName */}<label htmlFor="firstName">First Name</label><FastField name="firstName" placeholder="Weezy" />{/** Updates for all changes because it's from thetop-level formikProps which get all updates */}{formikProps.touched.firstName && formikProps.errors.firstName && (<div>{formikProps.errors.firstName}</div>)}<label htmlFor="middleInitial">Middle Initial</label><FastField name="middleInitial" placeholder="F">{({ field, form, meta }) => (<div><input {...field} />{/*** This updates normally because it's from the same slice of Formik state,* i.e. path to the object matches the name of this <FastField />*/}{meta.touched ? meta.error : null}{/** This won't ever update since it's coming fromfrom another <Field>/<FastField>'s (i.e. firstName's) slice */}{form.touched.firstName && form.errors.firstName? form.errors.firstName: null}{/* This doesn't update either */}{form.submitCount}{/* Imperative methods still work as expected */}<buttontype="button"onClick={form.setFieldValue('middleInitial', 'J')}>J</button></div>)}</FastField>{/** Updates for all changes to Formik stateand all changes by all <Field>s and <FastField>s */}<label htmlFor="lastName">LastName</label><Field name="lastName" placeholder="Baby">{({ field, form, meta }) => (<div><input {...field} />{/** Works because this is insideof a <Field/>, which gets all updates */}{form.touched.firstName && form.errors.firstName? form.errors.firstName: null}</div>)}</Field>{/** Updates for all changes to Formik state andall changes by all <Field>s and <FastField>s */}<label htmlFor="email">Email</label><Field name="email" placeholder="jane@acme.com" type="email" /><button type="submit">Submit</button></Form>)}</Formik></div>);
The latest Formik news, articles, and resources, sent to your inbox.