Skip to content

Commit 5e961ce

Browse files
committed
2 parents e5c01dd + 08732cf commit 5e961ce

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,13 @@
1111
<a href="https://bundlephobia.com/result?p=typed-react-form"><img alt="NPM Size" src="https://img.shields.io/bundlephobia/minzip/typed-react-form" /></a>
1212
</p>
1313

14-
- ✔️ **Completly type-checked**: make less errors, this library was built for Typescript. Supports nested objects/arrays.
15-
- 🤔 **Simple**: An intuitive, unclottered and easy to understand api. Well [documented](https://codestix.github.io/typed-react-form/) too (+JSDoc).
16-
- :fire: **Fast**: only rerenders the fields that change. This allows you to create huge forms.
14+
<p align="center" width="100%">
15+
<strong>A completely type-checked form builder for React</strong>
16+
</p>
17+
18+
- ✔️ **Type-checked**: Make less errors, this library was built for React with Typescript.
19+
- 🤔 **Simple**: An intuitive and easy to understand api. Well [documented](https://codestix.github.io/typed-react-form/) too, also with JSDoc.
20+
- :fire: **Fast**: It only rerenders the fields that change if used correctly. This allows you to create huge forms.
1721
- 📦 **Pretty Small**: [![NPM Size](https://img.shields.io/bundlephobia/minzip/typed-react-form)](https://bundlephobia.com/result?p=typed-react-form)
1822

1923
## Install
@@ -32,7 +36,7 @@ This library is built from the ground up for React with typescript, but it also
3236

3337
Contributions are welcome.
3438

35-
1. Clone this repo
39+
1. Clone this repo.
3640
2. Install deps using `yarn`. Yarn is required because of the resolutions field in package.json, npm does not support this.
3741
3. Open a new terminal and navigate to `testing/`, run `yarn` and `yarn start` to start the testing application.
3842
4. Done! When you edit source code, it will be rebuilt and update the testing application.

docs/reference/useForm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Creates a new form state manager. This hook does not cause a rerender.
1111

1212
This hook must be called, unconditionally, at the start of your component, just like the normal React hooks.
1313

14-
**Note for using `setState` along with `useForm`**: This library is built upon the fact that only the things that change should rerender. When using `setState` with the form, a state change causes the whole form to rerender. You can reduce this problem by creating components from the things that use the state, or you can use [custom form state](/typed-react-form/reference/useForm#defaultstate-optional-issubmitting-false).
14+
**Note for using `setState` along with `useForm`**: This library is built upon the fact that only the things that change should rerender. When using `setState` with the form, a state change causes the whole form to rerender. You can reduce this problem by creating components from the things that use the state, or you can use [custom form state](/typed-react-form/reference/useForm.html#defaultstate-optional).
1515

1616
`useForm(defaultValues, validator?, validateOnChange = false, validateOnMount = false, defaultState = {isSubmitting: false})`
1717

0 commit comments

Comments
 (0)