50 lines
2.2 KiB
Markdown
50 lines
2.2 KiB
Markdown
|
# Validator, for Bootstrap 3
|
||
|
|
The Validator plugin offers automatic form validation configurable via mostly HTML5 standard attributes.
|
||
|
|
It also provides an unobtrusive user experience, because nobody likes a naggy form.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
- Configurable via data-api and standard HTML5 attributes
|
||
|
|
- Patient to inform user of errors and eager to let them know the errors have been resolved
|
||
|
|
- Submit is disabled until the form is valid and all required fields are complete
|
||
|
|
- Customizable error messages
|
||
|
|
- Custom validator functions
|
||
|
|
- Validation of an input field via AJAX
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
* CDN on [CDNJS](https://cdnjs.com): https://cdnjs.com/libraries/1000hz-bootstrap-validator
|
||
|
|
* Clone the repo: `git clone https://github.com/1000hz/bootstrap-validator.git`.
|
||
|
|
* Install with [Bower](http://bower.io): `bower install bootstrap-validator`.
|
||
|
|
* Install with [npm](https://www.npmjs.com): `npm install bootstrap-validator`.
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
See the project docs at http://1000hz.github.io/bootstrap-validator
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
#### Found an issue?
|
||
|
|
Be sure to include a reproducible test case on JS Bin with your report. Here's a [template](http://jsbin.com/fopaposaci/1/edit?html,js,output) to get started.
|
||
|
|
#### Submitting a pull request?
|
||
|
|
Fork this repo and create a new branch for your patch.
|
||
|
|
Try to adhere to the code style of Bootstrap 3's JS as much as possible.
|
||
|
|
Be sure to add any relevant unit tests.
|
||
|
|
Make sure everything's still ok by running `grunt test`.
|
||
|
|
Lastly, don't pollute your patch branch with any unrelated changes.
|
||
|
|
|
||
|
|
## Donating
|
||
|
|
If you've found this project particularly useful and feel like giving a little back, you can donate what you want via PayPal or Square Cash.
|
||
|
|
|
||
|
|
<a href="https://paypal.me/1000hz"><img src="https://img.shields.io/badge/Donate-PayPal-blue.svg" alt="Donate via PayPal"></a>
|
||
|
|
<a href="https://cash.me/$cina"><img src="https://img.shields.io/badge/Donate-Square Cash-brightgreen.svg" alt="Donate via Square Cash"></a>
|
||
|
|
|
||
|
|
|
||
|
|
## Author
|
||
|
|
|
||
|
|
**Cina Saffary**
|
||
|
|
- http://twitter.com/1000hz
|
||
|
|
- http://github.com/1000hz
|
||
|
|
|
||
|
|
Thanks to [@mdo](https://github.com/mdo) and [@fat](https://github.com/fat) for [Bootstrap](http://getbootstrap.com). <3
|
||
|
|
|
||
|
|
## Copyright and license
|
||
|
|
Copyright 2016 Cina Saffary under the MIT license.
|