/angular-w5c-validator

a simple plugin for angular.js form validation

Primary LanguageJavaScript

w5c-validator

Angular 7+ 版本的 ng-validator: https://github.com/why520crazy/ngx-validator

w5cValidator 插件基于angular.js原有的表单验证，统一验证规则和提示信息，在原有的基础上扩展了一些错误提示的功能，让大家不用在每个表单上写一些提示信息的模板，专心的去实现业务逻辑。 w5c validator自身提示信息样式使用了bootstrap的方式，当然你可以很好的扩展自己的提示方式（比如tooltip等）

demo演示：http://why520crazy.github.io/angular-w5c-validator

Change Log:https://github.com/why520crazy/angular-w5c-validator/blob/master/CHANGELOG.md

Useage：

  1. HTML 中引用 w5cValidator.js，执行 npm i ng-w5c-validator 或者 npm i angular-w5c-validator 或者 bower install angular-w5c-validator 进行安装；

  2. 启动module引用 "w5c.validator"，如: var app = angular.module("app", ["w5c.validator"]);

  3. 在app.config事件中配置全局属性和显示规则：

     app.config(["w5cValidatorProvider", function (w5cValidatorProvider) {

        // 全局配置
        w5cValidatorProvider.config({
            blurTrig   : false,
            showError  : true,
            removeError: true

        });
        w5cValidatorProvider.setRules({
            email   : {
                required: "输入的邮箱地址不能为空",
                email   : "输入邮箱地址格式不正确"
            },
            ...
        });
    }]);

  4. 在HTML模板中form上使用指令 w5c-form-validate 和 w5c-submit，w5c-form-validate指令表示该表单采用 w5cValidator的验证规则；w5c-submit 表示验证成功后调用的事件，当然w5c-submit可以不填写；

    <form class="form-horizontal w5c-form demo-form" role="form"
      w5c-form-validate="vm.validateOptions" novalidate name="validateForm">
    <div class="form-group">
        <label class="col-sm-2 control-label">邮箱</label>

        <div class="col-sm-10">
            <input type="email" name="email" ng-model="entity.email" required="" class="form-control"
                   placeholder="输入邮箱">
        </div>
    </div>
    <div class="form-group">
        <label class="col-sm-2 control-label">用户名</label>

        <div class="col-sm-10">
            <input required="" ng-pattern="/^[A-Za-z]{1}[0-9A-Za-z_]{1,19}$/" ng-model="entity.name"
                   w5c-unique-check="{url:'http://www.ngnice.com/api/test/user/name/check?name='+entity.name}"
                   class="form-control" name="username" placeholder="输入用户名（输入why520crazy验证存在）">
        </div>
    </div>
    <div class="form-group">
        <label class="col-sm-2 control-label">密码</label>

        <div class="col-sm-10">
            <input type="password" required="" ng-model="entity.password" name="password"
                   class="form-control" ng-minlength="5" ng-maxlength="15"
                   placeholder="输入密码">
        </div>
    </div>
    <div class="form-group">
        <label class="col-sm-2 control-label">重复密码</label>

        <div class="col-sm-10">
            <input type="password" required="" w5c-repeat="password" ng-model="entity.repeatPassword"
                   name="repeatPassword"
                   class="form-control"
                   placeholder="重复密码">
        </div>
    </div>
    <div class="form-group">
        <label class="col-sm-2 control-label">数字</label>

        <div class="col-sm-10">
            <input type="number" required="" ng-model="entity.number" name="number" class="form-control"
                   placeholder="输入数字（10-15）" max="15" min="10">
        </div>
    </div>
    <div class="form-group">
        <label class="col-sm-2 control-label">URL</label>

        <div class="col-sm-10">
            <input type="url" required="" ng-model="entity.url" name="url" class="form-control"
                   placeholder="输入URL">
        </div>
    </div>
    <div class="form-group">
        <label class="col-sm-2 control-label">类型</label>

        <div class="col-sm-10">
            <select class="form-control" ng-model="entity.type" required name="type"
                    ng-options="type.text for type in vm.types">
                <option value="">---请选择---</option>
            </select>
        </div>
    </div>
    <div class="form-group">
        <label class="col-sm-2 control-label">多选框</label>

        <div class="col-sm-10">
            <select multiple class="form-control" ng-model="entity.multipleType" required name="multipleType"
                    ng-options="type.text for type in vm.types">
                <option value="">---请选择---</option>
            </select>
        </div>
    </div>
    <div class="form-group" ng-if="vm.showDynamicElement">
        <label class="col-sm-2 control-label">动态元素</label>

        <div class="col-sm-10">
            <input required=""
                   class="form-control" w5c-dynamic-element ng-model="entity.dynamic" name="dynamic"
                   placeholder="动态现实元素">
        </div>
    </div>
    <div class="form-group" ng-show="validateForm.$errors.length > 0 && vm.showErrorType == 2">
        <label class="col-sm-2 control-label"></label>

        <div class="col-sm-10">
            <div class="alert alert-danger">
                <ui>
                    <li ng-repeat="error in validateForm.$errors track by $index">
                        {{error}}
                    </li>
                </ui>
            </div>
        </div>
    </div>

    <div class="form-group">
        <div class="col-sm-offset-2 col-sm-10">
            <button type="buttom" w5c-form-submit="vm.saveEntity()" class="btn btn-success"> 验证</button>
            <button type="buttom" ng-click="validateForm.reset()" class="btn btn-default"> 重置</button>
        </div>

    </div>
</form>

#验证规则 AngularJS原生支持很多种验证规则，比如：require（必填项），email，pattern（正则），maxlength，minlength，number，url，max，min

w5cValidator提供了w5c-repeat（级联重复，常用于重复密码）和w5cUniqueCheck (远程验证，常用于检验用户名邮箱是否存在)

  1. w5cDynamicName , 让name支持表达式, <input w5c-dynamic-name="vm.dynamicName" />
  2. w5cDynamicElement 指令用于带 ng-if 或者 ng-repeat 内部的验证元素, 常常和 w5cDynamicName 配合使用

#默认提示信息

{
    required      : "该选项不能为空",
    maxlength     : "该选项输入值长度不能大于{maxlength}",
    minlength     : "该选项输入值长度不能小于{minlength}",
    email         : "输入邮件的格式不正确",
    repeat        : "两次输入不一致",
    pattern       : "该选项输入格式不正确",
    number        : "必须输入数字",
    w5cuniquecheck: "该输入值已经存在，请重新输入",
    url           : "输入URL格式不正确",
    max           : "该选项输入值不能大于{max}",
    min           : "该选项输入值不能小于{min}"

}

可以通过 w5cValidatorProvider.setDefaultRules(rule)进行设置做国际化

#注意事项：

  1. 由于验证使用的是 angular的form验证，所以必须要保证form和验证的元素都要有name属性；
  2. 如果你不想把验证成功事件w5c-submit写在 form上，可以直接在form里面的其他元素上使用w5cFormSubmit指令，如： <button type="buttom" w5c-form-submit="vm.saveEntity()" class="btn btn-success"> 验证</button>
  3. 如果你clone了代码。本地用chrome直接打开example/index.html是不可以运行的，因为我使用了$http服务去获取 js css html，所以必须要在本地搭建服务端程序，如果你有nodejs环境，运行npm install 安装module后再运行 grunt server , 如果没有grunt，用命令npm install grunt-cli -g安装, mac下需要 sudo npm install grunt-cli -g
  4. 如果你不想安装node grunt等乱七八糟的玩意，直接打开example/index-local.html 即可运行。
  5. w5cUniqueCheck默认检验是否已经存在，存在验证不通过，不存在验证通过，如果isExists设置为false表示：存在验证通过，不存在验证不通过。
  6. w5cValidatorProvider默认的错误提示信息是中文的，如果想修改成其他语言，可以通过 w5cValidatorProvider.setDefaultRules()方法设置。
  7. w5cDynamicName和w5cDynamicElement通常用于 循环创建表单元素,但是提示信息往往是一样的,默认的提示规则是按照name定义的, 所以提供了一种特殊的命名方式 {name}{$数字$}, 当匹配错误提示的时候,如果name后面带有 $数字$,会忽略这个,常用于 ng-repeat创建元素

#参数

名称 默认值 作用
blurTrig false 光标移除元素后是否验证并显示错误提示信息
showError true 可以是bool和function，每个元素验证不通过后调用该方法显示错误信息，默认true，显示错误信息在元素的后面。
removeError true 可以是bool和function，每个元素验证通过后调用该方法移除错误信息，默认true，验证通过后在元素的后面移除错误信息。

showError Function为

function showError(elem, errorMessages){
    ...
}

removeError Function为

function removeError(elem){
    ...
}

设置代码为：

 w5cValidatorProvider.config({
    blurTrig: false,
    showError: function(elem,errorMessages){
        ...
    },
    removeError: function(elem){
        ...
    }
  });

扩展方法

formName 对象是 Angular.js Form 验证 自动生成的 scope 对象,以 Form Name 命名, 包含了表单每个元素的验证情况， w5cValidator 组件主要就是基于 Angular.js 内部的验证机制追加错误提示信息而已，下面几个方法是 w5cValidator 组件扩展的变量和方法；

  1. formName.reset() 重置整个表单，包含错误信息；
  2. formName.$errors 是错误提示列表，用于统一显示错误；
  3. formName.w5cValidator.validateElement(elementName) 单独验证某个元素；
  4. formName.w5cValidator.setElementErrorMessage(elementName, errorMessage) 设置某个元素的错误信息，用户服务端返回的错误；
  5. formName.w5cValidator.doValidate() 开始触发验证，一般使用 w5c-form-submit 指令点击会自动触发验证，除非特殊情况需要使用 JS 触发才会使用到；
  6. formName.w5cValidator.removeElementValidation(elementName) 移除单个元素的验证；
  7. formName.w5cValidator.addElementValidation(elementName) 添加单个元素的验证。

以下方法请用 formName.w5cValidator.xxx 代替，即将被遗弃：

  • formName.validateElement(elemName)
  • formName.setElementErrorMessage(elemName, errorMessage)
  • formName.doValidate()