v3 docs

.changeset/flat-peaches-hug.md

@@ -0,0 +1,6 @@
+---
+'formik': major
+'app': minor
+---
+
+Add strongly typed fields in an opt-in fashion using useTypedField() and useTypedFieldArray().

.gitignore

@@ -1,4 +1,5 @@
 dist
+dist-untyped
 compiled
 *.log
 coverage
@@ -7,6 +8,7 @@ next.d.ts
 legacy.d.ts
 .idea
 *.orig
+__generated__
 
 node_modules
 package-lock.json

.vscode/launch.json

@@ -5,19 +5,40 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "Run NPM Dev",
+            "name": "Run Dev Web App",
             "request": "launch",
             "type": "node",
             "runtimeArgs": [
                 "run",
-                "start:app"
+                "start:web"
             ],
             "runtimeExecutable": "npm",
             "cwd": "${workspaceFolder}",
             "skipFiles": [
                 "<node_internals>/**"
             ]
         },
+        {
+            "name": "Run Docs Website",
+            "request": "launch",
+            "type": "node",
+            "runtimeArgs": [
+                "run",
+                "start:website"
+            ],
+            "runtimeExecutable": "npm",
+            "cwd": "${workspaceFolder}",
+            "skipFiles": [
+                "<node_internals>/**"
+            ]
+        },
+        {
+            "type": "chrome",
+            "request": "launch",
+            "name": "Launch Chrome against localhost",
+            "url": "http://localhost:3000",
+            "webRoot": "${workspaceFolder}/app"
+        },
         {
             "type": "node",
             "name": "vscode-jest-tests",
@@ -37,13 +58,6 @@
             "protocol": "inspector",
             "internalConsoleOptions": "neverOpen",
             "disableOptimisticBPs": true
-        },
-        {
-            "type": "chrome",
-            "request": "launch",
-            "name": "Launch Chrome against localhost",
-            "url": "http://localhost:3000",
-            "webRoot": "${workspaceFolder}/app"
         }
     ]
 }

.vscode/settings.json

@@ -1,4 +1,4 @@
 {
   "typescript.tsdk": "node_modules/typescript/lib",
-  "jest.pathToJest": "npm run test:vscode --",
+  "jest.jestCommandLine": "npm run test:vscode --",
 }

docs/api.md

@@ -0,0 +1,53 @@
+---
+id: api
+title: The Formik API
+---
+
+### `handleBlur`
+
+> `(e: any) => void`
+
+`onBlur` event handler. Useful for when you need to track whether an input has
+been `touched` or not. This should be passed to `<input onBlur={handleBlur} ... />`
+
+### `handleChange`
+
+> `(e: React.ChangeEvent<any>) => void`
+
+General input change event handler. This will update the `values[key]` where
+`key` is the event-emitting input's `name` attribute. If the `name` attribute is
+not present, `handleChange` will look for an input's `id` attribute. Note:
+"input" here means all HTML inputs.
+
+### `handleReset`
+
+> `() => void`
+
+Reset handler. Will reset the form to its initial state. This should be passed
+to `<button onClick={handleReset}>...</button>`
+
+### `handleSubmit`
+
+> `(e: React.FormEvent<HTMLFormElement>) => void`
+
+Submit handler. This should be passed to `<form onSubmit={props.handleSubmit}>...</form>`. To learn more about the submission process, see [Form Submission](../guides/form-submission.md).
+
+### `formik.useState()`
+
+> ```ts
+> <Values, Return>(
+>   selector: (state: FormikState<Values>) => Return
+>   comparer: (prev: Return, next: Return) => boolean
+>   shouldSubscribe: boolean
+> ) => Return;
+> ```
+
+A special hook returned by Formik's API to access Formik's State within a render outside of Formik's context. See more in the [deep dive](./deep-dive#formik-state).
+
+### `formik.getState()`
+
+> ```ts
+> <Values>() => FormikState<Values>;
+> ```
+
+A method to access Formik's State outside of a render, for example in an event handler. See more in the [deep dive](./deep-dive#formik-state).