Skip to content

Commit 432023b

Browse files
committed
Merge branch 'master' of github.com:CodeStix/fast-react-form
2 parents d363b56 + c0279cb commit 432023b

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,29 @@
1-
# Typed React form [![NPM](https://img.shields.io/npm/v/typed-react-form.svg)](https://www.npmjs.com/package/typed-react-form)
1+
# Typed React form [![NPM](https://img.shields.io/npm/v/typed-react-form.svg)](https://www.npmjs.com/package/typed-react-form) [![NPM Size](https://img.shields.io/bundlephobia/minzip/typed-react-form)](https://bundlephobia.com/result?p=typed-react-form)
22

33
![vscode typescript](https://github.com/CodeStix/typed-react-form/raw/master/example/public/thumb.png)
44

55
A fast, completely type-checked React form state manager, focussed on typescript integration and minimal rerenders. Featuring:
66

7-
- [Date, number, text inputs, checkboxes, radio buttons, textareas, selects](https://github.com/CodeStix/typed-react-form/wiki/FormInput)
87
- [Object fields](https://github.com/CodeStix/typed-react-form/wiki/Object-fields)
98
- [Array fields](https://github.com/CodeStix/typed-react-form/wiki/Array-fields)
109
- [Validation and yup integration](https://github.com/CodeStix/typed-react-form/wiki/Validation)
11-
- [Togglable fields](https://github.com/CodeStix/typed-react-form/wiki/Toggling-a-field)
10+
- [Easily toggle fields](https://github.com/CodeStix/typed-react-form/wiki/Toggling-a-field)
11+
- [Listeners (subscription based state updates)](https://github.com/CodeStix/typed-react-form/wiki/useListener)
1212

1313
**All of this while keeping type-checking!**
1414

15+
## Install
16+
17+
```
18+
npm install typed-react-form
19+
```
20+
1521
## [Documentation](https://github.com/CodeStix/typed-react-form/wiki)
1622

1723
**You can find documentation and information on how to get started [on the GitHub wiki page](https://github.com/CodeStix/typed-react-form/wiki).**
1824

25+
**You can see an example form working in action [here](https://codestix.github.io/typed-react-form/).**
26+
1927
## Javascript/typescript React
2028

2129
This library is optimized (and built from the group up) for React with typescript, but it also works with with vanilla React, without enforced type checking.

0 commit comments

Comments
 (0)