Auro Form Utilities

The auro-formvalidation is a JavaScript utility that handles element validation. The purpose of having a separate validation utility is to ensure consistent validation workflow and results across all form element.

The AuroDesignSystem validation workflow closely mirrors the HTML5 form elements validation workflow.

UI development browser support

For the most up to date information on UI development browser support

Install

$ npm i @aurodesignsystem/auro-formvalidation

Installing as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this stack overflow answer.

Define dependency in project component

import "@aurodesignsystem/auro-formvalidation";

auro-formvalidation use cases

Validation allows for setting the following optional requirements on a form element. These options can be used individually or in any combination.

• required: Specifies whether a form field needs to be filled in before the form can be submitted.
• minlength and maxlength: Specifies the minimum and maximum length of textual data (strings).
• min and max: Specifies the minimum and maximum values of numerical input types.
• type: Specifies whether the data needs to be a number, an email address, or some other specific preset type.
• pattern: Specifies a regular expression that defines a pattern the entered data needs to follow.
• error: Forces the validation state to be invalid and defines the custom validation message to display.

API Code Examples

Development

In order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request.

Please be sure to review the contribution guidelines for this project. Please make sure to pay special attention to the conventional commits section of the document.

API generation

The custom element API file is generated in the build and committed back to the repo with a version change. If the API doc has changed without a version change, author's are to run npm run build:api to generate the doc and commit to version control.

Testing

Automated tests are required for every Auro component. See .\test\auro-formvalidation.test.js for the tests for this component. Run npm test to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See the testing documentation for more details.