bootstrapValidator 中文API

用法

使用插件初始化表单后$(form).bootstrapValidator(options)，有两种方法调用插件方法：

// Get plugin instance
var bootstrapValidator = $(form).data('bootstrapValidator');

// and then call method
bootstrapValidator.methodName(parameters)

要么：

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

第一种方法主要返回BootstrapValidator实例，同时第二种方法总是返回表示表单的jQuery对象。

所以，可以链接方法如下：

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

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

API

以下是插件提供的公共方法列表。

方法使用与以下相同的格式：

methodName()

methodName(requiredParameter*, optionalParameter, ...): Type of return value - 方法的目的

激活addField

addField(field*, options): BootstrapValidator - 添加一个新的字段。

参数	类型	描述
field	字符串| jQuery的	字段名称或字段元素
options	目的	字段选项。 如果没有定义，这些选项将通过以下方式合并： 从字段的HTML属性解析的选项 调用插件时设置的当前选项

如果要添加新字段后要执行其他任务，则触发added.field.bv事件：

$(document).ready(function() {
    $(form)
        .bootstrapValidator(options)
        .on('added.field.bv', function(e, data) {
            // $(e.target)  --> The form instance
            // $(e.target).data('bootstrapValidator')
            //              --> The BootstrapValidator instance

            // data.field   --> The field name
            // data.element --> The new field element
            // data.options --> The new field options

            // Do something ...
        });
});

例

• 添加动态字段

defaultSubmit

defaultSubmit(): BootstrapValidator - 使用默认提交提交表单。

在提交表单时也不会执行任何验证。当您要在自定义提交处理程序中提交表单时，可能会使用它。

破坏

destroy() - 破坏插件。

它将删除所有错误消息，反馈图标以及关闭插件创建的事件。

disableSubmitButtons

disableSubmitButtons(disabled): BootstrapValidator - 禁用或启用提交按钮

参数	类型	描述
disabled	布尔	可以是true或false

例

• 始终启用提交按钮

enableFieldValidators

enableFieldValidators(field*, enabled*, validator): BootstrapValidator - 启用，禁用验证器给定字段

参数	类型	描述
field	串	字段名称
enabled	布尔	如果true，启用字段验证器。如果false，禁用字段验证器
validator	串	验证器名称。如果未设置，所有字段验证器将被启用或禁用

例

• 启用，禁用验证器

getDynamicOption

getDynamicOption(field*, option*): String - 返回可以动态设置的选项值。

例如，zipCode验证器具有country可以动态更改select元素的选项。

参数	类型	描述
field	字符串| jQuery的	字段名称或元素
option	串	该动态选项

getFieldElements

getFieldElements(field): jQuery[] - 按照给定的名称检索字段元素。
返回表示该字段的jQuery元素的数组，或者null如果找不到这些字段。

参数	类型	描述
field	串	字段名称

getInvalidFields

getInvalidFields(): jQuery[] - 返回无效字段的列表。

的getMessages

getMessages(field, validator): String[] - 获取错误消息。

参数	类型	描述
field	字符串| jQuery的	字段名称或字段元素 如果未定义字段，则该方法将返回所有字段的所有错误消息
validator	串	验证器的名称 如果未定义验证器，则该方法返回所有验证器的错误消息。

例

• 显示自定义区域中的消息

getOptions

getOptions(field, validator, option): String|Object - 获取字段选项。

参数	类型	描述
field	字符串| jQuery的	字段名称或字段元素 如果未定义字段，则该方法返回表单选项。
validator	串	验证器的名称 如果未定义验证器，则该方法返回所有字段选项。
option	串	选项名称 如果未定义，则该方法返回给定验证器的选项

getSubmitButton

getSubmitButton(): jQuery - 返回显示点击的提交按钮的jQuery元素。null如果没有点击提交按钮返回。

已验证

isValid(): Boolean- true如果所有表单域都有效，则返回。否则返回false。

调用这个之后，确保已经调用了validate方法。

isValidContainer

isValidContainer(container*): Boolean- true如果容器中的所有字段都有效，则返回。否则返回false。

在使用向导（例如选项卡），崩溃时，这很有用。

参数	类型	描述
container	字符串| jQuery的	容器选择器或容器元件

isValidField

isValidField(field*): Boolean - 检查该字段是否有效。true如果所有的字段验证器都通过，则返回。否则返回false。

参数	类型	描述
field	字符串| jQuery的	字段名称或字段元素

removeField

removeField(field*): BootstrapValidator - 删除给定字段

参数	类型	描述
field	字符串| jQuery的	字段名称或字段元素

通过触发removed.field.bv事件，您可以在删除给定字段后执行其他任务：

$(document).ready(function() {
    $(form)
        .bootstrapValidator(options)
        .on('removed.field.bv', function(e, data) {
            // $(e.target)  --> The form instance
            // $(e.target).data('bootstrapValidator')
            //              --> The BootstrapValidator instance

            // data.field   --> The field name
            // data.element --> The new field element

            // Do something ...
        });
});

例

• 添加动态字段

resetField

resetField(field*, resetValue): BootstrapValidator - 重置给定字段。它隐藏错误消息和反馈图标。

参数	类型	描述
field	字符串| jQuery的	字段名称或字段元素
resetValue	布尔	如果true，该方法将字段值重置为空或删除检查/选择的属性（用于收音机和复选框）。

重置表格

resetForm(resetFormData): BootstrapValidator- 重置表格。它隐藏所有错误元素和反馈图标。所有的字段都被标记为未被验证。

参数	类型	描述
resetFormData	布尔	如果true，该方法重置具有验证器规则的字段。

$(form).bootstrapValidator(options);
$(form).data('bootstrapValidator').resetForm();

revalidateField

revalidateField(field*): BootstrapValidator - 重新验证给定字段。

当您需要重新验证其值由其他插件更新的字段时使用它。

默认情况下，一旦该字段已经被验证并被标记为有效的插件，该插件就不会重新验证该字段。当与其他插件一起使用时，字段值被更改，因此需要重新验证。

幕后，方法相当于：

$(form).data('bootstrapValidator')
    .updateStatus(field, 'NOT_VALIDATED')
    .validateField(field);

// Or
$(form).bootstrapValidator('updateStatus', field, 'NOT_VALIDATED')
       .bootstrapValidator('validateField', field);

参数	类型	描述
field	字符串| jQuery的	字段名称或字段元素

updateMessage

updateMessage(field*, validator*, message*): BootstrapValidator - 更新错误消息。

参数	类型	描述
field	字符串| jQuery的	字段名称或字段元素
validator	串	验证器名称
message	串	错误消息

updateOption

updateOption(field*, validator*, option*, value*): BootstrapValidator - 更新特定验证器的选项。

参数	类型	描述
field	字符串| jQuery的	字段名称或字段元素
validator	串	验证器名称
option	串	选项名称
value	串	选项值

更新状态

updateStatus(field*, status*, validator): BootstrapValidator - 更新给定字段的验证器结果

参数	类型	描述
field	字符串| jQuery的	字段名称或字段元素
status	串	可以是NOT_VALIDATED，VALIDATING，INVALID或者VALID
validator	串	验证器名称。如果null，该方法更新所有验证器的有效性结果

验证

validate(): BootstrapValidator - 手动验证表单。当您想通过单击按钮或链接而不是提交按钮来验证表单时，这很有用。

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

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

validateField

validateField(field*): BootstrapValidator - 验证给定字段。

参数	类型	描述
field	字符串| jQuery的	字段名称或字段元素