thumbs.js 技术文档

1. 安装指南

1.1 下载项目

首先，您需要从GitHub仓库下载thumbs.js项目。您可以通过以下命令克隆仓库：

git clone https://github.com/mwbrooks/thumbs.js.git

1.2 构建项目

进入项目目录并运行构建命令：

cd thumbs.js
make

构建完成后，您将在build目录下找到生成的thumbs.x.x.js和thumbs.x.x.min.js文件。

2. 项目的使用说明

2.1 引入thumbs.js

在您的HTML文件中，确保在所有JavaScript文件之前引入thumbs.js：

<!-- 在所有JavaScript文件之前引入 -->
<script type="text/javascript" src="build/thumbs.x.x.js"></script>

2.2 绑定触摸事件

您可以使用原生JavaScript或jQuery/Zepto.js来绑定触摸事件：

原生JavaScript

element.addEventListener('touchstart', callback, false);
element.addEventListener('touchend',   callback, false);
element.addEventListener('touchmove',  callback, false);

jQuery或Zepto.js

$(element).bind('touchstart', callback);

XUI

$(element).on('touchstart', callback);

3. 项目API使用文档

3.1 触摸事件

thumbs.js支持以下触摸事件：

• touchstart: 当用户开始触摸元素时触发。
• touchend: 当用户结束触摸元素时触发。
• touchmove: 当用户在元素上移动触摸时触发。

3.2 事件绑定

您可以使用addEventListener或bind方法来绑定这些事件。事件处理函数callback将在事件触发时执行。

4. 项目安装方式

4.1 通过构建安装

如前所述，您可以通过克隆仓库并运行make命令来构建项目。构建完成后，您可以在build目录下找到生成的JavaScript文件。

4.2 直接使用构建文件

如果您不想自己构建项目，可以直接使用构建好的文件。将build/thumbs.x.x.js或build/thumbs.x.x.min.js文件引入到您的项目中即可。

5. 运行测试和示例

5.1 运行测试

要运行测试，请在浏览器中打开test/index.html文件：

open test/index.html

5.2 运行示例

要查看简单的示例，请在浏览器中打开example/index.html文件：

open example/index.html

6. 贡献指南

6.1 报告或修复问题

如果您发现问题，可以通过GitHub Issues进行报告：

https://github.com/mwbrooks/thumbs.js/issues

6.2 提交Pull Request

我们欢迎Pull Request。请使用主题分支进行开发：

git checkout -b issue_23
# 编写代码
git commit -m "Issue 23: Fix a bad bug."
git push origin issue_23
# 从分支issue_23向mwbrooks:master发送Pull Request

感谢您对thumbs.js的贡献！