Fix API doc for Field component

[leonbloy]

It's frustrating that the docs for the fundamental <Field> component is so messed up.

[leonbloy]

The docs in general, are quite chaotic (to put it mildly)

Formik: https://jaredpalmer.com/formik/docs/api/formik

There are two kind of props here: the ones for <Formik> , and the ones that are passed by Formik to the render function.

It's hard to distinguish them

[leonbloy]

More in https://jaredpalmer.com/formik/docs/api/field

field: An object containing onChange, onBlur, name, and value of the field (see FieldInputProps)
form: The Formik bag
meta: An object containing metadata (i.e. value, touched, error, and initialValue) about the field (see FieldMetaProps)

The two "see..." parentheses, have broken links.
And "Formik bag" should have some (preferably non broken) link that explains what a Formik bag is.

[johnrom]

You are free to open a PR with these revisions!

[leonbloy]

@johnrom I'll try to summit some fixes - but the problem is that to fix some docs we need to understand the API, and to understand the API we need ... to read the docs (unless we are Formik developers).
I cannot correct the inconsistencies because I don't know which of the contradicting informations is right. In particular, I'd love to know if "component" is actually deprecated for Field,...but I don't know.

[michael-swarm]

@leonbloy I think I found the answer to this question in an old issue -- component was briefly deprecated, but then intentionally un-deprecated for reasons cited below. The issue also has a great explanation of the difference between as and component, which could really use some clarification in the documentation. See: #1371 (comment) and #1915

[lucien-perouze-cezembre]

Why shouldn't components gets metas ? In the code there is this comment before creating component in Field :
// We don't pass meta for backwards compat

Why would that be an issue ?

I would really like to use components on Field as it's way cleaner. I just moved from redux-form and all my Fields are components.