Name must be at least 2 words
Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yaireo/validator
HTML form validation. Perfectly made for all scenerios, lightweight, semantic & easy to use
https://github.com/yaireo/validator
form-validation html
Last synced: 3 days ago
JSON representation
HTML form validation. Perfectly made for all scenerios, lightweight, semantic & easy to use
- Host: GitHub
- URL: https://github.com/yaireo/validator
- Owner: yairEO
- Created: 2012-12-26T19:07:59.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2021-08-01T19:39:20.000Z (over 3 years ago)
- Last Synced: 2024-12-21T05:34:02.652Z (10 days ago)
- Topics: form-validation, html
- Language: JavaScript
- Homepage:
- Size: 156 KB
- Stars: 259
- Watchers: 20
- Forks: 85
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Validator - Lightweight & Easy HTML form inputs checker
The Validator is cross-browser and will give you the power to use future-proof input types such as:
`tel`, `email`, `number`, `date`, `time`, `checkbox` and `url`.
# [👉 See Demo](http://yaireo.github.io/validator)
npm i @yaireo/validator --save
// usage:
import FormValidator from '@yaireo/validator'
// or download the `validator.js` file and add load it inside your HTML file
### Why should you use this?
* Cross browser validation
* Deals with all sorts of edge cases
* Utilize new HTML5 types for unsupported browsers
* Flexible error messaging system
* Light-weight (19kb + comments, unminified)
## Validation types support
HTML5 offers a wide selection of input types. I saw no need to support them all, for example, a checkbox should not be validated as ‘required’ because why wouldn’t it be checked in the first place when the form is rendered?
For a full list of all the available types, visit the working draft page.
These input types can be validated by the JS for – ``. (Support is synthesized)
✔️ `text`
✔️ `email`
✔️ `password` - also comparing "re-type password" inputs
✔️ `number`
✔️ `date`
✔️ `time`
✔️ `uRL`
✔️ `search`
✔️ `file`
✔️ `tel`
✔️ `checkbox`
✔️ `select`
✔️ `textarea`
✔️ `hidden` – can also have the ‘required’ attribute
## Basic semantics
```html
Name
?
email
...
```
First, obviously, there is a Form element with the novalidate attribute to make sure all the native HTML5 validations (which currently suck) are disabled. Proceeding, there is a Fieldset element which is not a must, but acts as a “binding” box for a group of fields that are under the same “category”. For bigger forms there are many field groups that are visually separated from each other for example. Now, we treat every form field element the user interacts with, whatsoever, as a “field”, and therefor these “fields” will be wrapped with `
`. This isolation gives great powers.
Next, inside a field, there will typically be an input or select or something of the sort, so they are put inside a `` element, to get rid of the (annoying) 'For' attribute, on the label (which also requires us to give an ID to the form field element), and now when a user clicks on the label, the field will get focused. Great. Going back to the label’s text itself, we wrap it with a `` to have control over it’s style.
The whole approach here is to define each form field (input, select, whatever) as much as possible with HTML5 attributes and also with custom attributes.
### HTML Attributes on form elements
| Attribute | Purpose |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `required` | Defines that this field should be validated (with JS by my implementation and not via native HTML5 browser defaults) |
| `placeholder` | Writes some placeholder text which usually describes the fields with some example input (not supported in IE8 and below) |
| `pattern` | Defines a pattern which the field is evaluated with. Out-of-the-box available values are:
**numeric** - Allow only numbers
**alphanumeric** - Allow only numbers or letters. No special language characters
**phone** - Allow only numbers, spaces or dashes.
Alternatively, you may write your own custom regex here as well |
| `data-validate-words` | Defines the minimum amount of words for this field |
| `data-validate-length` | Defines the length allowed for the field (after trim). Example value: `7,11` (field can only have 7 or 11 characters). you can add how many allowed lengths you wish |
| `data-validate-length-range` | Defines the minimum and/or maximum number of chars in the field (after trim). value can be `4,8` for example, or just `4` to set minimum chars only |
| `data-validate-linked` | Defines the field which the current field value (the attribute is set on) should be compared to. Value can be a selector or another input's `name` attribute's value |
| `data-validate-minmax` | For type `number` only. Defines the minimum and/or maximum value that can be in that field |
| `data-validate-text-invalid` | Error text message for specific field
### `pattern` attribute
It is possible to write your own unique Regex patterns directly in the attribute or reference to it by custom name, for example:
```html
```
```js
var validator = new FormValidator({
regex : {
myCustomRegex: '/whatever/'
}
}, );
```
### Optional fields
There is also support for optional fields, which are not validated, unless they have a value. The support for this feature is done by adding a class `optional` to a form element. Note that this should not be done along side the “required” attribute.
## Error messages
```js
{
invalid : 'input is not as expected',
short : 'input is too short',
long : 'input is too long',
checked : 'must be checked',
empty : 'please put something here',
select : 'Please select an option',
number_min : 'too low',
number_max : 'too high',
url : 'invalid URL',
number : 'not a number',
email : 'email address is invalid',
email_repeat : 'emails do not match',
date : 'invalid date',
time : 'invalid time',
password_repeat : 'passwords do not match',
no_match : 'no match',
complete : 'input is not complete'
}
```
This object can be extended easily. The idea is to extend it with new keys which represent the `name` (attribute) of the field you want the message to be linked to, and that custom message appear as the `general error` one.
Default messages can be over-ridden.
### Example of a specific input field's error message:
```html
```
### Another example:
```html
```
```js
var validator = new FormValidator({
texts : {
mySpecialInput: 'wrong input' // set custom error message for that specific field, by "name"
}
});
```
### Example: for a given type `date` field, lets set a custom (general error) message like so:
```js
// set custom text on initialization:
var validator = new FormValidator({
texts : {
date: 'not a real date'
}
});
// or post-initialization
var validator = new FormValidator();
validator.texts.date = 'not a real date';
```
Error messages can be disabled:
```js
validator = new FormValidator({
alerts: false
});
// or by:
var validator = new FormValidator();
validator.settings.alerts = false;
```
## Binding the validation to a form
There are two ways to validate form fields, one is on the submit event of the form itself, then all the fields are evaluated one by one.
The other method is by binding the `checkField` function itself to each field, for events like `Blur`, `Change` or whatever event you wish (I prefer on Blur).
### Usage example - validate on submit
A generic callback function to have the form validated on the **Submit** event. You can also include your own personal validations before the **checkAll()** call.
```js
var validator = new FormValidator();
// select your "form" element from the DOM and attach an "onsubmit" event handler to it:
document.forms[0].onsubmit = function(e){
var validatorResult = validator.checkAll(this); // "this" reffers to the currently submitetd form element
return !!validatorResult.valid;
};
```
### Usage example - validate on field blur/input/change events
Check every field (using event Capture)
```js
var validator = new FormValidator();
document.forms[0].addEventListener('blur', function(e){
validator.checkField(e.target)
}, true);
document.forms[0].addEventListener('input', function(e){
validator.checkField(e.target);
}, true);
document.forms[0].addEventListener('change', function(e){
validator.checkField(e.target)
}, true);
```
Utilize the internal events' binding system; pass in the settings the `events` property and assign it an array which states which events should be inputs be validated for. For a single events, a string may be paassed instead of an Array:
```js
var validator = new FormValidator( document.forms[0], {
"events" : ['blur', 'input', 'change'] // for a single one, just pass a string, ex: "blur"
});
```
In case the form is not yet ready, the events maybe be binded later, when the form is ready, using the internal `events` method for a `validator` instance:
```js
// validate fields on these events:
var validator = new FormValidator(document.forms[0]); // the "" element should be passed when the instance is created or passed to the "events" method below (as the 2nd parameter)
// wait for the form, or its' fields, to be ready (for whatever reason), and then bind the events as follows:
validator.events(['blur', 'input', 'change']);
```
## Tooltips (for each field which did not validate)
The helper tooltips **<div class='tooltip help'>**, which work using pure CSS, are elements which hold a small **'?'** icon and when hovered over with the mouse, reveal a text explaining what the field “field” is about or for example, what the allowed input format is.
## Classes
`validator.settings.classes` object can be modified:
```js
var validatorClasses = {
field : 'field', // class for each input wrapper
alert : 'alert', // call on the alert tooltip
bad : 'bad' // classes for bad input
};
validator = new FormValidator(null, {classes:validatorClasses});
// or
validator = new FormValidator();
validator.settings.classes.bad = 'error';
```
## Bonus – multifields
I have a cool feature I wrote which I call *"multifields"*.
These are fields which are often used to input a credit card or a serial number, and are actually a bunch of input fields which are “connected” to each other, and treated as one. You can see it in the demo page, and it’s included in the ‘multifield.js’ file.