Shoelace plugin

Integrate with Shoelace library. Support Shoelace v1.0.0-beta24

Usage

The following piece of code is the starting point to validate the form made in Shoelace:




    
    


    
...
document.addEventListener('DOMContentLoaded', function(e) { FormValidation.formValidation( document.getElementById('demoForm'), { fields: { ... }, plugins: { shoelace: new FormValidation.plugins.Shoelace(), ... }, } ); });

There are some important things here:

  • The sample code above assumes that the FormValidation files are placed inside the vendors directory. You might need to change the path depending on where you place them on the server.
  • Shoelace.min.js is the plugin provided by FormValidation. It is NOT the same as shoelace(.min).js file provided by the Shoelace library.

The next sections list out some examples of various forms made with Shoelace.

Horizontal form

Stacked form

Multiple fields on the same row

In order to add the correct class for error message and the field element when it is a valid or invalid, we need to specify the CSS selector of the field container.

By default, the Shoelace plugin will look for the .input-field element. In the following example, the firstName and lastName fields are placed inside .col-4 containers. Meanwhile, the city, state and zipcode fields can be found inside the .col-3 containers.

The rowSelector option will be used to help the plugin determine the field containers as following:


shoelace: new FormValidation.plugins.Shoelace({
    rowSelector: function(field, ele) {
        // field is the field name
        // ele is the field element
        switch (field) {
            case 'firstName':
            case 'lastName':
                return '.col-4';
            
            case 'city':
            case 'state':
            case 'zipcode':
                return '.col-3';
            
            default:
                return '.input-field';
        }
    }
}),

Changelog

  • v1.0.0: First release