Coriander

Form validation library built with JavaScript

Version

1.5.3

Installation

npm

npm install coriander

unpkg

<script src="https://unpkg.com/coriander@1.5.3/src/coriander.js"></script>

Getting Started

Dataset Options

Option	Type	Default	Description
data-error	string	This value is required	Error reporting that displays when validation fails for an input
data-regex	string	undefined	Validate input against regex
data-required	boolean	undefined	Only validate input if this is present

Example

<input
  class="form-input"
  type="text"
  id="name"
  name="name"
  data-error="Please enter letters only"
  data-regex="[a-zA-Z]+(([\',. -][a-zA-Z ])?[a-zA-Z]*)*$"
  data-required="true"
/>

Call coriander and pass a form element as an argument

coriander(form);

Method Options

Option	Type	Default	Description
onChange	boolean	undefined	Listen for validation when a change is made to an input
onSubmit	function	form.submit()	handle what to do when validation passes

Example

const form = document.querySelector('.form');
 
coriander(form, {
  onChange: true,
  onSubmit(data) {
    const names = {};
 
    data.inputs.forEach(d => {
      if (d.type === 'radio') {
        names[d.name] = d.nextElementSibling.textContent;
      } else {
        names[d.name] = d.value;
      }
    });
 
    console.log(JSON.stringify(names));
  }
});

Built With

• Gulp - Task runner
• BrowserSync - Local server
• ESLint - Linter for JS files
• Jasmine - Behavior Driven Testing Library

Authors

• Brandon Patterson - Initial work - brandnpatterson

License

This project is licensed under the MIT License - see the LICENSE.md file for details