README

react-kb-form

Form validation hook library for enterprise scale react applications

Installation

Use the package manager npm to install react-kb-form.

npm i react-kb-form

Features

Built with performance in mind
Simple usage
Rich collection of validation patterns
No third party libraries was used
Step-by-step validation
Form resetting
Watching form values
Environment mode
Usage with reusable Input components

Simple Usage

import { useKBform } from "react-kb-form";

const {
  _register,
  _handleSubmit,
  _envMode,
  _reset,
  watchState,
  formState,
  errorState,
  formStatus,
} = useKBform();

<form ref={_register} _formname="form" onSubmit={_handleSubmit}>
  <input
    name="example"
    _required="this field is required"
    _email="provided value is not valid email"
  />
  {errorState.example}

  <button type="submit">submit</button>
</form>;

useEffect(() => {
  if (formState) {
    console.log(formState.form);
  }
}, [formState]);

Available Props

_required: string;
_number: string;
_min: string;
_max: string;
_password: string;
_passwordrepeat: string;
_strongpassword: string;
_minlength: string;
_maxlength: string;
_length: string;
_email: string;
_amount: string;
_pan: string;
_panbasic: string;
_pin: string;
_formname: string;
_customregex: string;
_resetbtn: string;
_ignore: string;
_phone: string;

Contributors

Github account - Sabuhi Nazarov

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT

Detailed docs coming soon ...

Usage no npm install needed!