Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/posabsolute/jQuery-Validation-Engine

jQuery form validation plugin
https://github.com/posabsolute/jQuery-Validation-Engine

Last synced: about 1 month ago
JSON representation

jQuery form validation plugin

Host: GitHub
URL: https://github.com/posabsolute/jQuery-Validation-Engine
Owner: posabsolute
Created: 2009-08-13T12:58:48.000Z (over 15 years ago)
Default Branch: master
Last Pushed: 2021-09-09T14:10:33.000Z (over 3 years ago)
Last Synced: 2024-11-21T00:30:01.284Z (about 1 month ago)
Language: JavaScript
Homepage: http://www.position-absolute.com/articles/jquery-form-validator-because-form-validation-is-a-mess/
Size: 1.8 MB
Stars: 2,568
Watchers: 191
Forks: 1,202
Open Issues: 33
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

jQuery.validationEngine v3.1.0
=====

Looking for official contributors
---
This project has now been going on for more than 7 years, right now I only maintain the project through pull request contributions. However, I would love to have help improving the code quality and maintain an acceptable level of open issues.

Summary
---

**jQuery validation** engine is a Javascript plugin aimed at the validation of form fields in the browser (IE 6-8, Chrome, Firefox, Safari, Opera 10).
The plugin provides visually appealing prompts that grab user attention on the subject matter.

Validations range from email, phone, and URL, to more complex calls such as ajax processing or custom javascript functions.
Bundled with many locales, the error prompts can be translated into the language of your choice.

![Screenshot](https://github.com/posabsolute/jQuery-Validation-Engine/raw/master/css/screenshot.png)

Documentation :
---
### [Nicer documention](http://posabsolute.github.com/jQuery-Validation-Engine/)
### [Release Notes](https://github.com/posabsolute/jQuery-Validation-Engine/releases)

Installation
---

### What's in the archive?

Download

[tar.gz 3.0.0](https://github.com/posabsolute/jQuery-Validation-Engine/archive/v3.0.0.tar.gz)
or
[zip 3.0.0](https://github.com/posabsolute/jQuery-Validation-Engine/archive/v3.0.0.zip)

The archive holds, of course, the core library along with translations in different languages.
It also comes with a set of demo pages and a simple ajax server (built in Java and php).

1. Unpack the archive
2. Include the script jquery.validationEngine.closure.js in your page
3. Pick the locale of the choice and include it in your page: jquery.validationEngine-XX.js
4. **Read this manual** and understand the API

Usage
---

### References

First include jQuery on your page

```html

```

Include *jquery.validationEngine* and its locale

```html

```

Finally include the desired theme

```html

```

### Field Validations

Validations are defined using the field's **class** attribute. Here are a few examples showing how it happens:

```html

```

For more details about validators, please refer to the section below.

#### Experimental attribute data-validation-engine

We are currently in the process of replaceing the class attribute by something more standard, it should normally work but consider this feature in beta.

#### Standard HTML5 attribute for error message

Customize error messages with data-errormessage and data-errormessage-* attributes on the form elements. For example:

```html

```

The following attribute's value will be loaded for the relative validation rule:

##### data-errormessage-value-missing
* required
* groupRequired
* condRequired

##### data-errormessage-type-mismatch
* past
* future
* dateRange
* dateTimeRange

##### data-errormessage-pattern-mismatch
* creditCard
* equals

##### data-errormessage-range-underflow
* minSize
* min
* minCheckbox

##### data-errormessage-range-overflow
* maxSize
* max
* maxCheckbox

##### data-errormessage-custom-error
* custom
* ajax
* funcCall

##### data-errormessage
* a generic fall-back error message

### Per Field Prompt Direction

Prompt direction can be define using the field's **data** attribute. Here are a few examples showing how it happens:

```html

```

### Prompt Position Adjustment

Prompt position can be adjusted by providing shiftX and shiftY with position type in the field's **data** attribute.
Prompt will be placed in (defaultX+shiftX),(defaultY+shiftY) position instead of default for selected position type.
Here are a few examples showing how it happens:

```html

```

### Instantiation

The validator is typically instantiated with a call in the following format, the plugin can only be instanciated on form elements:

```js
$("#form.id").validationEngine();
```

Without any parameters, the init() and attach() methods are automatically called.

```js
$("#form.id").validationEngine(action or options);
```

The method may take one or several parameters, either an action (and parameters) or a list of options to customize the behavior of the engine.

Here's a glimpse: say you have a form as such:

```html

```

The code below will instantiate the validation engine and attach it to the form:

```html

$(document).ready(function(){
$("#formID").validationEngine();
});

```

When using options, the default behavior is to only initialize ValidationEngine, so attachment needs to be done manually.

```html

$(document).ready(function(){
$("#formID").validationEngine('attach', {promptPosition : "centerRight", scroll: false});
});

```

All calls to validationEngine() are chainable, so one can do the following:

```js
$("#formID").validationEngine().css({border : "2px solid #000"});
```

Actions
---

### attach

Attaches jQuery.validationEngine to form.submit and field.blur events.

```js
$("#formID1").validationEngine('attach');
```

### detach

Unregisters any bindings that may point to jQuery.validaitonEngine.

```js
$("#formID1").validationEngine('detach');
```

### validate

Validates a form or field, displays error prompts accordingly.
Returns *true* if the form validates, *false* if it contains errors.

For *fields*, it returns false on validate and true on errors.

When using form validation with ajax, it returns *undefined* , the result is delivered asynchronously via function *options.onAjaxFormComplete*.

```js
// form validation
alert( $("#formID1").validationEngine('validate') );

// field validation
alert( $("#emailInput").validationEngine('validate') );
```

### showPrompt (promptText, type, promptPosition, showArrow)

Displays a prompt on a given element. Note that the prompt can be displayed on any element by providing an id.

The method takes four parameters:
1. the text of the prompt itself
2. a type which defines the visual look of the prompt: 'pass' (green), 'load' (black) anything else (red)
3. an optional position: either "topLeft", "topRight", "bottomLeft", "centerRight", "bottomRight". Defaults to *"topRight"*
4. an optional boolean which indicates if the prompt should display a directional arrow

```html

Email
Show prompt

```

### hide

The hide method can be applied to a form or a field.
It closes/hides error prompts.

```js
// closes all form prompts
$('#formID1').validationEngine('hide');

// closes onle one prompt
$('#email1').validationEngine('hide');
```

### hideAll

Closes/hides **all** error prompts on the page no matter what form they are attached to.

```js
$('#formID1').validationEngine('hideAll');
```

### updatePromptsPosition

Update the form prompts positions.

```js
$("#formID").validationEngine("updatePromptsPosition")
```

### hidePrompt & validateField

Deprecated and not part of the code base anymore.
Use _hide_ and _validate_ instead.

Options
---

Options are typically passed to the init or attach action as a parameter.

```js
$("#formID1").validationEngine({promptPosition : "centerRight", scroll: false});
$("#formID1").validationEngine('attach', {promptPosition : "centerRight", scroll: false});
```

### validationEventTrigger
Name of the event triggering field validation, defaults to *blur*.

### scroll
Determines if we should scroll the page to the first error, defaults to *true*.

### binded
If set to false, it removes blur events and only validates on submit.

### promptPosition
Where should the prompt show? Possible values are "topLeft", "topRight", "bottomLeft", "centerRight", "bottomRight". Defaults to *"topRight"*.
Default position adjustment could also be provided.

### showOneMessage
Only display the first incorrect validation message instead of normally stacking it. It will follows the validation hierarchy you used in the input and only show the first error.

### ajaxFormValidation
If set to true, turns Ajax form validation logic on. Defaults to *false*.
Form validation takes place when the validate() action is called or when the form is submitted.

### ajaxFormValidationURL
If set, the ajax submit validation will use this url instead of the form action

### ajaxFormValidationMethod
HTTP method used for ajax validation, defaults to 'get', can be set to 'post'

### onBeforeAjaxFormValidation(form, options)
When ajaxFormValidation is turned on, this is the function that will be called before the asynchronous AJAX form validation call. May return false to stop the Ajax form validation

### onAjaxFormComplete: function(status, form, errors, options)
When ajaxFormValidation is turned on, this function is used to asynchronously process the result of the validation. the status is a boolean. If true, the ajax call completed and all the server side form validations passed.

### onValidationComplete

When defined, it stops by default the form from auto-submitting, and lets you handle the validation status via a function. You can also return true in this function and the form will be allowed to submit.
```js
jQuery("#formID2").validationEngine('attach', {
onValidationComplete: function(form, status){
alert("The form status is: " +status+", it will never submit");
}
});
```

### custom_error_messages

This is where custom messages for IDs, Classes, or validation types are stored.

Custom error messages are exclusive from one another.ID messages will be displayed instead of anything else;
Class messages will only be used if there is no ID message, and only the first message found associated
with one of the classes will be used; Global Validator messages will only be used if there are no Class
messages or ID messages.

These custom messages are declared in this manner:
```js
jQuery("#formID2").validationEngine({'custom_error_messages' : {
'#someId' : {
'required': {
'message': "This is a custom message that is only attached to the input with id 'someId' if it
has the validation of 'required'. This will always display, even if it has other
custom messages."
},
'custom[min]': {
'message': "This is a custom message that is only attached to the input with id 'someID' if it
has the validation of 'custom[min[someNumber]]'. This will always display, even if
it has other custom messages."
}
},
'.someClass': {
'equals': {
'message': "This is a custom message that is only attached to inputs that have the class of
'someClass' and the validation type of 'equals'. This will be displayed only on
inputs without an ID message."
}
},
'required' {
'message': "This is a custom message that replaces the normal error message for the validation
'required'. This only displays when there are no Class or ID messages."
}
}
});
```

### focusFirstField

Specifies whether or not the first field in a form receives auto-focus after validation returns false. Default is set to *true*.
If you want to disable the auto-focusing use:
```js
$('#form').validationEngine('attach', {focusFirstField : false});
```

### onSuccess
If set, this callback function will be called when all validations passed.

### onFailure
If set, this callback function will be called when it found an error.

### autoPositionUpdate
Auto update prompt position after window resize, disabled by default

### autoHidePrompt
Determines if the prompt should hide itself automatically after a set period. Defaults to *false*.

### autoHideDelay
Sets the number of ms that the prompt should appear for if autoHidePrompt is set to *true*. Defaults to *10000*.

### showArrow
Show the arrow in the validation popup. Defaults to *true*

### showArrowOnRadioAndCheckbox
Show the arrow in the validation popup when validating checkboxes and radio buttons. Defaults to *false*

Validators
---

Validators are encoded in the field's class attribute, as follows

### required

Speaks for itself, fails if the element has no value. This validator can apply to pretty much any kind of input field.

```html

Choose a sport
Tennis
Football
Golf

```

### groupRequired

At least one of the field of the group must be filled. It needs to be given a group name that is unique across the form.

```html

```

### condRequired

This makes the field required, but only if any of the referred fields has a value.

```html

```

### custom[regex_name]

Validates the element's value to a predefined list of regular expressions.

```html

```

Please refer to the section *Custom Regex* for a list of available regular expressions.

### custom[function_name]

Validates the element's value to a predefined function included in the language file (compared to funcCall that can be anywhere in your application),

```html

```

Please refer to the section *Custom Regex* for a list of available regular expressions.

### funcCall[methodName]

Validates a field using a third party function call. If a validation error occurs, the function must return an error message that will automatically show in the error prompt.

```js
function checkHELLO(field, rules, i, options){
if (field.val() != "HELLO") {
// this allows the use of i18 for the error msgs
return options.allrules.validate2fields.alertText;
}
}
```

The following declaration will do

```html

```

### ajax[selector]

Delegates the validation to a server URL using an asynchronous Ajax request. The selector is used to identify a block of properties in the translation file, take the following for example.

** The validation execution order is taken form the order you put them in the HTML, it is recommended to always put the ajax[] validation last. For example, the custom events might fail if you put ajax[] in the middle. Ajax[] works on submit since 2.6.

```html

```
```js
"ajaxUserCall": {
"url": "ajaxValidateFieldUser",
"extraData": "name=eric",
"extraDataDynamic": ['#user_id', '#user_email'],
"alertText": "* This user is already taken",
"alertTextOk": "All good!",
"alertTextLoad": "* Validating, please wait"
},
```

* url - is the remote restful service to call
* extraData - optional parameters to send
* extraDataDynamic - optional DOM id's that should have their values sent as parameters
* alertText - error prompt message if validation fails
* alertTextOk - optional prompt if validation succeeds (shows green)
* alertTextLoad - message displayed while the validation is being performed

This validator is explained in further details in the Ajax section.

### equals[field.id]

Checks if the current field's value equals the value of the specified field.

### min[float]

Validates when the field's value is less than, or equal to, the given parameter.

### max[float]

Validates when the field's value is more than, or equal to, the given parameter.

### minSize[integer]

Validates if the element content size (in characters) is more than, or equal to, the given *integer*. integer <= input.value.length

### maxSize[integer]

Validates if the element content size (in characters) is less than, or equal to, the given *integer*. input.value.length <= integer

### past[NOW, a date or another element's name]

Checks if the element's value (which is implicitly a date) is earlier than the given *date*. When "NOW" is used as a parameter, the date will be calculate in the browser. When a "#field name" is used ( The '#' is optional ), it will compare the element's value with another element's value within the same form. Note that this may be different from the server date. Dates use the ISO format YYYY-MM-DD

```html

```

### future[NOW, a date or another element's name]

Checks if the element's value (which is implicitly a date) is greater than the given *date*. When "NOW" is used as a parameter, the date will be calculate in the browser. When a "#field name" is used ( The '#' is optional ), it will compare the element's value with another element's value within the same form. Note that this may be different from the server date. Dates use the ISO format YYYY-MM-DD

```html

// a date in 2009

```

### minCheckbox[integer]

Validates when a minimum of *integer* checkboxes are selected.
The validator uses a special naming convention to identify the checkboxes as part of a group.

The following example, enforces a minimum of two selected checkboxes

```html

```

Note how the input.name is identical across the fields.

### maxCheckbox[integer]

Same as above but limits the maximum number of selected check boxes.

### creditCard

Validates that a credit card number is at least theoretically valid, according the to the [Luhn checksum algorithm](http://en.wikipedia.org/wiki/Luhn_algorithm), but not whether the specific card number is active with a bank, etc.

Selectors
---

We've introduced the notion of selectors without giving many details about them: A selector is a string which is used as a key to match properties in the translation files.
Take the following example:

```js
"onlyNumber": {
"regex": /^[0-9\ ]+$/,
"alertText": "* Numbers only"
},
"ajaxUserCall": {
"url": "ajaxValidateFieldUser",
"extraData": "name=eric",
"alertText": "* This user is already taken",
"alertTextOk": " * User is valid",
"alertTextLoad": "* Validating, please wait"
},
"validate2fields": {
"alertText": "* Please input HELLO"
}
```

onlyNumber, onlyLetter and validate2fields are all selectors. jQuery.validationEngine comes with a standard set but you are welcome to add you own to define AJAX backend services, error messages and/or new regular expressions.

The ValidationEngine with a datepicker
---
Using a datepicker with the engine is problematic because the validation is bound to the blur event. since we lose the focus before any data is entered in the field it creates a weird bug.
Fortunately we implemented a fix that uses a delay during the datepicker binding.

To use this mode you need to add the class *datepicker* to your input, like this:

```html

```

Ajax Protocol
---

The ajax validator takes a selector as an attribute. the selector points to a structure that defines the URL to call, the different messages to display and any extra parameters to add on the URL (when applicable). Please refer to the **ajax[selector]** description for more details.

Ajax validation comes in two flavors:

1. Field Ajax validations, which take place when the user inputs a value in a field and moves away.
2. Form Ajax validation, which takes place when the form is submitted or when the validate() action is called.

Both options are optional.

```html

```

You can see a tutorial that makes the use of php here: [http://www.position-absolute.com/articles/using-form-ajax-validation-with-the-jquery-validation-engine-plugin/](http://www.position-absolute.com/articles/using-form-ajax-validation-with-the-jquery-validation-engine-plugin/)

### Field ajax validation

#### Protocol

The client sends the fieldId and the fieldValue as a GET request to the server url.

Client calls url?fieldId=id1&fieldValue=value1 ==> Server

Server responds with an array: [fieldid, status, errorMsg].

Client receives <== ["id1", boolean, errorMsg] Server

* fieldid is the name (id) of the field
* status is the result of the validation, true if it passes, false if it fails
* errorMsg is an optional error string (or a selector) to the prompt text. If no error msg is returned, the prompt message is expected to be part of the rule with key "alertText" or "alertTextOk" (see the structure of the translation file)

### Form ajax validation

#### Protocol

The client sends the form fields and values as a GET request to the form.action url.

Client calls url?fieldId=id1&fieldValue=value1&...etc ==> Server (form.action)

Server responds with an *array of arrays*: [fieldid, status, errorMsg].

* fieldid is the name (id) of the field
* status is the result of the validation, true if it passes, false if it fails
* errorMsg is an error string (or a selector) to the prompt text

Client receives <== [["id1", boolean,"errorMsg"],["id2", false, "there is an error "],["id3", true, "this field is good"]]

Note that normally errors (status=false) are returned from the server. However you may also decide to return an entry with a status=true in which case the errorMsg will show as a green prompt.

#### Validation URL
By default the engine use the form action to validate the form, you can however set a default url using:

**ajaxFormValidationURL

#### Callbacks

Since the form validation is asynchronously delegated to the form action, we provide two callback methods:

**onBeforeAjaxFormValidation(form, options)** is called before the ajax form validation call, it may return false to stop the request

**onAjaxFormComplete: function(form, status, json_response_from_server, options)** is called after the ajax form validation call

Custom Regex
---

jQuery.validationEngine comes with a lot of predefined expressions. Regex validation rules are specified as follows:

```html

```

Note that the selector identifies a given regular expression in the translation file, but also its associated error prompt messages and optional green prompt message.

### phone

a typical phone number with an optional country code and extension. Note that the validation is **relaxed**, please add extra validations for your specific country.

49-4312 / 777 777
+1 (305) 613-0958 x101
(305) 613 09 58 ext 101
3056130958
+33 1 47 37 62 24 extension 3
(016977) 1234
04312 - 777 777
91-12345-12345
+58 295416 7216

### url

Matches a URL such as http://myserver.com, https://www.crionics.com or ftp://myserver.ws

### email

Easy, an email : [email protected]

### date

An ISO date, YYYY-MM-DD

### number

Floating points with an optional sign. ie. -143.22 or .77 but also +234,23

### integer

Integers with an optional sign. ie. -635 +2201 738

### ipv4 and ipv6

An IP address (v4) ie. 127.0.0.1 or v6 2001:0db8:85a3:08d3:1319:8a2e:0370:7344

### onlyNumberSp

Only numbers and spaces characters

### onlyLetterSp

Only letters and space characters

### onlyLetterNumber

Only letters and numbers, no space

Position fixed and overflow scroll
---
Before 2.5.3 some options were needed to use the engine in a div with overflow scroll or position fixed, now you just have to set position relative on the form and you are good to go.

Placeholders
---
The engine support by default placeholders when a field is required. use the attribute data-validation-placeholder in the input to define it.

Hooks
---

The plugin provides some hooks using jQuery bind functionality.

* jqv.form.validating : Trigger when the form is submitted and before it starts the validation process
* jqv.field.result(event, field, errorFound, prompText) : Triggers when a field is validated with the result.
* jqv.form.result(event, errorFound) : Triggers when a form is validated with the result

An example of binding a custom function to these events would be:

```js
$("#formID").bind("jqv.form.result", function(event, errorFound) {
if(errorFound)
alert("There is a problem with your form");
});
```

Customizations
---

What would a good library be without customization?

### Adding regular expressions

Adding new regular expressions is easy: open your translation file and add a new entry to the list

```js
"onlyLetter": {
"regex": /^[a-zA-Z\ \']+$/,
"alertText": "* Letters only"
},
```

* "onlyLetter" is a sample selector name
* "regex" is a javascript regular expression
* "alertText" is the message to display when the validation fails

You can now use the new regular expression as such

```html

```

Don't forget to contribute!

### Customizing the look and feel

Edit the file *validationEngine.jquery.css* and customize the stylesheet to your liking. it's trivial if you know CSS.

### Adding more locales

You can easily add a locale by taking *jquery.validationEngine-en.js* as an example.
Feel free to share the translation ;-)

### Changing defaults options globally

You can, for example, disable the scrolling globally by using $.validationEngine.defaults.scroll = false.

This need to be added before the initialization, one good way to handle this would be to add your settings in a file.

```html

```

Using the validationEngine with modal & dialog plugins
---
You can have more information about implementing the engine with modal views here:
[http://www.position-absolute.com/articles/using-the-jquery-validation-engine-with-modal-plugins/]

Rules of thumb
---

* field.id is **unique** across the page
* From 2.2.4 and up, jquery 1.6+ is required because of prop()
* for simplicity and consistency field.id and field.name should match (except with minCheckbox and maxCheckbox validators)
* spaces or special chars should be avoided in field.id or field.name
* use lower case for input.type ie. *text, password, textarea, checkbox, radio*
* validators are evaluated from left to right, use the Ajax validator last e.g. validate[custom[onlyLetter],length[0,100],**ajax[ajaxNameCall]**]
* please use only one Ajax validator per field!
* JSON services should live on the same server (or you will get into browser security issues)
* in a perfect RESTful world, http **GET** is used to *READ* data, http **POST** is used to *WRITE* data: which translates into -> Ajax validations should use GET, the actual form post should use a POST request.

Contribution
---
Contributions are always welcome, please follow these steps to submit your changes:

1. Install git from [http://git-scm.com/](http://git-scm.com/)
2. Create a github account on [https://github.com](https://github.com)
3. Set up your git ssh key using these instructions [http://help.github.com/set-up-git-redirect](http://help.github.com/set-up-git-redirect)
4. Open the jQuery Validation Engine project home page on github on [https://github.com/posabsolute/jQuery-Validation-Engine](https://github.com/posabsolute/jQuery-Validation-Engine)
5. Click the "Fork" button, this will get you to a new page: your own copy of the code.
6. Copy the SSH URL at the top of the page and clone the repository on your local machine

```shell
git clone [email protected]:your-username/jQuery-Validation-Engine.git my-jqv-repo
```

7. Create a branch and switch to it

```shell
cd my-jqv-repo
git branch mynewfeature-patch
git checkout mynewfeature-patch
```

8. Apply your changes, then commit using a meaningful comment, that's the comment everybody will see!

```shell
git add .
git commit -m "Fixing issue 157, blablabla"
```

9. Push the changes back to github (under a different branch, here myfeature-patch)

```shell
git push origin mynewfeature-patch
```

10. Open your forked repository on github at https://github.com/your-username/jQuery-Validation-Engine
11. Click "Switch Branches" and select your branch (mynewfeature-patch)
12. Click "Pull Request"
13. Submit your pull request to JQV Developers

Support
---
We offer limited support on [http://www.stackoverflow.com/](http://www.stackoverflow.com/)

Use the tag jQuery-Validation-Engine

License
---
Licensed under the MIT License

Authors
---

Copyright(c) 2011 [Cedric Dugas](https://github.com/posabsolute) [http://www.position-absolute.com](http://www.position-absolute.com)

v2.0 Rewrite by [Olivier Refalo](https://github.com/orefalo) [http://www.crionics.com](http://www.crionics.com)