--- layout: default title: Validator slug: validator lead: "A simple and user-friendly form validator plugin for Bootstrap 3" ---

Examples

Add validation to your forms with this simple plugin.

@
Up to 20 letters, numbers and underscores
Minimum of 6 characters
{% highlight html %}
@
Up to 20 letters, numbers and underscores
Minimum of 6 characters
{% endhighlight %}

Usage

Form validation can be enabled in markup via the data-api or via JavaScript. Automatically enable form validation by adding data-toggle="validator" to your form element. {% highlight html %}
...
{% endhighlight %} Or activate validation via JavaScript: {% highlight js %} $('#myForm').validator() {% endhighlight %}

Markup

Follow Bootstrap's examples for appropriate form markup.

Validation rules are specified on form inputs via the following standard HTML5 attributes:

As well as the following non-standard attributes:

To display error messages, include a container after the input field with both help-block and with-errors classes.

{% highlight html %}
{% endhighlight %}

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to 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.
errors object sensible defaults

Error messages to show for each type of validation. Defaults to:

{% highlight js %} errors: { match: "Does not match", minlength: "Not long enough" } {% endhighlight %}

Error messages for individual form fields

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. data-match-error="" or use data-error="" for a blanket error message to show for any errors on that field.

Methods

$().validator(options)

Attaches a validator to a form collection.

$().validator('validate')

Immediately validates the entire form.

$().validator('destroy')

Destroys form validator and cleans up data left behind.

Events

All events are fired on the form element and provide a reference to the form field to which the event pertains via 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.