A lightweight form validation script that augments native HTML5 form validation elements and attributes.
npm install formbouncerjsGetting Started | Form Validation Attributes | Error Styling | Error Types | Custom Validations | Error Location | API | Browser Compatibility | License |
Features:
- Fields validate on blur (as the user moves out of them), which data shows is the best time for cognitive load.
- The entire form is validated on submit.
- Fields with errors are revalidated as the user types. Errors are removed the instant the field is valid.
- Supports custom validation patterns and error messages.
Compiled and production-ready code can be found in the dist directory. The src directory contains development code.
There are two versions of Bouncer: the standalone version, and one that comes preloaded with polyfills for closest(), matches(), classList, and CustomEvent(), which are only supported in newer browsers.
If you're including your own polyfills or don't want to enable this feature for older browsers, use the standalone version. Otherwise, use the version with polyfills.
Direct Download
You can download the files directly from GitHub.
``html`
CDN
You can also use the jsDelivr CDN. I recommend linking to a specific version number or version range to prevent major updates from breaking your site. Smooth Scroll uses semantic versioning.
`html
`
NPM
You can also use NPM (or your favorite package manager).
`bash`
npm install formbouncerjs
No special markup needed—just browser-native validation attributes (like required) and input types (like email or number).
`html`
In the footer of your page, after the content, initialize Bouncer by passing in a selector for the forms that should be validated.
If the form has errors, submission will get blocked until they're corrected. Otherwise, it will submit as normal.
And that's it, you're done. Nice work!
`html`
Modern browsers provide built-in form validation.
Bouncer hooks into those native attributes, suppressing the native validation and running its own. If Bouncer fails to load or run, the browser-native validation will run in its place.
Add the required attribute to any field that must be filled out or selected.
`html`
You can use special type attribute values to indicate specific types of data that should be captured.
`html
`
For numbers that should not go below or exceed a certain value, you can use the min and max attributes, respectively.
`html
`
For inputs that should not be shorter or longer than a certain number of characters, you can use the minlength and maxlength attributes, respectively.
`html
`
You can use your own validation pattern for a field with the pattern attribute. This uses regular expressions.
`html`
Show custom errors for pattern mismatches by adding the [data-bouncer-message] attribute to the field.
`html`
Bouncer does not come pre-packaged with any styles for fields with errors or error messages. Use the .error class to style fields, and the .error-message class to style error messages.
Need a starting point? Here's some really lightweight CSS you can use.
`css
/**
* Form Validation Errors
*/
.error {
border-color: red;
}
.error-message {
color: red;
font-style: italic;
margin-bottom: 1em;
}
`
Bouncer captures four different types of field errors:
- missingValue errors occur when a required field has no value (or for checkboxes and radio buttons, nothing is selected).patternMismatch
- errors occur when a value doesn't match the expected pattern for a particular input type, or a pattern provided by the pattern attribute.outOfRange
- errors occur when a number is above or below the min or max values.wrongLength
- errors occur when the input is longer or shorter than the minlength and maxlength values.
The patterns and messages associated with these types of errors can be customized.
You can add custom validation types to Bouncer beyond the four standard validations.
You can see this feature in action with the Confirm Password field on the demo page, and view examples of custom validations in the Cookbook (coming soon).
Pass in a customValidations object as an option when instantiating a new Bouncer instance. Each property in the object is a new validation type. Each value should be a function that accepts two arguments: the field being validated and the settings for the current instantiation.
The function should check if the field has an error. Return true if there's an error, and false when there's not.
`js
var validate = new Bouncer('form', {
customValidations: {
isHello: function (field) {
// Return false because there is NO error
if (field.value === 'hello') return false;
// Return true when there is
return true;
}
}
});
`
Add an error message for the custom validation by including the messages object in your options.
The key should be the same as your custom validation. It's value can be a string, or a function that returns a string. Message functions can accept two arguments: the field being validated and the settings for the current instantiation.
`js
var validate = new Bouncer('form', {
customValidations: {
isHello: function (field) {
// Return false because there is NO error
if (field.value === 'hello') return false;
// Return true when there is
return true;
}
},
messages: {
// As a string
isHello: 'This field should have a value of "hello"',
// As a function
isHello: function () {
return 'This field should have a value of "hello"';
}
}
});
`
By default, bouncer will render error messages after the invalid field (or the label for it, if the field is a radio or checkbox).
You can optionally render error messages before the field by setting the messageAfterField option to false.
`js`
var validate = new Bouncer('form', {
messageAfterField: false
});
You can also assign a custom location for an error message by including the [data-bouncer-target] attribute on a field. Use a selector for where the message should go as its value.
` Why do we need this? We'll use your email address to send you account information.html`
Bouncer includes smart defaults and works right out of the box.
But if you want to customize things, it also has a robust API that provides multiple ways for you to adjust the default options and settings.
You can customize validation patterns, error messages, and more by passing and options object into Bouncer during instantiation.
`js
var validate = new Bouncer('form', {
// Classes & IDs
fieldClass: 'error', // Applied to fields with errors
errorClass: 'error-message', // Applied to the error message for invalid fields
fieldPrefix: 'bouncer-field_', // If a field doesn't have a name or ID, one is generated with this prefix
errorPrefix: 'bouncer-error_', // Prefix used for error message IDs
// Patterns
// Validation patterns for specific input types
patterns: {
email: /^([^\x00-\x20\x22\x28\x29\x2c\x2e\x3a-\x3c\x3e\x40\x5b-\x5d\x7f-\xff]+|\x22([^\x0d\x22\x5c\x80-\xff]|\x5c[\x00-\x7f])\x22)(\x2e([^\x00-\x20\x22\x28\x29\x2c\x2e\x3a-\x3c\x3e\x40\x5b-\x5d\x7f-\xff]+|\x22([^\x0d\x22\x5c\x80-\xff]|\x5c[\x00-\x7f])\x22))\x40([^\x00-\x20\x22\x28\x29\x2c\x2e\x3a-\x3c\x3e\x40\x5b-\x5d\x7f-\xff]+|\x5b([^\x0d\x5b-\x5d\x80-\xff]|\x5c[\x00-\x7f])\x5d)(\x2e([^\x00-\x20\x22\x28\x29\x2c\x2e\x3a-\x3c\x3e\x40\x5b-\x5d\x7f-\xff]+|\x5b([^\x0d\x5b-\x5d\x80-\xff]|\x5c[\x00-\x7f])\x5d))(\.\w{2,})+$/,
url: /^(?:(?:https?|HTTPS?|ftp|FTP):\/\/)(?:\S+(?::\S)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-zA-Z\u00a1-\uffff0-9]-)[a-zA-Z\u00a1-\uffff0-9]+)(?:\.(?:[a-zA-Z\u00a1-\uffff0-9]-)[a-zA-Z\u00a1-\uffff0-9]+)(?:\.(?:[a-zA-Z\u00a1-\uffff]{2,}))\.?)(?::\d{2,5})?(?:[/?#]\S*)?$/,
number: /[-+]?[0-9]*[.,]?[0-9]+/,
color: /^#?([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$/,
date: /(?:19|20)[0-9]{2}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1[0-9]|2[0-9])|(?:(?!02)(?:0[1-9]|1[0-2])-(?:30))|(?:(?:0[13578]|1[02])-31))/,
time: /(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9])/,
month: /(?:19|20)[0-9]{2}-(?:(?:0[1-9]|1[0-2]))/
},
// Message Settings
messageAfterField: true, // If true, displays error message below field. If false, displays it above.
messageCustom: 'data-bouncer-message', // The data attribute to use for customer error messages
messageTarget: 'data-bouncer-target', // The data attribute to pass in a custom selector for the field error location
// Error messages by error type
messages: {
missingValue: {
checkbox: 'This field is required.',
radio: 'Please select a value.',
select: 'Please select a value.',
'select-multiple': 'Please select at least one value.',
default: 'Please fill out this field.'
},
patternMismatch: {
email: 'Please enter a valid email address.',
url: 'Please enter a URL.',
number: 'Please enter a number',
color: 'Please match the following format: #rrggbb',
date: 'Please use the YYYY-MM-DD format',
time: 'Please use the 24-hour time format. Ex. 23:00',
month: 'Please use the YYYY-MM format',
default: 'Please match the requested format.'
},
outOfRange: {
over: 'Please select a value that is no more than {max}.',
under: 'Please select a value that is no less than {min}.'
},
wrongLength: {
over: 'Please shorten this text to no more than {maxLength} characters. You are currently using {length} characters.',
under: 'Please lengthen this text to {minLength} characters or more. You are currently using {length} characters.'
}
},
// Form Submission
disableSubmit: false, // If true, native form submission is suppressed even when form validates
// Custom Events
emitEvents: true // If true, emits custom events
});
`
Bouncer emits five custom events:
- bouncerShowError is emitted on a field when an error is displayed for it.bouncerRemoveError
- is emitted on a field when an error is removed from it.bouncerFormValid
- is emitted on a form is successfully validated.bouncerFormInvalid
- is emitted on a form that fails validation.bouncerInitialized
- is emitted when bouncer initializes.bouncerDestroy
- is emitted when bouncer is destroyed.
You can listen for these events with addEventListener. All five events bubble up the DOM. The event.target is the field or form (or document, when initializing and destroying).
`js
// Detect show error events
document.addEventListener('bouncerShowError', function (event) {
// The field with the error
var field = event.target;
}, false);
// Detect a successful form validation
document.addEventListener('bouncerFormValid', function (event) {
// The successfully validated form
var form = event.target;
// If disableSubmit is true, you might use this to submit the form with Ajax
}, false);
`
The event.detail object holds event-specific information:
- On the bouncerShowError event, it has the specific errors for the field.bouncerInitialized
- On the and bouncerDestroyed events , it contains the settings for the instantiation.bouncerFormInvalid
- On the event, it includes all of the fields with errors under event.detail.
`js
// Detect show error events
document.addEventListener('bouncerShowError', function (event) {
// The field with the error
var field = event.target;
// The error details
var errors = event.details.errors;
}, false);
`
Bouncer exposes a few public methods that you can use in your own scripts.
#### validate()
Validate a field. Pass in the field as an argument. Returns an object with validity data.
`js
// Get a field
var field = document.querySelector('#email');
// Validate the field
var bouncer = new Bouncer();
var isValid = bouncer.validate(field);
// Returns an object
isValid = {
// If true, field is valid
valid: false,
// The specific errors
errors: {
missingValue: true,
patternMismatch: true,
outOfRange: true,
wrongLength: true
}
};
// You can also pass in custom options
bouncer.validate(field, {
// ...
});
`
#### validateAll()
Validate all fields in a form or fieldset. Pass in the section as an argument. Returns an array of fields with errors.
`js
// Get a fieldset
var fieldset = document.querySelector('#fieldset');
// Validate the field
var bouncer = new Bouncer();
var areValid = bouncer.validateAll(fieldset);
`
#### destroy()
Destroys an instantiated Bouncer instance. Removes any errors from the form and turns validation back over to the browser-native APIs.
`js
// An bouncer instance
var bouncer = new Bouncer('form');
// Destroy it
bouncer.destroy();
`
Bouncer works in all modern browsers, and IE 9 and above.
Bouncer is built with modern JavaScript APIs, and uses progressive enhancement. If the JavaScript file fails to load, browser-native form validation runs instead
Support back to IE9 requires polyfills for closest(), matches(), classList, and CustomEvent()`. Without them, support starts with Edge.
Use the included polyfills version of Bouncer, or include your own.
The code is available under the MIT License.