formboi v0.1.0

Formboi

Formboi is a super simple react form management library. Only takes care of the values of a form and the validation of those values, leaving the rest in your hands (onBlur and onFocus management etc.)

This approach makes the library really easy to learn and put in place. Formboi will integrate seamlessly with the rest of the forms of your app and it's functionality can be easily toggled on and off depending on your needs.

The main principle of this library is that you create your own enhanced form components so you have total control over the final behavior, but some basic common form elements are provided for ease of use.

Installation

Install the library as any other npm module using the package manager of your choice:

$ yarn add formboi

Simple Example

If you use the provided form components, your final form should look really similar to a plain HTML form, just made with React components.

import React from 'react';
import { Form, Label, Input, ErrorLabel } from 'formboi';

import FormGroup from './FormGroup';


class App extends React.Component {
  state = {
    values: {},
  };

  render() {
    return (
      <div>
        <Form
          enhanced  // With this prop is how we tell formboi to act
          validate={(values) => Promise.resolve({ firstName: 'Async validation' })}
          getSubmit={(submit) => this.submitForm = submit}  // We can submit the form from outside
          onSubmit={(values, errors) => this.setState({ values, errors })}>
          <FormGroup>
            <Label htmlFor="firstName">First name</Label>
            <Input
              name="firstName"
              id="firstName"
              validate={(v) => v.required('This field is required')} />
            <ErrorLabel htmlFor="firstName" />
          </FormGroup>
          <FormGroup>
            <Label htmlFor="lastName">Last name</Label>
            <Input
              name="lastName"
              id="lastName"
              validate={(v) => v.required('This field is required')} />
            <ErrorLabel htmlFor="lastName" />
          </FormGroup>
        </Form>
        <button type="button" onClick={this.submitForm}>
          Submit
        </button>
      </div>
    );
  }
}


export default App;

License

MIT