Sisyphus 项目技术文档

1. 安装指南

1.1 环境准备

在开始安装之前，请确保您的开发环境已经安装了以下工具：

• Node.js（建议版本 12.x 或更高）
• npm（通常随 Node.js 一起安装）

1.2 安装步骤

1. 打开终端或命令行工具。
2. 克隆项目仓库到本地：

   git clone https://github.com/simsalabim/sisyphus.git
   

3. 进入项目目录：

   cd sisyphus
   

4. 安装项目依赖：

   npm install
   

2. 项目的使用说明

2.1 基本功能

Sisyphus 是一个用于保存 HTML 表单数据到本地存储的插件，旨在在浏览器崩溃、标签页关闭或其他灾难性事件后恢复表单数据。

2.2 使用步骤

1. 在您的 HTML 文件中引入 Sisyphus 插件：

   <script src="path/to/sisyphus.min.js"></script>
   

2. 在 JavaScript 中初始化 Sisyphus：

   $('#yourFormId').sisyphus();
   

3. 当用户填写表单时，Sisyphus 会自动将数据保存到本地存储中。如果用户重新加载页面或在新标签页中打开页面，表单数据将会自动恢复。

3. 项目API使用文档

3.1 初始化

$('#formId').sisyphus(options);

• #formId：需要保护的表单的 ID。
• options：可选配置项，包括：
  • customKeyPrefix：自定义键前缀。
  • timeout：保存数据的间隔时间（毫秒）。
  • onSave：保存数据时的回调函数。
  • onRestore：恢复数据时的回调函数。
  • onRelease：释放数据时的回调函数。

3.2 默认配置

{
  customKeyPrefix: '',
  timeout: 0,
  onSave: function() {},
  onRestore: function() {},
  onRelease: function() {}
}

3.3 方法

• save()：手动保存表单数据。
• restore()：手动恢复表单数据。
• release()：手动释放表单数据。

4. 项目安装方式

4.1 通过 npm 安装

npm install sisyphus-js

4.2 通过 CDN 引入

<script src="https://cdn.jsdelivr.net/npm/sisyphus-js/dist/sisyphus.min.js"></script>

4.3 手动下载

您也可以直接从 GitHub 仓库下载 sisyphus.min.js 文件，并在您的项目中手动引入。

---

通过以上步骤，您可以轻松地在项目中集成和使用 Sisyphus 插件，确保用户在填写表单时的数据安全。