Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nikhilag authored Apr 15, 2021
1 parent 704449b commit c0aa9d7
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ The idea behind ths library is to use Recoil for managing a form and treat state
- useField - To be used in field components for capturing change, getting value and for validation
- useWatch / useMultipleWatch - This allows you to watch other fields in the form and so just this component renders when those other fields render.
- useFormValues - Listen to the form values in real-time but the best part here is that only this particular component will render again. Hence you can get all values without a re-render of the entire form
- useIsDirty - This is a WIP but it will allow you to capture dirty state of the form.
- useIsDirty - This allows you to capture if the form has been modified.
- useFieldArray - This is an efficient way of managing field arrays where you need to use a table or something similar for data entry. This allows you to append rows, remove rows, etc. Sticking to the philosophy of this library, only those fields/cells will render which are being modified.

It is already being used in production in multiple internal projects. However, we don't have enough examples and documentation for this yet but we will add that soon. To get started for now, you can look at the 2 examples already added.

# Install
`yarn add react-recoil-form recoil immer`

0 comments on commit c0aa9d7

Please sign in to comment.