Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@meronex/form

Package Overview
Dependencies
Maintainers
1
Versions
19
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@meronex/form

A simple react form for React Material UI (and potential other)

  • 1.1.4
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

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

PropDescription
name *Required field to hook the form to the field
defaultValueOptional default value
validatorValidator function to be triggered onBlur
blurDelayIntenger to delay triggering the blur validation in ms
validateOnInitBoolean value to validiate on form init

The Form also exposes the following ref functions:

FunctionDescription
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

  • Looking for React Icons? try Meronex Icons

Keywords

FAQs

Package last updated on 01 Feb 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc