--- layout: default title: Validator slug: validator lead: "A simple and user-friendly form validator plugin for Bootstrap 3" ---
Add validation to your forms with this simple plugin.
data-toggle="validator"
to your form element.
{% highlight html %}
{% endhighlight %}
Or activate validation via JavaScript:
{% highlight js %}
$('#myForm').validator()
{% endhighlight %}
Follow Bootstrap's examples for appropriate form markup. It's important that each input field is in its own individual Validation rules are specified on form inputs via the following standard HTML5 attributes: As well as the following non-standard attributes: Because this plugin depends on the HTML5 Constraint Validation API, Internet Explorer 9 and older are not supported. If you need to support these browsers, you must add a polyfill like Ryan Seddon's H5F. To display error messages, include a container after the input field with both Options can be passed via data attributes or JavaScript. For data attributes, append the option name to Add custom validators to be run. Validators should be functions that receive the jQuery element as an argument and return a truthy or falsy value based on the validity of the input. Object structure is: Adding the validator to an input is done just like the others, You must also add default error messages for any custom validators via the Error messages to show for each type of validation. Defaults to: Error messages for individual form fields can alternatively be specified through the use of data attributes. You can specify an error message for each type of validator on a field, i.e. Attaches a validator to a form collection. Immediately validates the entire form. Destroys form validator and cleans up data left behind. All events are fired on the form element and provide a reference to the form field to which the event pertains via When the form is invalid,
type="email"
type="url"
type="number"
, with additional constraints via max
and min
attributespattern="Reg(ular )?Exp(ression)?"
(for input types of text
, search
, tel
, url
or email
)required
data-match="#inputToMatch"
to ensure two fields match, e.g. password confirmationsdata-minlength="5"
to enforce a minimum amount of charactersdata-remote="/path/to/remote/validator"
to make an AJAX request to determine if the field is valid or not. Be sure to give the input a name
attribute, as the request will be sent to /path/to/remote/validator?<name>=<value>
. The remote endpoint should return a 200 OK
if the field is valid, and a 4xx
otherwise.Cross-browser Compatibility
help-block
and with-errors
classes.Options
data-
, as in data-delay=""
.
Name
type
default
description
delay
number
500
Number of milliseconds to wait before displaying an error on a form field.
html
boolean
false
Insert HTML into the error messages. If false, jQuery's text method will be used to insert content into the DOM. Use text if you're worried about XSS attacks.
disable
boolean
true
Disable the submit button until the form is valid and all required fields are complete.
custom
object
{}
{foo: function($el) { return true || false } }
data-foo="bar"
.errors
option.
errors
object
sensible defaults
Error messages for individual form fields
data-match-error=""
or use data-error=""
for a blanket error message to show for any errors on that field. Methods
$().validator(options)
$().validator('validate')
$().validator('destroy')
Events
event.relatedTarget
.
Event Type
Description
validate.bs.validator
This event fires immediately when a form field is validated.
invalid.bs.validator
This event is fired when a form field becomes invalid. Field errors are provided via
event.detail
.
valid.bs.validator
This event is fired when a form field becomes valid. Previous field errors are provided via
event.detail
.
validated.bs.validator
This event is fired after a form field has been validated.
Conditionally handling the submit event
.preventDefault()
is called on the submit event. As a result, if you want to hook into the submit event and do something conditionally based on whether or not the form was valid, you can check if the event .isDefaultPrevented()
. Be sure your submit handler is bound after the plugin has been initialized on your form.