bootstrapvalidator之API学习教程

最近项目用到了bootstrap框架，其中前端用的校验，采用的是bootstrapvalidator插件，也是非常强大的一款插件。我这里用的是0.5.2版本。

下面记录一下使用中学习到的相关API，不定期更新。

1. 获取validator对象或实例

 一般使用校验是直接调用$(form).bootstrapValidator(options)来初始化validator。初始化后有两种方式获取validator对象或实例，可以用来调用其对象的方法，比如调用resetForm来重置表单。有两种方式获取：

 1） 

// Get plugin instance
var bootstrapValidator = $(form).data('bootstrapValidator');
// and then call method
bootstrapValidator.methodName(parameters)

这种方式获取的是BootstrapValidator的实例，可以直接调用其方法。

2） 

$(form).bootstrapValidator(methodName, parameters);

 这种方式获取的是代表当前form的jquery对象，调用方式是将方法名和参数分别传入到bootstrapValidator方法中，可以链式调用。
 两种方式的使用分别如下：

// The first way
$(form)
  .data('bootstrapValidator')
  .updateStatus('birthday', 'NOT_VALIDATED')
  .validateField('birthday');

// The second one
$(form)
  .bootstrapValidator('updateStatus', 'birthday', 'NOT_VALIDATED')
  .bootstrapValidator('validateField', 'birthday');

2. defaultSubmit()

使用默认的提交方式提交表单，调用此方法BootstrapValidator将不执行任何的校验。一般需要时可以放在validator校验的submitHandler属性里调用。

使用：

$('#defaultForm').bootstrapValidator({
 fields: {
   username: {
 message: 'The username is not valid',
 validators: {
   notEmpty: {
  message: 'The username is required and can\'t be empty'
   }
 }
   }
 }，
 submitHandler: function(validator, form, submitButton) {
   // a)
   // Use Ajax to submit form data
   //$.post(form.attr('action'), form.serialize(), function(result) {
 // ... process the result ...
   //}, 'json');

   //b)
   // Do your task
   // ...
   // Submit the form
   validator.defaultSubmit();
 }
});

3. disableSubmitButtons(boolean) 

启用或禁用提交按钮。BootstrapValidator里默认的提交按钮是所有表单内的type属性值为submit的按钮，即[type="submit"]。
使用：

当登录失败时，重新启用提交按钮。

$('#loginForm').bootstrapValidator({
    message: 'This value is not valid',
    feedbackIcons: {
      valid: 'glyphicon glyphicon-ok',
      invalid: 'glyphicon glyphicon-remove',
      validating: 'glyphicon glyphicon-refresh'
    },
    submitHandler: function(validator, form, submitButton) {
      $.post(form.attr('action'), form.serialize(), function(result) {
        // The result is a JSON formatted by your back-end
        // I assume the format is as following:
        // {
        //   valid: true,     // false if the account is not found
        //   username: 'Username', // null if the account is not found
        // }
        if (result.valid == true || result.valid == 'true') {
          // You can reload the current location
          window.location.reload();

          // Or use Javascript to update your page, such as showing the account name
          // $('#welcome').html('Hello ' + result.username);
        } else {
          // The account is not found
          // Show the errors
          $('#errors').html('The account is not found').removeClass('hide');

          // Enable the submit buttons
          $('#loginForm').bootstrapValidator('disableSubmitButtons', false);
        }
      }, 'json');
    },
    fields: {
      username: {
        validators: {
          notEmpty: {
            message: 'The username is required'
          }
        }
      },
      password: {
        validators: {
          notEmpty: {
            message: 'The password is required'
          }
        }
      }
    }
  });

 4. enableFieldValidators(field, enabled)

启用或禁用指定字段的所有校验。这里我的实

验结果是如果禁用了校验，好像对应的字段输入（文本框、下拉等）也会变为禁用。
使用：

当密码框不为空时，开启密码框和确认密码框的校验：

 // Enable the password/confirm password validators if the password is not empty
  $('#signupForm').find('[name="password"]').on('keyup', function() {
    var isEmpty = $(this).val() == '';
    $('#signupForm').bootstrapValidator('enableFieldValidators', 'password', !isEmpty)
            .bootstrapValidator('enableFieldValidators', 'confirm_password', !isEmpty);
    if ($(this).val().length == 1) {
      $('#signupForm').bootstrapValidator('validateField', 'password')
              .bootstrapValidator('validateField', 'confirm_password');
    }
  });

5. getFieldElements(field)根据指定的name获取指定的元素，返回值是null或一个jQuery对象数组。  

6. isValid()返回当前需要验证的所有字段是否都合法。调用此方法前需先调用validate来进行验证，validate方法可用在需要点击按钮或者链接而非提交对表单进行校验的时候。使用：点击某按钮时，提示所有字段是否通过校验。 

$("#isAllValid").on("click", function(){
 alert($("#defaultForm").data('bootstrapValidator').isValid());
});

 7. resetForm(Boolean)

重置表单中设置过校验的内容，将隐藏所有错误提示和图标。
使用： 

$("#isAllValid").on("click", function(){
 alert($("#defaultForm").data('bootstrapValidator').isValid());
 if(!$("#defaultForm").data('bootstrapValidator').isValid()) {
 $("#defaultForm").data('bootstrapValidator').resetForm();
 }
});

 8. updateElementStatus($field, status, validatorName) 

更新元素状态。status的值有：NOT_VALIDATED, VALIDATING, INVALID or VALID。 

9. updateStatus(field, status, validatorName)

更新指定的字段状态。BootstrapValidator默认在校验某个字段合法后不再重新校验，当调用其他插件或者方法可能会改变字段值时，需要重新对该字段进行校验。
使用：

点击按钮对文本框进行赋值，并对其重新校验： 

$('#defaultForm').bootstrapValidator({
 fields: {
   username: {
 message: 'The username is not valid',
 validators: {
   notEmpty: {
  message: 'The username is required and can\'t be empty'
   }
 }
   }，
   stringLength: {
 min: 6,
 max: 30,
 message: 'The username must be more than 6 and less than 30 characters long'
   }
 }
});

$("#setname").on("click", function(){
 $("input[name=username]").val('san');
 var bootstrapValidator = $("#defaultForm").data('bootstrapValidator');
 bootstrapValidator.updateStatus('username', 'NOT_VALIDATED').validateField('username'); 
 //错误提示信息变了
});

10. validate()

手动对表单进行校验，validate方法可用在需要点击按钮或者链接而非提交对表单进行校验的时候。
由第一条可知，调用方式同样有两种： 

$(form).bootstrapValidator(options).bootstrapValidator('validate');

// or
$(form).bootstrapValidator(options);
$(form).data('bootstrapValidator').validate();

11. validateField(field) 

对指定的字段进行校验。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。

# bootstrapvalidator  # API  # JS组件Form表单验证神器BootstrapValidator  # 基于jQuery 实现bootstrapValidator下的全局验证  # 实用又漂亮的BootstrapValidator表单验证插件  # BootstrapValidator超详细教程(推荐)  # Bootstrap中的表单验证插件bootstrapValidator使用方法整理（推荐）  # jquery插件bootstrapValidator数据验证详解  # Bootstrapvalidator校验、校验清除重置的实现代码(推荐)  # jquery插件bootstrapValidator表单验证详解  # BootstrapValidator不触发校验的实现代码  # bootstrapValidator bootstrap-select验证不可用的解决办法  # 表单  # 的是  # 有两种  # 链式  # 而非  # 用在  # 文本框  # 直接调用  # 放在  # 也会  # 两种  # 我这  # 提示信息  # 对其  # 第一条  # 将不  # 值为  # 大家多多  # 为空  # 可以用来 

相关文章： 免费的流程图制作网站有哪些,2025年教师初级职称申报网上流程？  如何快速使用云服务器搭建个人网站？  建站之星导航如何优化提升用户体验？  如何用虚拟主机快速搭建网站？详细步骤解析  Python多线程使用规范_线程安全解析【教程】  建站之星×万网：智能建站系统+自助建站平台一键生成  Python路径拼接规范_跨平台处理说明【指导】  兔展官网 在线制作,怎样制作微信请帖？  公司网站建设制作费用,想建设一个属于自己的企业网站，该如何去做？  建站一年半SEO优化实战指南：核心词挖掘与长尾流量提升策略  商务网站制作工程师,从哪几个方面把握电子商务网站主页和页面的特色设计？  武汉网站制作费用多少,在武汉武昌，建面100平方左右的房子，想装暖气片，费用大概是多少啊？  网站专业制作公司,网站编辑是做什么的？好做吗？工作前景如何？  实现点击下箭头变上箭头来回切换的两种方法【推荐】  如何快速辨别茅台真假？关键步骤解析  如何在新浪SAE免费搭建个人博客？  济南网站制作的价格,历城一职专官方网站？  视频网站app制作软件,有什么好的视频聊天网站或者软件？  如何在腾讯云服务器快速搭建个人网站？  c++23 std::expected怎么用 c++优雅处理函数错误返回【详解】  大学网站设计制作软件有哪些,如何将网站制作成自己app？  网站微信制作软件,如何制作微信链接？  平台云上自助建站如何快速打造专业网站？  临沂网站制作公司有哪些,临沂第四中学官网？  北京专业网站制作设计师招聘,北京白云观官方网站？  巅云智能建站系统：可视化拖拽+多端适配+免费模板一键生成  购物网站制作费用多少,开办网上购物网站，需要办理哪些手续？  C#怎么使用委托和事件 C# delegate与event编程方法  零服务器AI建站解决方案：快速部署与云端平台低成本实践  专业网站制作服务公司,有哪些网站可以免费发布招聘信息？  网站制作说明怎么写,简述网页设计的流程并说明原因？  利用JavaScript实现拖拽改变元素大小  如何快速上传自定义模板至建站之星？  网站网页制作专业公司,怎样制作自己的网页？  网站制作知乎推荐,想做自己的网站用什么工具比较好？  如何在七牛云存储上搭建网站并设置自定义域名？  常州企业建站如何选择最佳模板？  专业的网站制作设计是什么,如何制作一个企业网站，建设网站的基本步骤有哪些？  临沂网站制作企业,临沂第三中学官方网站？  制作网站的过程怎么写,用凡科建站如何制作自己的网站？  制作网站软件推荐手机版,如何制作属于自己的手机网站app应用？  如何选择最佳自助建站系统？快速指南解析优劣  建站之星上传入口如何快速找到？  香港服务器网站搭建教程-电商部署、配置优化与安全稳定指南  如何在万网自助建站平台快速创建网站？  制作营销网站公司,淘特是干什么用的？  建站之星CMS五站合一模板配置与SEO优化指南  javascript中的try catch异常捕获机制用法分析  如何在云服务器上快速搭建个人网站？  如何通过PHP快速构建高效问答网站功能？