| 1 | # `@shopify/react-form-state`
|
| 2 |
|
| 3 | [](https://travis-ci.org/Shopify/quilt)
|
| 4 | [](LICENSE.md) [](https://badge.fury.io/js/%40shopify%2Freact-form-state.svg) [](https://img.shields.io/bundlephobia/minzip/@shopify/react-form-state.svg)
|
| 5 |
|
| 6 | Manage react forms tersely and safely-typed with no magic.
|
| 7 |
|
| 8 | ## Installation
|
| 9 |
|
| 10 | ```bash
|
| 11 | $ yarn add @shopify/react-form-state
|
| 12 | ```
|
| 13 |
|
| 14 | ## Usage
|
| 15 |
|
| 16 | ### `<FormState />`
|
| 17 |
|
| 18 | The default component exported by this library is `<FormState />`.
|
| 19 |
|
| 20 | ```typescript
|
| 21 | import FormState from '@shopify/react-form-state';
|
| 22 | ```
|
| 23 |
|
| 24 | ```typescript
|
| 25 | // Fields here refers to the inferred type of your initialValues object
|
| 26 | interface Props<Fields> {
|
| 27 | initialValues: Fields;
|
| 28 | validators?: Partial<ValidatorDictionary<Fields>>;
|
| 29 | onSubmit?: SubmitHandler<Fields>;
|
| 30 | children(form: FormDetails<Fields>): React.ReactNode;
|
| 31 | }
|
| 32 | ```
|
| 33 |
|
| 34 | Its only mandatory props are `initialValues` and `children`. The `initialValues` prop is used to infer all the types for the rest of the component, and to generate handlers and field state objects. The `children` prop expects a function of the current state of the form, which is represented by a `FormDetails` object.
|
| 35 |
|
| 36 | ```typescript
|
| 37 | <FormState initialValues={myInitialValues}>
|
| 38 | {({fields, dirty, valid, submitting, errors, reset, submit}) => {
|
| 39 | return /* some cool ui */;
|
| 40 | }}
|
| 41 | </FormState>
|
| 42 | ```
|
| 43 |
|
| 44 | For detailed explanations of how to use `<FormState />` check out [the guide](https://github.com/Shopify/quilt/tree/master/packages/react-form-state/docs/building-forms.md).
|
| 45 |
|
| 46 | ### `validators`
|
| 47 |
|
| 48 | The library also makes a number of validation factory functions available out of the box that should help with common use cases, as well as some tools to make building reusable custom validators easy.
|
| 49 |
|
| 50 | ```typescript
|
| 51 | import {validate, validators} from '@shopify/react-form-state';
|
| 52 | ```
|
| 53 |
|
| 54 | For detailed explanations of the validation utilities, check out [the validation docs](https://github.com/Shopify/quilt/tree/master/packages/react-form-state/docs/validators.md).
|