js-validations-form-localized v1.0.4

js-validations-form-localized v1.0.4

Swiftly setup frontend form error handlers!

This package provides a validator function that can be used to perform validation checks on form inputs. It includes a set of rules that can be used to ensure that the values entered in the form meet the required criteria, such as being of a certain length or format. The function can be easily customized to fit the specific needs of your project, and it comes with translations for various languages such as English, French and Arabic...

TOC

• Installation
• Usage
• Interfaces
• Messages

Installation

yarn add js-validations-form-localized

or

npm install js-validations-form-localized

Usage

import { validate } from 'js-validations-form-localized';

const handleSubmitForm = async () => {
	try {
		const data = [
			{
				rules: ['email', 'min: 32', 'max:255'],
				value: emailInput,
				// overrides all rules default messages
				customMessages: "Email is wrong",
			},
			{
				rules: ['required', 'min: 6', 'max:32'],
				value: phoneInput,
				prefix: 'phone',
				// overrides rules[0] ('required') and rules[2] ('max:32') default messages 
				// while leaving rules[1] (min:6) with its default message
				customMessages: ['custom msg 1', null, 'custom message2']
			},
			{
				rules: ['equal'],
				value: [password, confirmPassword],
				prefix: ['password', 'confirm password'],
			}
		];
		validate(data, 'en');

		// continue with valid data
	} catch (e) {
		// handle error message
		console.log(e);
		alert(e.message);
	}
}

Parameters

Interfaces

Validations

interface IValidations {
	rules: 'required' | 'email' | 'equal' | 'notEqual' | `min:<number>` | `max:<number>` | `maxMB:<number>` | `minMB:<number>`,
	prefix?: string | string[],
	customMessages?: string | null | string[],
	value: (string | number) | (string | number)[]
}

Accepted languages

type TAcceptedLanguages = 'ar' | 'en' | 'fr'

Default Messages