|
| 1 | +# BootstrapValidator - [v0.4.5](https://github.com/nghuuphuoc/bootstrapvalidator/releases/download/v0.4.5/bootstrapvalidator-dist-0.4.5.zip) |
| 2 | + |
| 3 | +[http://bootstrapvalidator.com](http://bootstrapvalidator.com) - The best jQuery plugin to validate form fields. Designed to use with [Bootstrap 3](http://getbootstrap.com) |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +## Help the project |
| 8 | + |
| 9 | +I've been spending a lot of time to work on this plugin. If it is useful to you, please consider to help the project by making a small donation: |
| 10 | + |
| 11 | +<a href="https://pledgie.com/campaigns/24885"><img alt="Click here to lend your support to: BootstrapValidator and make a donation at pledgie.com!" src="https://pledgie.com/campaigns/24885.png?skin_name=chrome" border="0" /></a> |
| 12 | + |
| 13 | +Also, you can make me feel happy by [tweeting](https://twitter.com/intent/tweet?hashtags=javascript,jquery,twbootstrap&original_referer=http://github.com/nghuuphuoc/bootstrapvalidator&text=BootstrapValidator%20is%20the%20best%20jQuery%20plugin%20to%20validate%20form%20fields&url=http://bootstrapvalidator.com) about it and [staring](https://github.com/nghuuphuoc/bootstrapvalidator/stargazers) the project on Github. |
| 14 | + |
| 15 | +## Live demo |
| 16 | + |
| 17 | +http://bootstrapvalidator.com/examples/ |
| 18 | + |
| 19 | +## Features |
| 20 | + |
| 21 | +__Code__ |
| 22 | +* Written from scratch |
| 23 | +* Very solid and clean |
| 24 | +* The core plugin and validators code are separated |
| 25 | + |
| 26 | +__Bootstrap__ |
| 27 | +* Designed to use with [Bootstrap 3](http://getbootstrap.com) |
| 28 | +* Support almost [Bootstrap forms](http://getbootstrap.com/css/#forms) |
| 29 | +* Support Bootstrap form [validation states](http://getbootstrap.com/css/#forms-control-validation) |
| 30 | + |
| 31 | +__HTML 5__ |
| 32 | +* Support setting the plugin, validator options via [HTML 5 attributes](http://bootstrapvalidator.com/examples#attribute) prefixed with ```data-bv-``` |
| 33 | +* Support HTML 5 attributes such as ```min```, ```max```, ```pattern```, ```required``` |
| 34 | +* Support [HTML 5 input types](http://bootstrapvalidator.com/examples#html5) such as ```color```, ```email```, ```range``` and ```url``` |
| 35 | + |
| 36 | +__Validator__ |
| 37 | +* [41 built-in validators](http://bootstrapvalidator.com/validators/) and counting! |
| 38 | +* Easy to [write a new validator](http://bootstrapvalidator.com/developing/) |
| 39 | + |
| 40 | +__Friendly__ |
| 41 | +* Show [feedback icons](http://bootstrapvalidator.com/settings/#feedback-icons) based on field validity |
| 42 | +* Support [Glyphicons](http://getbootstrap.com/components/#glyphicons) and [FontAwesome](http://fontawesome.io/icons) icons |
| 43 | +* Focus on the first invalid field |
| 44 | + |
| 45 | +__Ajax__ |
| 46 | +* Support [validating via Ajax](http://bootstrapvalidator.com/validators/remote/) |
| 47 | +* Support using Ajax for form submission |
| 48 | + |
| 49 | +__Flexible__ |
| 50 | +* The elements can be defined by either ```name``` or [CSS selector](http://bootstrapvalidator.com/settings/#selector-example) |
| 51 | +* Support multiple elements with the [same name](http://bootstrapvalidator.com/examples/#fields-with-same-name) |
| 52 | +* Possible to indicate [excluded](http://bootstrapvalidator.com/settings/#excluded) fields |
| 53 | +* Field validators can be enabled/disabled on the fly |
| 54 | + |
| 55 | +__Compatibility__ |
| 56 | +* [Color Picker](http://mjolnic.github.io/bootstrap-colorpicker/) |
| 57 | +* [Date Picker](http://eternicode.github.io/bootstrap-datepicker/), [Datetime Picker](http://eonasdan.github.io/bootstrap-datetimepicker/) |
| 58 | +* [Select2](http://ivaynberg.github.io/select2/) |
| 59 | +* [Raty](http://wbotelhos.com/raty) |
| 60 | +* ... We [play nice](http://bootstrapvalidator.com/examples/#compatibility) with all of them! |
| 61 | + |
| 62 | +## Required |
| 63 | + |
| 64 | +* [jQuery](http://jquery.com/) |
| 65 | +* [Bootstrap 3](http://getbootstrap.com/) |
| 66 | + |
| 67 | +## Download |
| 68 | + |
| 69 | +Latest version: [v0.4.5](https://github.com/nghuuphuoc/bootstrapvalidator/releases/download/v0.4.5/bootstrapvalidator-dist-0.4.5.zip), released on 2014-05-15. |
| 70 | + |
| 71 | +For older versions, look at the [Releases](https://github.com/nghuuphuoc/bootstrapvalidator/releases) page. |
| 72 | + |
| 73 | +## Documentation |
| 74 | + |
| 75 | +* [Official website](http://bootstrapvalidator.com) |
| 76 | +* [Official website source](https://github.com/nghuuphuoc/bootstrapvalidator/tree/gh-pages) |
| 77 | + |
| 78 | +## Release History |
| 79 | + |
| 80 | +Look at the [Change Log](CHANGELOG.md) |
| 81 | + |
| 82 | +## Author |
| 83 | + |
| 84 | +The __BootstrapValidator__ plugin is written by Nguyen Huu Phuoc, aka @nghuuphuoc |
| 85 | + |
| 86 | +* [http://twitter.com/nghuuphuoc](http://twitter.com/nghuuphuoc) |
| 87 | +* [http://github.com/nghuuphuoc](http://github.com/nghuuphuoc) |
| 88 | + |
| 89 | +Big thanks to the contributors: |
| 90 | + |
| 91 | +* [@adgrafik](https://github.com/adgrafik) |
| 92 | +* [@easonhan007](https://github.com/easonhan007) |
| 93 | +* [@emilchristensen](https://github.com/emilchristensen) |
| 94 | +* [@evilchili](https://github.com/evilchili) |
| 95 | +* [@Francismori7](https://github.com/Francismori7) |
| 96 | +* [@gercheq](https://github.com/gercheq) |
| 97 | +* [@henningda](https://github.com/henningda) |
| 98 | +* [@ikanedo](https://github.com/ikanedo) |
| 99 | +* [@iplus](https://github.com/iplus) |
| 100 | +* [@jswale](https://github.com/jswale) |
| 101 | +* [@khangvm53](https://github.com/khangvm53) |
| 102 | +* [@kristian-puccio](https://github.com/kristian-puccio) |
| 103 | +* [@narutosanjiv](https://github.com/narutosanjiv) |
| 104 | +* [@patmoore](https://github.com/patmoore) |
| 105 | +* [@tomByrer](https://github.com/tomByrer) |
| 106 | +* [@vaz](https://github.com/vaz) |
| 107 | +* ... might be you! Let's [fork](https://github.com/nghuuphuoc/bootstrapvalidator/fork) and pull a request! |
| 108 | + |
| 109 | +> If you submit new RegEx, please build it using [RegExr.com](http://regexr.com/), add several tests that pass and fail there, |
| 110 | +> and include the "share" link in your JS as a ```// ``` comment. |
| 111 | +> For example: ```// Test: http://regexr.com/38mqi``` |
| 112 | +
|
| 113 | +## License |
| 114 | + |
| 115 | +``` |
| 116 | +The MIT License (MIT) |
| 117 | +
|
| 118 | +Copyright (c) 2013 - 2014 Nguyen Huu Phuoc |
| 119 | +
|
| 120 | +Permission is hereby granted, free of charge, to any person obtaining a copy of |
| 121 | +this software and associated documentation files (the "Software"), to deal in |
| 122 | +the Software without restriction, including without limitation the rights to |
| 123 | +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of |
| 124 | +the Software, and to permit persons to whom the Software is furnished to do so, |
| 125 | +subject to the following conditions: |
| 126 | +
|
| 127 | +The above copyright notice and this permission notice shall be included in all |
| 128 | +copies or substantial portions of the Software. |
| 129 | +
|
| 130 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 131 | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS |
| 132 | +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR |
| 133 | +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER |
| 134 | +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN |
| 135 | +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 136 | +``` |
0 commit comments