Git Product home page Git Product logo

meronex-form's Introduction

Meronex Form

Simple React forms with validation for React MUI.

Features

  • ✅ Validate onBlur or onChange
  • ✅ Same API for classes and functional components
  • ✅ Easy to fork and modify to your needs

demo

Usage

  1. Install npm i @meronex/form

  2. Import import Form from '@meronex/form';

  3. Add the form <Form ref={validatedForm} onUpdate={(_formData) => { setFormData(_formData); }} blurDelay={500}> ... React MUI Fields Here </Form

    Notice that we've a ref attached which exposes a validatedForm.reset() method and we've an onUpdate method which is triggered every time there change to the form. The blurDelay default is zero, and it used to delay blur validation to allow time for animation etc.

  4. Add the @material-ui fields with name (required), defaultValue (optional for edit forms) and validator (optional for validation) attributes.

    <TextField name={'name'} label="Name" defaultValue={'a'} validate={(v) => { if (!v || v === '') return 'Name is required..!!'; return true; }} />

    That's it! The onUpdate will be triggered with all the form data, you can then set it to the state object.

    note that the defaultValue and validator are optional. You only need the name attribute for the form to hook for the field. Also, this works with the TextField using select attribute.

Props & Functions

Prop Description
name * Required field to hook the form to the field
defaultValue Optional default value
validator Validator function to be triggered onBlur
blurDelay Intenger to delay triggering the blur validation in ms
validateOnInit Boolean value to validiate on form init

The Form also exposes the following ref functions:

Function Description
reset() Reset the form
validate() Force validate the form

Why?

  1. Dead-simple API
  2. Minimal documentation/concepts
  3. Easy to fork, copy and modify (it is only a single file with no build step)
  4. Zero dependencies
  5. Extremely tiny (1.2kb minified + gzipped)

How it works?

The Form component will bind methods/props to the child fields. The value, onBlur, onChange, error and helperText props are automatically handled, a form object is created to capture the state of the form and that object is passed to the onUpdate method with every change.

Other libraries

meronex-form's People

Contributors

aogaili avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.