Skip to content

Commit 6cda8c0

Browse files
author
shankarThiyagaraajan
committed
Merge remote-tracking branch 'origin/dev' into dev
2 parents 9325b4c + f3864de commit 6cda8c0

File tree

1 file changed

+23
-39
lines changed

1 file changed

+23
-39
lines changed

README.md

Lines changed: 23 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
## Global Source - JavaScript Form Validator [Ready to Use]
22

33

4-
[![Packagist](https://img.shields.io/badge/JavaScript-Core-blue.svg)](https://github.com/global-source/javascript_form_validator) [![Packagist](https://img.shields.io/badge/JavaScript-ES6-green.svg)](https://github.com/global-source/javascript_form_validator) [![Packagist](https://img.shields.io/badge/Build-Alpha-lightgrey.svg)](https://github.com/global-source/javascript_form_validator) [![License](https://img.shields.io/badge/Version-v.0.9-blue.svg)](https://github.com/shankarThiyagaraajan/PHP_Migration/blob/master/LICENSE)
4+
[![Packagist](https://img.shields.io/badge/JavaScript-Core-brightgreen.svg)](https://github.com/global-source/javascript_form_validator) [![Packagist](https://img.shields.io/badge/JavaScript-ES6-green.svg)](https://github.com/global-source/javascript_form_validator) [![License](https://img.shields.io/badge/Build-V.2.0-blue.svg)](https://github.com/shankarThiyagaraajan/PHP_Migration/blob/master/LICENSE)
55

66

77
### Installation
88

99
git clone https://github.com/global-source/javascript_form_validator.git
1010

11-
git checkout master
11+
--or--
12+
13+
composer require global-source/javascript-form-validator
1214

15+
1316
## Why this ?
1417

1518
* Support **Native** and **ES6** Javascript,
@@ -23,27 +26,20 @@
2326
**Steps to Integrate to Form :**
2427

2528
```html
26-
<script src="./../src/js/formValidator.js"></script>
29+
<script src="formValidator.js"></script>
2730
or
28-
<script src="./../src/js/formValidator.es6.js"></script>
31+
<script src="formValidator.es6.js"></script>
2932
```
3033

3134
Then Integrate your form with Validator.
3235

3336
```javascript
3437

35-
// Core
36-
var myform = jsValidator.init({
37-
form: 'form2submit', // #id
38-
});
39-
40-
// ES6
4138
var myform = new jsValidator().init({
4239
form: 'form2submit', // #id
4340
});
44-
41+
4542
```
46-
4743
4844

4945
## Options
@@ -76,10 +72,13 @@ Then Integrate your form with Validator.
7672
| Name | Values | Descriptions |
7773
| ----------------- | --------------- | ---------------------------------------------------------------------------- |
7874
| required | True, False | Set the fields is required to submit the Form. |
79-
| type="min" | Integer | To set the Minimun length of characters to proceed. |
80-
| type="max" | Integer | To set the Maximum length of characters to proceed. |
75+
| min | Integer | To set the Minimun value to proceed. |
76+
| max | Integer | To set the Maximum value to proceed. |
77+
| data-maxlength="10" | Integer | To set the Maximum length of characters to proceed. |
78+
| maxLength="10" | Integer | To set the Maximum length of characters to proceed. |
8179
| type="password" | AlphaNumeric | To set and compare password. |
8280
| type="email" | AlphaNumeric | To check the email is valid or not. |
81+
| type="file" | string ['png,jpeg..'] | To check the file format is allowed or not. |
8382
| data-message="Error Message"| String | User defined, element based direct error message to handle. |
8483
| data-allow="onlyAlpha"| a-zA-Z Only | Allow only string, no digits and no special characters. |
8584
| data-allow="string"| a-zA-Z0-9 Only | Allow only string and digits, no special characters. |
@@ -134,6 +133,10 @@ It has automated listener to monitor every changes on form.
134133
<label>Email Validator</label>
135134
<input type="email" name="email" required>
136135
</div>
136+
<div>
137+
<label for="file">File</label>
138+
<input type="file" required class="form-control" id="file" data-extensions="png,jpeg,jpg" name="file">
139+
</div>
137140
<div>
138141
<label>Password</label>
139142
<input type="password" name="password" data-check="repassword" id="password" required>
@@ -159,15 +162,8 @@ It has automated listener to monitor every changes on form.
159162
</div>
160163
</form>
161164
```
162-
163-
3. Every Input Fields should have a Label with **`FOR`** attributes.
164165

165-
```html
166-
<label for="uname">Name :</label>
167-
<input type="text" name="uname" required>
168-
```
169-
170-
4. In form use **`novalidate`** to avoid browser interuptions.
166+
3. In form use **`novalidate`** to avoid browser interuptions.
171167

172168
```html
173169
<form method="POST/GET/PUT/PATCH/DELETE.." action="PATH TO HANDLE" id="form2submit" ... novalidate>
@@ -180,29 +176,17 @@ It has automated listener to monitor every changes on form.
180176

181177
```javascript
182178

183-
// For Native-Javascript
184-
var myform = jsValidator.init({
185-
form: 'form2submit', // #id
186-
forceFilter: true,
187-
message: {
188-
required: 'This field is required !',
189-
min: '<br><span style="color: red;">This field is less then the limit [INDEX]</span>',
190-
max: 'This field is exceeds the limit of [INDEX]',
191-
password: 'Password doesn\'t match !',
192-
email: 'Invalid Email found !'
193-
}
194-
});
195-
196-
// For ES6
179+
// For Native & ES6 Javascript.
197180
var myform = new jsValidator().init({
198181
form: 'form2submit', // #id
199182
forceFilter: true,
200183
message: {
201184
required: 'This field is required !',
202-
min: '<br><span style="color: red;">This field is less then the limit [INDEX]</span>',
203-
max: 'This field is exceeds the limit of [INDEX]',
185+
min: '<br><span style="color: red;">This field is less then the limit</span>',
186+
max: 'This field is exceeds the limit',
204187
password: 'Password doesn\'t match !',
205-
email: 'Invalid Email found !'
188+
email: 'Invalid Email found !',
189+
file: 'Invalid File format given'
206190
}
207191
});
208192

0 commit comments

Comments
 (0)