https://github.com/yousef-hatem/validation-all
validation using JavaScript
https://github.com/yousef-hatem/validation-all
class-validator form form-validation forms input javascript node validate-js validation validations
Last synced: 9 days ago
JSON representation
validation using JavaScript
- Host: GitHub
- URL: https://github.com/yousef-hatem/validation-all
- Owner: Yousef-Hatem
- License: mit
- Created: 2021-06-11T13:13:30.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-02-12T00:29:23.000Z (about 3 years ago)
- Last Synced: 2025-06-14T12:20:43.856Z (11 months ago)
- Topics: class-validator, form, form-validation, forms, input, javascript, node, validate-js, validation, validations
- Language: JavaScript
- Homepage:
- Size: 55.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Validation All
A library of data validation tools.
The **Validation All** library makes data validation in JavaScript very easy.
## Why use Validation All?
- Ease of handling and use.
- You can validate data without writing a single line of JavaScript.
- Using Bootstrap to display the error message.
- ES6 support and ES5 support.
- Control the display of messages through the **message-view** file
## Installation
### Using npm
`npm i validation-all`
### Calling the library in project
#### JavaScript
```js
const validation = require("validation-all").validation;
```
#### HTML
```html
```
# Basic Usage
You can do the validation with JavaScript or HTML
## JavaScript
```js
validation(input).email(); //=> true or false
```
**input** {Element} the input you want to validate and you can also replace it with data directly for example `validation('test@gmail.com').email()`
**email** verification type
### Options
```js
validation(input, {
required: true,
view: true,
errorMessage: "error",
correctMessage: "correct",
}).email(); //=> true or false
```
- **required** - Determine whether **input** is required or not
- The default value is `input.required`
- **view** - Influence of **input** when true or false
- The default value will be `true` if the input has class `form-control`, If this class does not exist, the default value will be `false`
- **errorMessage** - The message appears when the result is false
- The default value is the error message placed in the `message-view` file of "email" or the validation type specified
- **correctMessage** - The message appears when the result is true
- The default value is the correct message placed in the `message-view` file of "email" or the validation type specified
## HTML
Notice: To use HTML only to validate the input you must be a [Bootstrap](https://getbootstrap.com) library caller
```html
```
**vaal-form** {class} This class defines that you are using validation-all in this form
**vaal-email** {class} Specify the type of verification in this input
### Options
```html
```
- **vaal-msg-error** - This message will be displayed when the value is wrong
- **vaal-msg-correct** - This message will be displayed when the value is true
- **required** - To make **input** required
# Verification types
Explanation of all verification orders
## email
Verify the email is correct
### JavaScript Syntax
```js
validation(input).email(); //=> true or false
```
### HTML Syntax
```html
```
## password
To check how hard the password is there are 3 levels of difficulty
### JavaScript Syntax
```js
validation(input).password(); //=> true or false
```
#### Options
```js
validation(input).password({
level: "complex",
resetPassword: reset,
}); //=> true or false
```
- **complex** - Required password difficulty level
- There are 3 levels `(simple, complex, difficult)`
- **reset** {Element} - Input field Return password
### HTML Syntax
```html
```
#### Options
```html
```
- **vaal-level** - Required password difficulty level
- There are 3 levels `(simple, complex, difficult)`
- **vaal-reset-password** {class} - Input field Return password
## file
Verify that the file exists and check the format of the file
### JavaScript Syntax
```js
validation(input).file(); //=> true or false
```
#### Options
```js
validation(input).file(["png", "jpg"]); //=> true or false
```
- **[formulas]** {Array} Array in the required formats
### HTML Syntax
```html
```
#### Options
```html
```
- **[vaal-formats]** Required formats
## phone
Verify phone numbers
### JavaScript Syntax
```js
validation(input).phone("+20", 10); //=> true or false
```
- **['+20']** Phone number key or you can type the numbers you want the phone number to start with
- You can also add more than one number to the beginning of the phone number `Example: ['010', '011', '012']`
- **10** {number} The number of digits you want after the phone number key
### HTML Syntax
```js
```
- **vaal-start** The phone number key is added or you can type the numbers you want the phone number to start with
- You can also add more than one number to the beginning of the phone number `Example: vaal-start="010,011,012"`
- **vaal-length** Specify the number of digits you want after the phone number key
## url
Check URL
### JavaScript Syntax
```js
validation(input).url(); //=> true or false
```
### HTML Syntax
```js
```
## number
To check the number
### JavaScript Syntax
```js
validation(input).number(); //=> true or false
```
#### Options
```js
validation(input).number(min, max);
```
- **min** {number} Specify min length
- **max** {number} Specify max length
### HTML Syntax
```html
```
#### Options
```html
```
- **vaal-min** {number} Specify min length
- **vaal-max** {number} Specify max length
## integer
Check that the integer
### JavaScript Syntax
```js
validation(input).integer(); //=> true or false
```
#### Options
```js
validation(input).integer(min, max);
```
- **min** {number} Specify min length
- **max** {number} Specify max length
### HTML Syntax
```html
```
#### Options
```html
```
- **vaal-min** {number} Specify min length
- **vaal-max** {number} Specify max length
## checkbox
To make sure that he pressed the checkbox
### JavaScript Syntax
```js
validation(input).checkbox(); //=> true or false
```
### HTML Syntax
```html
```
## radio
To make sure he pressed the radio
### JavaScript Syntax
```js
validation(input).radio(); //=> true or false
```
### HTML Syntax
```html
```
## required
Make the required input
### JavaScript Syntax
```js
validation(input).required(); //=> true or false
```
### HTML Syntax
```html
```
## rules
Used to specify the type of verification, the maximum length and the minimum length
### JavaScript Syntax
```js
validation(input).rules({
type: "url",
min: 10,
max: 55,
}); //=> true or false
```
- **type** Select the type of verification
- You can specify **string** or **number** or **integer** or **email** or **url**
- **min** {number} Specify min length
- **max** {number} Specify max length
### HTML Syntax
```html
```
- **vaal-type** Select the type of verification
- You can specify **string** or **number** or **integer** or **email** or **url**
- **vaal-min** {number} Specify min length
- **vaal-max** {number} Specify max length
# message-view
- This file contains all messages used for validation
- These messages are used when messages are not specified
## Writing Validation Messages
You must first call `messageView`
```js
import { validation, messageView } from "validation-all";
```
You will create an object containing the messages you want to use
```js
var validationMsg = {
checkbox: { error: "", correct: "" },
radio: { error: "", correct: "" },
email: { error: "sorry, this email is incorrect", correct: "" },
required: { error: "this field is required", correct: "" },
number: { error: "the figure is incorrect", correct: "" },
integer: { error: "the figure is incorrect", correct: "" },
file: { error: "this file format is incorrect", correct: "" },
url: { error: "sorry, but this link is incorrect", correct: "" },
phone: { error: "sorry, but this phone number is incorrect", correct: "" },
resetPassword: {
error: "sorry, but the password does not match",
correct: "",
},
password: {
simple: {
error: "sorry, but the password must be at least 8",
correct: "",
},
complex: {
error:
"sorry, but the password must be at least 8 and contain letters and numbers",
correct: "",
},
difficult: {
error:
"sorry, but the password must be at least 8 and contain uppercase and lowercase letters, numbers and symbols",
correct: "",
},
},
};
for (const key in validationMsg) {
messageView[key] = validationMsg[key];
}
```
These are the default message names. You can add a new message name and use it
```js
userName: { error: 'This username is already in use', correct: '' }
```
- **userName** {message name} It will be used to invoke the message from the object
#### To use any message you have added to the object (validationMsg) Use **error** or **correct**
```js
validation(input).correct("userName"); // => '';
validation(input).error("userName"); // => 'This username is already in use';
```
- **userName** I type the name of the message you want to use
- **error - correct** If you use the error function, the error message will be displayed, and If you use the correct function, the correct message will be displayed
- **input** the input in which the message will be displayed
## License (MIT)
```
Copyright (c) 2023 Yousef Hatem
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```