recoil-dot-form v1.0.8

recoil-dot-form

Simple, type safe forms.

Installation

npm install recoil-dot-form --save

Important

In order to use this package you'll also need to install the required peer dependencies yourself.

This can be done by running the following commands:

npm install recoil yup --save

npm install @types/yup --save-dev

About This Project

This project was motivated by personal need and a desire to learn more about creating an opensource project. This is still very much a work in progress and the current API/functionality will certainly be changing frequently and without warning, so I wouldn't suggest using it at this time.

The main goals of this project are to: 1. Make creating type safe forms easier(this is something many of the more well established libraries do not do well) 2. Create a simple API that lets developers focus on creating forms, not implementing form logic, validation, etc. 3. Leverage Recoil to create forms that are performant without any extra steps involved.

Current Issues/Tasks

• Add more useful meta fields to the form state and field state
• Improve the functionality exposed by the <Field /> component
• Make the validation agnostic(i.e. removing yup as a dependency
• Create an unflat function and possibly build this into the form internally(rather than having the developer manually flatten the initial values with the exposed flat function).
• Handle arrays by either creating an <ArrayField /> component which could take in a <Field /> and provide additional functionality ontop of the base field functionality, or build this into the form api internally.
• Improve the README and documentation
• Write tests
• Improve the demo/documentation site
• Create a workflow(CI) for publishing and managing the package and version