comrade-forms v1.2.1

Comrade Forms

Usage without package manager:

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/comrade-forms@1/dist/comrade-forms.css">
<script src="https://cdn.jsdelivr.net/npm/comrade-forms@1/dist/comrade-forms.js"></script>
<script>
  new ComradeForms()
</script>

Usage with npm or yarn

$ yarn add comrade-forms

$ npm i comrade-forms --save

import 'comrade-forms/dist/comrade-forms.css'
import { ComradeForms } from 'comrade-forms'

new ComradeForms()

Simple HTML:

<form
  action="https://example.com/api/form"
  method="POST"
  data-comrade-form
>
  <div data-comrade-form-loader>Loading</div>
  <div data-comrade-form-success>
    <span data-cf="success-message"></span>
  </div>
  <div>
    <label for="name">Name</label>
    <input
      type="text"
      name="name"
      id="name"
      data-akismet="name"
      required
    />
  </div>
  <div>
    <label for="email">Email</label>
    <input
      type="email"
      name="email"
      id="email"
      data-akismet="email"
      required
    />
  </div>
  <div>
    <button type="submit">Submit</button>
  </div>
</form>

Some options:

new ComradeForms({
  /**
   * success callback
   * @param {string, object} response
   * @param {HTMLFormElement} form
   */
  onSuccess(response, form) {},

  /**
   * error callback
   * @param {string, object} error
   * @param {HTMLFormElement} form
   */
  onError(error, form) {}
})

Default CSS classes

Validation based on hyperform, please look documentation for more info

You can do this

new ComradeForms({
  hyperform: {
    // some configuration for hyperform

    // also:

    // classes: {
    //   valid: 'custom-valid-class',
    //   invalid: 'custom-invalid-class',
    //   validated: 'custom-validated-class',
    //   warning: 'custom-warning-class',
    // }
  }
})

Add Custom Validator for field

for example phone field length validator

const comradeForms = new ComradeForms()
const phones = document.querySelectorAll('input[type="tel"]')
phones.forEach(field => {
  comradeForms.addValidator(field, function(element) {
    const valid = element.value.length === 11
    element.setCustomValidity(
      valid ?
      '' :
      'Please enter correct phone number'
    );
    return valid
  })
})