Happy.js 技术文档

1. 安装指南

1.1 通过下载

1. 访问 Happy.js 的官方网站：Happy.js。
2. 下载 Happy.js 的最新版本。
3. 将下载的文件解压到您的项目目录中。

1.2 通过 Git

如果您熟悉 Git，可以通过以下命令克隆整个项目：

$ git clone git://github.com/henrikjoreteg/Happy.js

将克隆的项目放置到您的项目目录中。

2. 项目使用说明

Happy.js 是一款轻量级的表单验证插件，适用于 jQuery 或 Zepto。它可以在表单的 blur 事件和提交时对字段进行验证。

2.1 快速示例

以下是一个快速示例，展示了如何使用 Happy.js：

<form id="awesomeForm" action="/lights/camera" method="post">
  <input id="yourName" type="text" name="name" />
  <input id="email" type="text" name="email" />
</form>

$('#awesomeForm').isHappy([
  fields: [
    '#yourName': {
      required: true,
      message: 'Might we inquire your name'
    },
    '#email': {
      required: true,
      message: 'How are we to reach you sans email',
      test: happy.email
    }
  ]
]);

2.2 配置选项

Happy.js 提供了多个配置选项，以下是一些常用的配置：

• submitButton: 指定一个 jQuery 选择器，当点击该元素时将触发表单验证。
• happy: 当表单验证通过时的回调函数。
• unHappy: 当表单验证失败时的回调函数。
• errorTemplate: 用于生成自定义错误信息的函数。
• when: 触发字段验证的事件，默认为 'blur'。
• classes: 验证失败时应用到输入字段和错误信息的类。
• errorTarget: 用于插入错误信息的元素的选择器。

3. 项目API使用文档

3.1 方法

• .isHappy(options): 启动 Happy.js 的表单验证。

3.2 选项

• fields: 每个字段的验证配置。
• submitButton: 触发验证的提交按钮的选择器。
• happy: 验证通过时的回调。
• unHappy: 验证失败时的回调。
• errorTemplate: 自定义错误信息模板。
• when: 触发字段验证的事件。
• classes: 自定义验证失败时的类。
• errorTarget: 自定义错误信息的插入目标。

3.3 字段属性

• required: 字段是否必填。
• message: 验证失败时显示的消息。
• test: 自定义验证函数。
• arg: 传递给验证函数的额外参数。
• clean: 清理数据的函数。
• trim: 是否默认去除空格。

4. 项目安装方式

请参考本文档的“1. 安装指南”部分。您可以选择通过下载或通过 Git 的方式安装 Happy.js。