Skip to content

Repository files navigation

Validation component for react forms

licensenpm versionBuild Status

Simple form validation component for react forms inspired by formsy-react

Default validation rules:

  • matchRegexp
  • isEmail
  • isEmpty
  • required
  • trim
  • isNumber
  • isFloat
  • isPositive
  • minNumber
  • maxNumber
  • minFloat
  • maxFloat
  • minStringLength
  • maxStringLength
  • isString
  • maxFileSize
  • allowedExtensions

Some rules can accept extra parameter, example:

<YourValidationInput{...someProps}validators={['minNumber:0','maxNumber:255','matchRegexp:^[0-9]$']}/>

Usage

importReactfrom'react';import{ValidatorComponent}from'react-form-validator-core';classTextValidatorextendsValidatorComponent{render(){const{ errorMessages, validators, requiredError, validatorListener, ...rest}=this.props;return(<div><input{...rest}ref={(r)=>{this.input=r;}}/>{this.errorText()}</div>);}errorText(){const{ isValid }=this.state;if(isValid){returnnull;}return(<divstyle={{color: 'red'}}>{this.getErrorMessage()}</div>);}}exportdefaultTextValidator;
...
import{ValidatorForm}from'react-form-validator-core';
...
render(){return(<ValidatorFormref="form"onSubmit={this.handleSubmit}><TextValidatoronChange={this.handleChange}name="email"value={email}validators={['required','isEmail']}errorMessages={['this field is required','email is not valid']}/><buttontype="submit">submit</button></ValidatorForm>);}
...
...
import{ValidatorForm}from'react-form-validator-core';
...
render(){return(<ValidatorFormref="form"onSubmit={this.handleSubmit}><TextValidatoronChange={this.handleChange}name="file"type="file"value={file}validators={['isFile','maxFileSize:'+1*1024*1024,'allowedExtensions:image/png,image/jpeg']}errorMessages={['File is not valid','Size must not exceed 1MB','Only png and jpeg']}/><buttontype="submit">submit</button></ValidatorForm>);}
...

You can add your own rules

ValidatorForm.addValidationRule('isPasswordMatch',(value)=>{if(value!==this.state.user.password){returnfalse;}returntrue;});

API

ValidatorForm

  • Props
PropRequiredTypeDefault valueDescription
onSubmittruefunctionCallback for form that fires when all validations are passed
instantValidatefalsebooltrueIf true, form will be validated after each field change. If false, form will be validated only after clicking submit button.
onErrorfalsefunctionCallback for form that fires when some of validations are not passed. It will return array of elements which not valid.
debounceTimefalsenumber0Debounce time for validation i.e. your validation will run after debounceTime ms when you stop changing your input
  • Methods
NameParamsReturnDescriptipon
resetValidationsReset validation messages for all validated inputs
isFormValiddryRun: bool (default true)boolGet form validation state (true if whole form is valid). Run with dryRun = false to show validation errors on form

All validated fields (ValidatorComponent)

  • Props
PropRequiredTypeDefault valueDescription
validatorsfalsearrayArray of validators. See list of default validators above.
errorMessagesfalsearrayArray of error messages. Order of messages should be the same as validators prop.
nametruestringName of input
validatorListenerfalsefunctionIt triggers after each validation. It will return true or false
withRequiredValidatorfalseboolAllow to use required validator in any validation trigger, not only form submit
  • Methods
NameParamsReturnDescriptipon
getErrorMessageGet error validation message
validatevalue: any, includeRequired: boolRun validation for current component
isValidboolReturn current validation state
makeInvalidSet invalid validation state
makeValidSet valid validation state

Implemetations

Contributing

This component covers all my needs, but feel free to contribute.

About

Slight mods from NewOldMax/react-form-validator-core

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages