validate.js 技术文档

1. 安装指南

NPM 安装

您可以通过 npm 来安装 validate.js。在命令行中执行以下命令：

npm install validate-js

手动安装

如果您不想使用 npm，可以从 GitHub 下载最新版本的 validate.js 文件，并手动将其包含在您的项目中。

2. 项目使用说明

validate.js 是一个轻量级的 JavaScript 表单验证库，它受到了 CodeIgniter 的启发。它支持多种验证规则，无需依赖任何其他库，并允许自定义消息。

以下是一个如何使用 validate.js 的示例：

var validator = new FormValidator('example_form', [{
    name: 'req',
    display: 'required',
    rules: 'required'
}, {
    name: 'alphanumeric',
    rules: 'alpha_numeric'
}, {
    name: 'password',
    rules: 'required'
}, {
    name: 'password_confirm',
    display: '密码确认',
    rules: 'required|matches[password]'
}, {
    name: 'email',
    rules: 'valid_email'
}, {
    name: 'minlength',
    display: '最小长度',
    rules: 'min_length[8]'
}, {
    names: ['fname', 'lname'],
    rules: 'required|alpha'
}], function(errors) {
    if (errors.length > 0) {
        // 显示错误信息
    }
});

在这个例子中，我们创建了一个 FormValidator 实例，并为其提供了表单的 ID 和一组验证规则。每个验证规则都有 name、display（用于自定义错误消息）和 rules 属性。rules 属性可以包含多个验证规则，使用 | 分隔。

当表单提交时，validate.js 会调用提供的回调函数，并通过 errors 参数传递任何验证错误。

3. 项目 API 使用文档

validate.js 提供了以下 API：

• new FormValidator(formId, fields, callback): 创建一个新的验证器实例。

  • formId: 表单的 ID。
  • fields: 一个包含验证规则的对象数组。
  • callback: 表单验证完成后的回调函数。

• FormValidator.prototype.validate(): 手动触发验证。

• FormValidator.prototype.showErrors(): 显示验证错误。

• FormValidator.prototype.hideErrors(): 隐藏验证错误。

• FormValidator.prototype.destroy(): 销毁验证器实例。

4. 项目安装方式

如前所述，validate.js 可以通过 npm 安装，或者从 GitHub 下载源代码并手动集成到项目中。

通过 npm 安装

npm install validate-js

手动安装

从 GitHub 下载 validate.js 源代码，并将其包含在您的项目中的合适位置。

以上是 validate.js 的技术文档，希望对您使用该库有所帮助。