Package Exports
- html-form-validation
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (html-form-validation) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Validator
This module is to validate HTML forms. Text fields, emails, phones, checkobxes etc.
Installation
Install validator module
npm i -save html-form-validationAdd validator to your project
AMD
require(['html-form-validation', function (Validator) {});CommonJS
var Validator = require('html-form-validation');ES6
import Validator from 'html-form-validation';Inline
<script src="html-form-validation.js"></script>Also, include CSS file (src/css/validator.css)
<link href="validator.css" rel="stylesheet">Usage
Validator module needs proper HTML-markup (more in example section)
<form>
<!--Email field-->
<label class="form-input" data-validation="required" data-validation-type="email">
<input type="email">
<div class="error"></div>
</label>
<!--Text field. With min and max length (can be only 'min' or only 'max')-->
<label class="form-input" data-validation="required" data-validation-type="text">
<textarea data-validation-condition="length" data-min-length="50" data-max-length="200"></textarea>
<div class="error"></div>
</label>
<!--Text field. With custom error message, 'equal' codition-->
<label class="form-input" data-validation="required" data-validation-type="text" data-validation-text="Incorrect data">
<input type="text" data-validation-condition="equal" data-equal="dataToCompare">
<div class="error"></div>
</label>
<!--Validate form button-->
<button class="validate-form-button" type="submit">Validate form</button>
</form>Initialize validator module
/**
* First param. Form to validate.
*
* @type {jQuery|HTMLElement|String}
*/
var form = $('form');
/**
* Second param. Function performed after validation (if form is valid). Should return options for ajax request performed after.
*
* @type {Function|Object}
* @return {Object} options for ajax request
*/
var onSuccess = function (context) {
console.log('this code runs before ajax request');
return {
url: 'ajax/example.json',
method: 'get',
success: function () {
console.log('ajax success callback');
}
}
};
/**
* Third param. User-specified options. Unnecessary.
*
* @type {Object}
*/
var options = {
// If form is situated in bootstrap modal (login form etc.),
// incorrect field state will be removed when modal is closed.
// DEFAULT: false
modal: false,
// Selector to find form's fields.
// When changing, you should also change CSS styles.
// DEFAULT: '.form-input'.
fieldsSelector: '.form-input',
// Remove fields incorrect state, when clicked outside the form.
// DEFAULT: false.
removeOnFocusOut: false,
// Perform AJAX request with specified options if form is valid.
// DEFAULT: true.
ajax: true
};
/** Initialize Validator */
new Validator(form, onSuccess, options);
/** Or initialize with jQuery */
form.validator(onSuccess, options);On success function can perform async actions before returning ajax options object (only ES7 version)
const onSuccess = context => {
// function should return Promise
return new Promise((resolve, reject) => {
// perform async actions. main ajax request will be performed on promise resolve
$.ajax({
url: 'path/to/async/action',
method: 'get',
// remember, function must return options for AJAX request
success: res => resolve({
url: 'path/to/main/ajax',
method: 'post',
success: res => console.log(res)
}),
error: xhr => reject(xhr)
});
})
};Options (form fields)
| Option name | Possible values | Description |
|---|---|---|
| data-validation | required / false | Validates the field when set to true. |
| data-validation-type | text / phone / email / checkbox / radio / select | Which method used to validate field. Each type has its own. |
| data-validation-text | any string | Text used as error message. Otherwise validator will use its own messages for every field type. |
Field types
| Type | Description | Available input types |
|---|---|---|
| text | Validates text field. Input can have additional attribute data-validation-condition with available length and equal values. If set to length - Validator will look for data-min-length, data-max-length or data-length attributes. If set to equal - Validator will look for data-equal attribute. Then validator will match value with values from attributes. | input / textarea |
| phone | Under development. No additional options are available. | input |
| Validates email field. No additional options are available. | input | |
| checkbox | At least one checkbox in field should be checked and visible. No additional options are available. | input[type="checkbox"] |
| radio | At lease one radio should be selected. No additional options are available. | input[type="radio"] |
| select | Checks for selected option. Its value should not equal 0 or false. No additional options are available. | select |
Requirement
Tests (not ready yet)
Run tests
npm run-script runTestVersioning
Current version is 0.1.5
Authors
- Shapovalov Vitali