Merge branch 'master' of https://github.com/Codestix/typed-react-form

Author: CodeStix

README.md

@@ -12,12 +12,12 @@
 </p>
 
 <p align="center" width="100%">
-    <strong>A completely type-checked form builder for React</strong>
+    <strong>A completely type-checked form builder for React with Typescript</strong>
 </p>
 
-- ✔️ **Type-checked**: Make less errors, this library was built for React with Typescript. 
-- 🤔 **Simple**: An intuitive and easy to understand api. Well [documented](https://codestix.github.io/typed-react-form/) too, also with JSDoc. 
-- :fire: **Fast**: It only rerenders the fields that change if used correctly. This allows you to create huge forms.
+- ✔️ **Type-checked**: Make less errors, even field names are strongly typed.
+- 🤔 **Simple**: A well [documented](https://codestix.github.io/typed-react-form/), intuitive and easy to understand api. 
+- :fire: **Fast**: Only rerenders the fields that change if used correctly. This allows you to create huge forms.
 - 📦 **Pretty Small**: [![NPM Size](https://img.shields.io/bundlephobia/minzip/typed-react-form)](https://bundlephobia.com/result?p=typed-react-form)
 
 ## Install

Todo.md

@@ -4,3 +4,4 @@
 -   Require index for array fields
 -   Field on blur
 -   Use React.forwardRef instead of innerRef on Field/FieldError
+-   Rename `FormField` -> `FieldInfo` & better documentation on passed Field props

docs/Troubleshooting.md

@@ -46,3 +46,9 @@ const StyledCustomInput: typeof CustomInput = styled(CustomInput)`
     }
 `;
 ```
+
+---
+
+## Element type is invalid: expected a string (for built-in components) or a class/function but got: undefined
+
+This sometimes happens after installing this package. Restart your project to fix it. (restart `react-scripts`)

docs/_config.yml

@@ -5,6 +5,8 @@ remote_theme: pmarsceill/just-the-docs
 aux_links:
     "GitHub":
         - "https://github.com/CodeStix/typed-react-form"
+    "NPM":
+        - "https://www.npmjs.com/package/typed-react-form"
 
 aux_links_new_tab: true
 

docs/index.md

@@ -19,6 +19,8 @@ yarn add typed-react-form
 
 This library works with both **Javascript** and **Typescript**. Typescript is certainly preferred because of the enforced type-checking!
 
+**Make sure to restart your project after installing. (restart `react-scripts`)**
+
 ## Step 2: Creating a form
 
 ### Using the `useForm` hook