Skip to content

Randagio13/rapid-form

Repository files navigation

Rapid Form

NPM

The rapid-form npm package is a tool designed to simplify the creation and management of forms in web applications. It provides a streamlined way to handle form state, validation, and submission, making it easier for developers to implement complex forms without having to write repetitive boilerplate code.

Installation

  # NPM
  npm install rapid-form

  # YARN
  yarn add rapid-form

  #PNPM
  pnpm add rapid-form

Quick Start

import { useRapidForm } from 'rapid-form'

function App() {
  const { refValidation, errors } = useRapidForm()

  const  handleSubmit = () => {
    // check errors
  }

  return (
    <form
      id="rapidForm"
      ref={(ref) => {
        refValidation(ref)
      }}
      autoComplete="off"
      onSubmit={handleSubmit}
    >
      <input name="username" placeholder="Username" required />
      {errors.username?.message}
      // OR
      {errors.username && yourI18Label[errors.username.code]}
      <label>Email:</label>
      <input name="email" type="email" required />
      {errors.email?.message}
      <label>Age:</label>
      <input name="age" required pattern="\d+" />
      {errors.age?.message}
      <button type="submit">Submit</button>
    </form>
  )
}

Contributors

Any contribution is appreciated. You can get started with the steps below:

  1. Fork this repository (learn how to do this here).

  2. Clone the forked repository.

  3. Make your changes and create a pull request (learn how to do this).

  4. I will attend to your pull request and provide some feedback.

Need help?

Ping me on Twitter

License

This repository is licensed under the MIT License.

Sponsor

Don't be shy! 😜

❤️ Sponsor