aurelia-validation

A validation plugin for Aurelia that uses a fluent API.

this.validation = validation.on(this)
                      .ensure('awesomeLevel')
                            .isGreaterThan(9000)
                      .ensure('readMe')
                            .isNotEmpty()
                            .hasMinLength(5)
                      .ensure('usage')
                            .isEqualTo('simple');

To keep up to date on Aurelia, please visit and subscribe to the official blog. If you have questions, we invite you to join us on our Gitter Channel.

##Documentation Important note: both the documentation and the samples reflect the latest version of the sources, not the latest released version! Watch the live samples. (Work-in-progress)

• Installing the plugin
• Getting started
• Validation types
  • isNotEmpty()
  • containsNoSpaces()
  • containsOnly(regex)
  • containsOnlyAlpha()
  • containsOnlyAlphaOrWhitespace()
  • containsOnlyAlphanumerics()
  • containsOnlyAlphanumericsOrWhitespace()
  • containsOnlyDigits()
  • containsOnlyLetters()
  • containsOnlyLettersOrWhitespace()
  • hasLengthBetween(minLength, maxLength)
  • hasMinLength(minLength)
  • hasMaxLength(maxLength)
  • isBetween(minValue, maxValue)
  • isEmail()
  • isEqualTo(otherValue, otherValueLabel)
  • isGreaterThan(minValue)
  • isGreaterThanOrEqualTo(minValue)
  • isLessThan(maxValue)
  • isLessThanOrEqualTo(maxValue)
  • isIn(collection)
  • isNumber()
  • isStrongPassword(minimumComplexityLevel)
  • isURL()
  • isNotEqualTo(otherValue, otherValueLabel)
  • matches(regex)
  • passes(customFunction, threshold)
  • passesRule(validationRule)
  • withMessage(message)
• Logical Operators
  • if(conditionalExpression)
  • switch(conditionalExpression)
• onValidate(validationCallback, failureCallback)
• Alternative validation setup
  • The @ensure decorator
  • Breeze (.onBreezeEntity(entity))
• I18N
• Custom Validation
• Visualization (Validate custom attribute)
  • Basic Usage
  • Visual clues and customization
  • How are elements and validation rules matched
  • Preventing form submission
• ValidationResult
• Configuration
  • One config to rule them all
  • config.useDebounceTimeout(timeout)
  • config.computedFrom(dependencies)
  • config.useLocale(locale)
  • config.useViewStrategy
  • config.treatAllPropertiesAsMandatory

Dependencies

• aurelia-binding
• aurelia-templating

Used By

This library isn't used by Aurelia. It is an optional plugin.

Platform Support

This library can be used in the browser.

Building The Code

To build the code, follow these steps.

1. Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.

2. From the project folder, execute the following command:

   npm install

3. Ensure that Gulp is installed. If you need to install it, use the following command:

   npm install -g gulp

4. To build the code, you can now run:

   gulp build

5. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

6. See gulpfile.js for other tasks related to generating the docs and linting.

Running The Tests

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

1. Ensure that the Karma CLI is installed. If you need to install it, use the following command:

   npm install -g karma-cli

2. Ensure that jspm is installed. If you need to install it, use the following commnand:

   npm install -g jspm

3. Install the client-side dependencies with jspm:

   jspm install

4. You can now run the tests with this command:

   karma start