pristine-neue v1.1.7

Pristine Neue - Vanilla javascript form validation library

Credits

This library is a fork of prsitinejs by sha256

Living demo

Some examples of use can be found here.

This demo is from the original library, a new demo is coming soon.

Installation

$ npm install pristine-neue --save

Usage

Include the javascript file in your html head or just before the closing body tag

<script src="path/to/file/pristine.js" type="text/javascript"></script>

Create a Pristine instance and handle the submission.

document.addEventListener('DOMContentLoaded', () => {
  var form = document.getElementById('form1');
  var pristine = new Pristine(form);

  // Handle the form submission
  form.addEventListener('submit', async (e) => {
    // The validate method return as Promise that resolves to true / false
    const valid = await pristine.validate();

    if (valid) {
      // Submit the form..
    }
  });
});

Pristine automatically validates required, min, max, minlength, maxlength, pattern attributes and the value of type attributes like email, number and more..

Pristine takes 3 parameters

• form DOM element con containinng the fields to validate. Tipically a form element, but it can be any DOM element.
• config An object containing the configuration. See default configuration.
• live A boolean value indicating whether pristine should validate as you type, default is true.

Adding custom validators

You can add custom validators to a spcific pristine intance or add them globally.

Adding a custom validator to an instance

var pristine = new Pristine(document.getElementById('form'));

var elem = document.getElementById('email');

// A validator to check if the first letter is capitalized
pristine.addValidator(
  elem,
  (value) => {
    if (value.length && value[0] === value[0].toUpperCase()) {
      return true;
    }
    return false;
  },
  'The first character must be capitalized',
  2,
  false
);

Adding a global custom validator

Global validators must be added before creating the pristine instance

// A validator to check if the input value is within a specified range
Pristine.addValidator(
  'my-range',
  (value, el, param1, param2) => {
    return parseInt(param1) <= value && value <= parseInt(param2);
  },
  'The value (${0}) must be between ${1} and ${2}',
  5,
  false
);

var pristine = new Pristine(document.getElementById('form'));

Assign the new validator to inputs like this:

<input type="text" class="form-control" data-pristine-my-range="10,30" />

Validator Function Arguments

Validator functions receive arguments in the following order:

1. value - The current value of the input field being validated
2. element - The DOM element (input, select, textarea) being validated

3. Additional parameters - These come from the data-pristine-* attributes and are processed as follows:

   • Pattern attributes (data-pristine-pattern): The entire pattern string is passed as a single argument
   • JSON values: If the attribute value is valid JSON (starts with { or [), it will be parsed and passed as a single argument
   • Regular strings: For all other cases, the attribute value is split at commas (,) and each part is passed as a separate argument

Examples:

<!-- Regular comma-separated values -->
<input data-pristine-min-max="5,10" />
<!-- Validator receives: (value, element, "5", "10") -->

<!-- Pattern value -->
<input data-pristine-pattern="/^[A-Z]+$/i" />
<!-- Validator receives: (value, element, "/^[A-Z]+$/i") -->

<!-- JSON value -->
<input data-pristine-custom-config='{"option1": true, "option2": "value"}' />
<!-- Validator receives: (value, element, {"option1": true, "option2": "value"}) -->

When creating custom validators, ensure your function accepts the appropriate number of parameters based on how you plan to configure it in HTML.

Add custom error messages

<input required data-pristine-required-message="My custom message" />

Add an attribute like data-pristine-<ValidatorName>-messagewith the custom message as value to show custom error messages. You can add custom messages like this for as many validators as you need. Here ValidatorName means required, email, min, max etc.

Built-in validators

API

Pristine(form, config, live)

Constructor function

Default configuation

{
  classTo: 'field', // Class of parent element where the error/success class is added
  errorClass: 'error' // Error class,
  successClass: 'success' // Success class,
  errorTextParent: 'field', // Class of parent element to whom the error element is appended
  errorTextTag: 'div', // Element type to create for the error text
  errorTextClass: 'error-msg', // Class of the error text element
  liveAfterFirstValitation: true, // Enable live validation only after first form submission (requires live parameter to be true)
};

Global methods

Pristine.addValidator(name, fn, msg, priority, halt)

Add a global custom validator

Pristine.setLocale(locale)

Set the current locale globally

Pristine.addMessages(locale, messages)

Set the messages for a specific locale globally

Instance methids

pristine.validate(inputs, silent)

Validate the form or field(s)

Returns a Promise that resolves to true or false

pristine.addValidator(elem, fn, msg, priority, halt)

Add a custom validator

pristine.getErrors(input)

Get the errors of the form or a specific field

pristine.addError(input, error)

Add A custom error to an input element

pristine.setGlobalConfig(config)

Set the global configuration

pristine.reset()

Reset the errors in the form

pristine.destroy()

Destroy the pristine object

The goal of this library is not to provide every possible type of validation and thus becoming a bloat. The goal is to provide most common types of validations and a neat way to add custom validators.

License

MIT

Testing

Pristine Neue uses Vitest for testing. The test suite covers core functionality, built-in validators, custom validators, and localization features.

Running Tests

# Run all tests once
npm test

# Run tests in watch mode (for development)
npm run test:watch

# Run tests with coverage report
npm run test:coverage

For more details about the test suite, see the tests/README.md file.

Continuous Integration

Pristine Neue uses GitHub Actions for continuous integration. The following workflows are set up:

• Run Tests: Runs the test suite on every push and pull request.
• Deploy Documentation: Builds and deploys the documentation to GitHub Pages when changes are pushed to the master branch.
• Publish Package: Publishes the package to npm when a new release is created.