README

一个简单的 jQuery 表单缓存插件。

入门指南

快速入门

有三种快速入门选项可用

• 下载最新版本.
• 克隆仓库： git clone https://github.com/sqginfo/formcache.git。
• 使用 NPM 安装： npm install formcache。

安装

包含文件

<script src="/path/to/jquery.js"></script><!-- jQuery is required -->
<script src="/path/to/formcache.js"></script>

用法

使用 data-toggle="formcache" 属性初始化

<form data-toggle="formcache"></form>

使用 $.fn.formcache 方法初始化

<form id="form"></form>

$('#form').formcache()

选项

key

• 类型： String | Number
• 默认： ''

表单缓存的特殊标识符，必须与同一页面中的其他表单不同。

默认情况下，表单在文档中的索引将用作 key。

local

• 类型： Boolean
• 默认： true

在 localStorage 中存储缓存。

session

• 类型： Boolean
• 默认： true

在 sessionStorage 中存储缓存。

autoStore

• 类型： Boolean
• 默认： true

在表单控件更改或页面卸载前自动更新和存储缓存。

maxAge

• 类型： Number
• 默认： undefined

设置缓存的存储时间（以秒为单位），类似于 cookie 中的 max-age。

默认情况下，会话缓存将在浏览器关闭时清除，而本地缓存将一直存储。

注意:

• 会话缓存仍然会在浏览器关闭时清除。
• 本地缓存仍然会在浏览器缓存清除时清除。

controls

• 类型： Array
• 默认

[
  'select',
  'textarea',
  'input'
]

jQuery 选择器数组。定义需要缓存的表单控件。

注意： 默认情况下，所有文件输入都将始终被忽略。

方法

getCache([index])

获取默认缓存对象或特殊对象。

示例

$().formcache('getCache')
$().formcache('getCache', 1)

getCaches()

获取所有缓存对象。

示例

$().formcache('getCaches')

setCache([index, ]data)

覆盖默认缓存对象或添加新对象。

示例

$().formcache('setCache', {})
$().formcache('setCache', 1, {})

setCaches(data)

用新缓存覆盖旧缓存。

示例

$().formcache('setCaches', [{}])
$().formcache('setCaches', [{}, {}])

removeCache([index])

删除默认缓存对象或特殊对象。

示例

$().formcache('removeCache')
$().formcache('removeCache', 1)

removeCaches()

删除所有缓存对象。

示例

$().formcache('removeCaches')

outputCache([index])

将默认缓存对象或特殊对象输出到表单。

输出到表单的缓存对象将在任何表单控件更改时自动更新。

示例

$().formcache('outputCache')
$().formcache('outputCache', 1)

serialize()

序列化表单并返回缓存对象。

示例

var cache = $('form').formcache('serialize');

$('form').formcache('setCache', cache);
$('form').formcache('setCaches', [cache, cache]);

store()

将所有缓存存储到 sessionStorage 或 localStorage。

当表单控件更改或窗口卸载时，插件将自动执行此操作。

clear()

清除所有缓存。

destroy()

销毁 formcache 实例，但保留缓存。

如果您想删除所有缓存，请先调用 clear 方法，然后调用此方法。

浏览器支持

• Chrome 31+
• Firefox 31+
• Internet Explorer 8+
• Opera 26+
• Safari 5.1+
• iOS Safari 7.1+
• Android 浏览器 4.1+
• Android Chrome 39+

作为 jQuery 插件，您可以参考 jQuery 浏览器支持。

许可证

在 MIT 许可证下发布。