UNPKG

whitesource

Version:
64 lines (40 loc) 2.1 kB
# ui-validate [![Build Status](https://travis-ci.org/angular-ui/ui-validate.svg?branch=master)](https://travis-ci.org/angular-ui/ui-validate) General-purpose validator for ngModel. Angular.js comes with several built-in validation mechanism for input fields (ngRequired, ngPattern etc.) but using an arbitrary validation function requires creation of a custom formatters and / or parsers. The ui-validate directive makes it easy to use any function(s) defined in scope as a validator function(s). A validator function will trigger validation on both model and input changes. ## Requirements - AngularJS ## Usage You can get it from [Bower](http://bower.io/) ```sh bower install angular-ui-validate ``` Load the script files in your application: ```html <script type="text/javascript" src="bower_components/angular/angular.js"></script> <script type="text/javascript" src="bower_components/angular-ui-validate/ui-validate.js"></script> ``` Add the specific module to your dependencies: ```javascript angular.module('myApp', ['ui.validate', ...]) ``` ## Development We use Karma and jshint to ensure the quality of the code. The easiest way to run these checks is to use grunt: ```sh npm install -g gulp-cli npm install && bower install gulp ``` The karma task will try to open Firefox and Chrome as browser in which to run the tests. Make sure this is available or change the configuration in `karma.conf.js` ### Gulp watch `gulp watch` will automatically test your code and build a release whenever source files change. ### How to release Use npm to update version and create a tag, then push to GitHub: ````sh gulp && git commit . # if necessary, build everything and commit latest changes npm version [major | minor | patch] # let npm update package.json and create a tag git push --tags origin master # push everything to GitHub ```` Travis will take care of testing and publishing to npm's registry (bower will pick up the change automatically). Finally [create a release on GitHub](https://github.com/angular-ui/ui-validate/releases/new) from the tag created by Travis.