Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CharlGottschalk/approvejs
A simple JavaScript validation library that doesn't interfere
https://github.com/CharlGottschalk/approvejs
approve form form-validation javascript javascript-library validation validations validator
Last synced: 11 days ago
JSON representation
A simple JavaScript validation library that doesn't interfere
- Host: GitHub
- URL: https://github.com/CharlGottschalk/approvejs
- Owner: CharlGottschalk
- License: mit
- Created: 2016-07-15T14:51:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-11-11T15:40:09.000Z (about 3 years ago)
- Last Synced: 2024-11-01T01:16:22.475Z (13 days ago)
- Topics: approve, form, form-validation, javascript, javascript-library, validation, validations, validator
- Language: JavaScript
- Homepage: https://charlgottschalk.github.io/approvejs/docs/
- Size: 7.94 MB
- Stars: 336
- Watchers: 15
- Forks: 23
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ApproveJs
#### A simple validation library that doesn't interfere
  [](https://cdnjs.com/libraries/approvejs) [](https://travis-ci.org/CharlGottschalk/approvejs) 
---
ApproveJs doesn't automatically attach itself to input change events or form submit events. It also doesn't manipulate the DOM for you by automatically displaying errors. This allows you to automate validation how you want.
With a single method (`approve.value()`), you can decide how to handle validation.
If you like to be in control or have a little OCD like me, ApproveJs is for you.
ApproveJs is also easily extended with [custom tests](https://charlgottschalk.github.io/approvejs/docs/custom-tests).
---
### Installation
##### Standalone
[Download Latest Release](https://github.com/CharlGottschalk/approvejs/archive/master.zip)
Unzip `master.zip` into your desired folder and add a `script` tag to the library before the end of your closing `` tag
```html
```
##### Bower
In your terminal run:
```
$ bower install approvejs
```
Add a `script` tag to the library before the end of your closing `` tag
```html
```
##### cdnjs
Add a `script` tag to the library CDN url before the end of your closing `` tag
```html
```
Get the cdn urls from [here](https://cdnjs.com/libraries/approvejs)
*Many thanks to [cdnjs](https://cdnjs.com/) who kindly hosts ApproveJS through a reliable CDN*
##### Node
In your terminal run:
```
$ npm install approvejs
```
or if you're using [Yarn](https://yarnpkg.com/)
```
$ yarn add approvejs
```
Require `approvejs`.
```javascript
var approve = require('approvejs');
```
---
### Usage
ApproveJS exposes a single method `value` that takes two parameters.
The first parameter is the value to validate and the second is the set of rules to test against.
```javascript
var rules = {
required: true,
email: true
};
var result = approve.value('[email protected]', rules);
```
The returned `result` contains two properties:
```javascript
{
approved: boolean,
errors: []
}
```
#### Accessing Errors
You can access errors returned by the result in one of two ways:
##### Errors Property
```javascript
var i = result.errors.length;
while(i--) {
console.log(result.errors[i]);
}
```
##### `.each` Method
The result object exposes an `each()` method for easily getting to errors.
```javascript
result.each(function(error) {
console.log(error);
});
```
---
Read [documentation here](https://charlgottschalk.github.io/approvejs/docs/).
If you would like to contribute to the project, please read [contributing](https://charlgottschalk.github.io/approvejs/docs/contributing/).