use-form-handler v1.0.0

use-form-handler

A strongly typed React Hook for form input handling.

use-form-handler’s main goals are to keep it user-friendly, easy to use and type-safe. It shall be extended to include the most useful functions for form handling.

Installation

NPM package will be available soon.

Usage

In your component, initialize the Hook using useFormHandler like so:

const initial = {
  name: 'Marie Curie',
  occupation: 'Scientist',
};

const [formState, formHandler, isModified] = useFormHandler(initial);

You must provide exactly one parameter to useFormHandler which must be a flat object consisting of a mapping between field name and value. The value can be of type string, number, string[], or undefined. This flat map will be used for the initial state of the inputs.

useFormHandler then returns three elements in an array in the order indicated below. Use ES6 destructuring to easily get them.

• formState: An object containing the present state of the form field values using the same structure as in initial.
• formHandler: An object containing a mapping between the form fields and their respective props (name, onChange, and value) which can be directly used on input, select, or textarea elements.
• isModified: A boolean flag indicating that one or more of the provided field values has been modified if true.

You can bind useFormHandler to your input, select, or textarea elements using the ES6 spread syntax, for example:

<form>
  <div>
    <label htmlFor="name">Name:</label>
    <input type="text" id="name" required {...formHandler.name} />
  </div>
  <div>
    <label htmlFor="occupation">Occupation</label>
    <input type="text" id="occupation" {...formHandler.occupation} />
  </div>
  <div>
    <input type="submit" value="Submit" />
  </div>
</form>

License

• See LICENSE