Use React.forwardRef in <Formik>

[jaredpalmer]

As of 2.1.2, <Formik> now allows for an innerRef prop. However, we should instead use React.forwardRef + React.useImperativeHandle. This is more intuitive and closer to best practices. The problem though, is that <Formik> takes TypeScript generics for Values and I'm not sure how to express this in with forwardRef. AFAICT, you can't because forwardRef returns a constant and constants can't have generics.

Help?!?!

[drivasperez]

How about:

export const Formik = React.forwardRef(function Formik<
  Values extends FormikValues = FormikValues,
  ExtraProps = {}
>(props: FormikConfig<Values> & ExtraProps, ref: any) {
  const formikbag = useFormik<Values>(props);
  const { component, children, render, innerRef } = props;

  // This allows folks to pass a ref to <Formik />
  React.useImperativeHandle(innerRef, () => formikbag);
  React.useImperativeHandle(ref, () => formikbag);
  ...

This seems to infer okay, but I might be misunderstanding.

[jaredpalmer]

Submit a PR?

[drivasperez]

Done!

[drivasperez]

Ah, never mind, I see the issue.

[johnrom]

Doing a little cheating makes this possible. I didn't test too thoroughly, but it seems to work. The main issue is that I had to override the type inference (with as) and so this particular assignment will now be vulnerable to incorrect typings in the future.

https://github.com/jaredpalmer/formik/pull/2222

Some external issues related to forwardRef woes: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/35834 https://stackoverflow.com/a/51898192

And finally, the rabbit hole, where someone attempts to define a way to let TS infer an open generic, and the TS team says "maybe one day": https://github.com/microsoft/TypeScript/pull/24626

[drivasperez]

I couldn’t find anything that worked before that doesn’t now. I guess the main concern is: going forward, how can you break it going forward in a way that the “as [...component...]” cast won’t complain about, and is that likely to happen?

[johnrom]

Basically, a Formik contributor could change the types incorrectly. I wish we could ignore a specific rule so we wouldn't have to use as and we could protect against all the other errors, but for now as is the best protection we can get. as won't protect against most things, but it'll at least make sure it's kind of the same signature. I made a similar comment here: https://github.com/microsoft/TypeScript/pull/30215

[ProteanCode]

It touches https://github.com/jaredpalmer/formik/issues/2290

[tony]

A related StackOverflow I thought would be helpful to consider: https://stackoverflow.com/questions/58469229/react-with-typescript-generics-while-using-react-forwardref (answer with some approaches)

[stclairdaniel]

Any updates on this issue? It's preventing my team from upgrading to Formik 2.x

[julioxavierr]

+1

[arvigeus]

What about:

const MyComponent = React.forwardRef(function<T>(props: PropsType<T>, ref) {
  return null;
})

[workforbala]

any update on this issue ? we are facing same issue while upgrading formik ?

[Evaldoes]

To access formik by reference, you can do like this:

const formRef = useRef<FormikProps<FormProps>>(null);

<Formik innerRef={formRef} />

• FormProps iis the model of the data that you will use in the form

If you print the reference console.log(formRef.current) you will see something like this:

This way it is possible to manipulate formik from anywhere :smile: :sunglasses: that's it