MontoyaTech/ignite-html-validate
MontoyaTech/ignite-html-validate
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Changing docs to help VSCode detect extensions.

Browse Source
This commit is contained in:
Matt Mo 2021-08-24 15:28:05 -07:00
parent 7e0c6a952c
commit 742bbb8e2e
1 changed files with 41 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
ignite-html-validate.js
View File

@ -99,40 +99,48 @@ function notify(target, type, msg, duration) {
* @param {Number} duration The number of miliseconds to show the error. Default is 4000. -1 is infinite.
* @returns {HTMLElement} The created notification HTMLElement.
*/
HTMLElement.prototype.error = function (msg, duration = 4000) {
function error(msg, duration = 4000) {
return notify(this, "error", msg, duration);
}
HTMLElement.prototype.error = error;
/**
* Shows a warning message on a given HTMLElement.
* @param {string|Function} msg The warning message to show.
* @param {Number} duration The number of miliseconds to show the warning. Default is 4000. -1 is infinite.
* @returns {HTMLElement} The created notification HTMLElement.
*/
HTMLElement.prototype.warning = function (msg, duration = 4000) {
function warning(msg, duration = 4000) {
return notify(this, "warning", msg, duration);
}
HTMLElement.prototype.warning = warning;
/**
* Shows a success message on a given HTMLElement.
* @param {string|Function} msg The success message to show.
* @param {Number} duration The number of miliseconds to show the notification. Default is 4000. -1 is infinite.
* @returns {HTMLElement} The created notification HTMLElement.
*/
HTMLElement.prototype.success = function (msg, duration = 4000) {
function success(msg, duration = 4000) {
return notify(this, "success", msg, duration);
}
HTMLElement.prototype.success = success;
/**
* Shows a info message on a given HTMLElement.
* @param {string|Function} msg The info message to show.
* @param {Number} duration The number of miliseconds to show the notification. Default is 4000. -1 is infinite.
* @returns {HTMLElement} The created notification HTMLElement.
*/
HTMLElement.prototype.info = function (msg, duration = 4000) {
function info(msg, duration = 4000) {
notify(this, "info", msg, duration);
}
HTMLElement.prototype.info = info;
/**
* Validates an input when changed.
* @param {Function|IgniteProperty} callback The callback function to invoke in order to validate changes to an input.
@ -144,7 +152,7 @@ HTMLElement.prototype.info = function (msg, duration = 4000) {
* })
* @returns {IgniteTemplate} This ignite template.
*/
IgniteTemplate.prototype.validate = function (callback) {
function validate(callback) {
//Setup the validators array if it doesn't exist.
if (!this._validators) {
this._validators = [];
@ -197,14 +205,16 @@ IgniteTemplate.prototype.validate = function (callback) {
});
return this;
};
}
IgniteTemplate.prototype.validate = validate;
/**
* Validates an input to make sure it contains a valid email address.
* @param {string|Function|IgniteProperty} msg The message to display when the email is incorrect. If null a default one will show.
* @returns {IgniteTemplate} This ignite template.
*/
IgniteTemplate.prototype.validateEmail = function (msg) {
function validateEmail(msg) {
return this.validate((value, error) => {
if (!value || value.trim().length < 5) {
return error(msg ? msg : `Email address too short.`);
@ -220,12 +230,14 @@ IgniteTemplate.prototype.validateEmail = function (msg) {
});
}
IgniteTemplate.prototype.validateEmail = validateEmail;
/**
* Validates an input to make sure it contains a valid password.
* @param {string|Function|IgniteProperty} msg The message to display when the email is incorrect. If null a default one will show.
* @returns {IgniteTemplate} This ignite template.
*/
IgniteTemplate.prototype.validatePassword = function (msg) {
function validatePassword(msg) {
return this.validate((value, error) => {
if (!value || value.trim().length < 5) {
return error(msg ? msg : `Password is too short.`);
@ -237,13 +249,15 @@ IgniteTemplate.prototype.validatePassword = function (msg) {
});
}
IgniteTemplate.prototype.validatePassword = validatePassword;
/**
* Validates an input to make sure it contains a min number of characters.
* @param {Number} min The min number of characters the input can have.
* @param {string|Function|IgniteProperty} msg The message to display when the input length is too short. If null a default one will show.
* @returns {IgniteTemplate} This ignite template.
*/
IgniteTemplate.prototype.validateMin = function (min, msg) {
function validateMin(min, msg) {
return this.validate((value, error) => {
if (!value || value.toString().trim().length < min) {
return error(msg ? msg : `Input must contain at least ${min} character(s).`);
@ -251,13 +265,15 @@ IgniteTemplate.prototype.validateMin = function (min, msg) {
});
}
IgniteTemplate.prototype.validateMin = validateMin;
/**
* Validates an input to make sure it contains a max number of characters.
* @param {Number} max The max number of characters the input can have.
* @param {string|Function|IgniteProperty} msg The message to display when the input length is too long. If null a default one will show.
* @returns {IgniteTemplate} This ignite template.
*/
IgniteTemplate.prototype.validateMax = function (max, msg) {
function validateMax(max, msg) {
return this.validate((value, error) => {
if (!value || value.toString().trim().length > max) {
return error(msg ? msg : `Input must contain less than ${max} character(s).`);
@ -265,13 +281,15 @@ IgniteTemplate.prototype.validateMax = function (max, msg) {
});
}
IgniteTemplate.prototype.validateMax = validateMax;
/**
* Validates an input to make sure it it's value is not the given value.
* @param {Any} expected The value the input cannot have in order to be considered valid.
* @param {string|Function|IgniteProperty} msg The message to display when the input length is too long. If null a deafult one will show.
* @returns {IgniteTemplate} This ignite template.
*/
IgniteTemplate.prototype.validateNot = function(expected, msg) {
function validateNot(expected, msg) {
return this.validate((value, error) => {
if (!value || value == expected) {
return error(msg ? msg : `Input cannot be ${expected}.`);
@ -279,13 +297,15 @@ IgniteTemplate.prototype.validateNot = function(expected, msg) {
});
}
IgniteTemplate.prototype.validateNot = validateNot;
/**
* Validates an input to make sure it includes a string.
* @param {string} str The string that the input must include.
* @param {string|Function|IgniteProperty} msg The message to display when the input doesn't contain the string. If null a default one will show.
* @returns {IgniteTemplate} This ignite template.
*/
IgniteTemplate.prototype.validateIncludes = function (str, msg) {
function validateIncludes(str, msg) {
return this.validate((value, error) => {
if (!value || !value.toString().includes(str)) {
return error(msg ? msg : `Input must contain ${str}.`);
@ -293,13 +313,15 @@ IgniteTemplate.prototype.validateIncludes = function (str, msg) {
});
}
IgniteTemplate.prototype.validateIncludes = validateIncludes;
/**
* Validates an input to make sure it matches a given value.
* @param {string|Function|IgniteProperty} compare The value to compare against the input.
* @param {string|Function|IgniteProperty} msg The message to display when the input doesn't match. If null a default one will show.
* @returns {IgniteTemplate} This ignite template.
*/
IgniteTemplate.prototype.validateMatches = function (compare, msg) {
function validateMatches(compare, msg) {
return this.validate((value, error) => {
if (compare instanceof Function) {
if (compare() != value) {
@ -315,11 +337,13 @@ IgniteTemplate.prototype.validateMatches = function (compare, msg) {
});
}
IgniteTemplate.prototype.validateMatches = validateMatches;
/**
* Validates all the children of an element and returns if they are valid or not.
* @returns {Boolean} Whether or not all the children of this element are valid.
*/
HTMLElement.prototype.validateAll = function () {
function validateAll() {
var elements = this.getElementsByTagName("*");
for (var i = 0; i < elements.length; i++) {
if (elements[i].validate != undefined && !elements[i].validate()) {
@ -328,3 +352,5 @@ HTMLElement.prototype.validateAll = function () {
}
return true;
}
HTMLElement.prototype.validateAll = validateAll;