way.js中文文档

------------------(第一次翻译,不完全正确的地方请多包涵,仅供学习参考)
英文文档参考地址
简单的,轻量级的,持续的,双向数据邦定框架的JS库
少量的JS代码编写,且没有依赖性
codeopen

快速开始

HTLM标签类似于这样定义

 <form way-data="myFormData" way-persistent="true">
    <input type="text" name="name">
    <input type="text" name="age">
    <input type="text" name="gender">
  </form>

  Name: <span way-data="myFormData.name"></span>

现在,表单里每个元素的改变都会存储在内存中。在页面加载时,存数的数据保留在。

安装

包含下列代码在你的页面即可
<script src="way.min.js"></script>

选项
name type default description
data string null 允许定义点分隔的路径当数据被存储时。包含数组,当使用一个表单时,包含所有inputs name属性的json被创建和存储在固定的存储中。通过"__all__" 可以获取所有的 way.js' 数据。
default string null 一个链接到一个默认数据设置在一个元素上,确保在没有绑定值的情况下。
persistent boolean true 当绑定的值改变时,允许数据存储到localStorage
readonly boolean false 防止元素改变重置绑定值
writeonly Boolean false 防止元素绑定值改变时改变。
json boolean false 返回json格式到dom页面
html boolean false 声明数据属性是否能被HTML解析
pick array null 一个逗号分隔的值列表选择(仅在表单中)与存储同步。默认情况下,所有表单的input同步。
omit array null 一个逗号分隔的值列表选择(仅在表单中)与存储同步。
例子
<form way-data="some.form" way-pick="some,properties,that,can.be.nested">
<form way-data="some.form" way-omit="dont,want.those">
<img way-data="some.image" way-default="http://upload.wikimedia.org/wikipedia/en/a/a6/Bender_Rodriguez.png">
<pre way-data="some.json" way-json="true"></pre>
Scopes

你可以在Html数据中设置scope(范围)

[way-scope] attribute

用该属性指出所有包含在这个范围内的子“way-data”

way.set("someScope", { with: { something: "hello" }})
<div way-scope="someScope">
  <div way-scope="with">
    <div way-data="something"></div> <!-- Will render "hello" -->
  </div>
</div>
[way-scope-break] attribute

打破scope链。这个元素的所有子元素将会没有范围设置。

way.set("someScope", { with: { something: "hello" }})
<div way-scope="someScope">
  <div way-scope-break="true">
    <div way-data="someScope.with.something"></div> <!-- Will render "hello" -->
  </div>
</div>
scope()方法

返回给定Dom元素的scope

<div way-scope="someScope">
  <div way-scope="with">
    <div way-data="something" id="someDIV"></div>
  </div>
</div>
way.dom("#someDIV").scope() 
>> "someScope.with"
Repeats

复制一个Dom元素的每个值,可以通过“way.js”循环传递数据
注释
1.重复块会自动为子元素设置适当的范围。
2.在每一次循环中,“$$key”与对应当前循环到元素的key
设置

way.set("some.list", [
 {name:"Pierre"},
 {name:"Paul"},
 {name:"Jacques"}
]);
<div way-repeat="some.list">
 $$key - <span way-data="name"></span>
</div>

渲染后得到

<div way-scope="some.list">
 <div way-scope="0">
 0 - <span way-data="name">Pierre</span>
 </div>
 <div way-scope="1">
 1 - <span way-data="name">Paul</span>
 </div>
 <div way-scope="2">
 2 - <span way-data="name">Jacques</span>
 </div>
</div>
Transforms

显示的值格式设定
[way-transform] attribute
如果有多个transforms,使用“|”分隔,如果多个transforms之间有冲突,将由最后一个提到的tansform决定

Name Description Example
uppercase Sets a string to uppercase "hello" becomes "HELLO"
lowercase Sets a string to lowercase "HELLO" becomes "hello"
reverse Reverses a string "hello" becomes "olleh"
way.set("someData", "hello")
<div way-data="someData" way-transform="uppercase"></div>
<!-- Renders "HELLO" -->

egisterTransform(name, transform) 方法
自定义一个transform

way.set("someData", "hello");
way.registerTransform("lolify", function(data) {
 return data + " lol";
});
<div way-data="someData" way-transform="lolify|uppercase"></div>
<!-- Renders "HELLO LOL" -->

Helper elements

允许完成简单click任务
Example:

way.set("some.list", ["I", "am", "list"]);
<div id="clickToRemove" way-action-remove="some.list.2"></div>
<div id="clickToPush" way-action-push="some.list"></div>
$("#clickToRemove").click();
$("#clickToPush").click();
way.get("some.list");
>> ["I", "am", null]
Helper classes

对于图片而言,way.js允许给dom元素添加class,检测 load/error/success状态

class Description
way-loading When an image is getting downloaded to a DOM element
way-error When no image is returned from the URL provided
way-success When... Well, you got it.
way.set("image.url", "somethingThatsNotAnImageURL");
<img way-data="image.url">
<!-- Gets a class ".way-error" attributed -->
Methods

HTML 标签就已经可以完成很多功能,但如果有必要,你也可以使用辅助功能在存储数据和Dom元素之间进行交互。
注释
1.[element]可以作为dom元素的css选择器
2.[options]是可选的。缺省情况下,options读取Html标签。但是你可以通过传递参数重写他们。
DOM methods
way.dom(element).toStorage(options)
存储这个元素的值到内存中去

way.dom("#someForm").toStorage()

从内存中设置元素的值

way.dom("#someForm").fromStorage()

way.dom(element).toJSON(options)
但会一个input解析数据的json(尤其是方便表单处理)

way.dom("#someForm").toJSON()

>> {
        its: "values",
        serialized: {
            in: "a json"
        }
    }

way.dom(element).fromJSON(data, options)
从json数据中设置元素的值

way.dom("#someForm").fromJSON({name:"John Doe"})

way.dom(element).getValue()
返回dom元素的json值

way.dom("#someForm").getValue()

way.dom(element).setValue(value, options)
从json数据中设置元素的值

way.dom("#someForm").setValue({name:"John Doe"})

way.dom(element).setDefault(force)
设置一个元素的缺省值。默认情况下,dom元素的值为缺省值。其绑定值在数据存储不变。如果你需要强制设置这个内存中的缺省值,通过[force]参数

way.dom("#someForm").setDefault()

way.setDefaults(force)
设置所有绑定dom元素的缺省值

way.setDefaults()

way.dom(element).getOptions()
返回dom元素 ["way-"] options列表

way.dom("#someForm").getOptions()
Data methods

way.get(selector)
返回一个给定的路径名存储数据的值

way.get("some.path");
>> "bonjour"

way.set(selector, value, options)
在指定路径名下存储数据值

way.set("some.path", "bonjour!");

way.remove(selector, options)
移除给定路径名下的存储值

way.remove("some.path");
way.get("some.path");
>> undefined

way.clear(options)
清除所有数据

way.clear();
way.get();
>> {}
localStorage methods

way.backup()
将way.js中的存储数据保存到localStorage

way.backup();

way.restore()
回复在localStorage中的数据。Called on $(document).ready by default (can be changed with global options).

way.restore();
Binding methods

way.registerBindings()
触发dom搜索找到并保存这个元素的[way-data]属性,绑定一些数据

way.registerBindings()

设置了绑定data选择器的dom元素的值。如果omitted,所有way-data属性的dom元素将会被刷新(excluding write-only's and omitted)

way.updateBindings("formData.name")
Repeat methods

way.registerRepeats()
触发dom搜索找到并保存这个元素的[way-repeat]属性,绑定一些数据

way.registerRepeats()

way.updateRepeats(selector)
触发更新重复元素各自的值

way.updateRepeats("somethingToBeLooped")
Watcher methods

way.watch(selector, callback[value])
观察给定值的变化

way.watch("some.data", function(value) {
 console.log("Data has been updated to value: " + value);
});

way.watchAll(callback[selector, value])
观察所有way.js中存储数据的变化

way.watchAll(function(selector, value) {
 console.log("The data " + selector + " has been changed.", value);
});
Global options

way.options.persistent (Boolean)
当document.ready (true by default)时,设置是否从localstorage中恢复数据

way.options.persistent = true

way.options.timeoutInput (Number)
Number of milliseconds of the timeout between keypresses on bound elements to store their values to the datastore (50 by default).

way.options.timeoutInput = 50

way.options.timeoutDOM (Number)
Number of milliseconds of the timeout between scans of the DOM to list bound elements on each DOM change (500 by default).

way.options.timeoutDOM = 500
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,686评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,668评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,160评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,736评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,847评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,043评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,129评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,872评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,318评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,645评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,777评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,861评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,589评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,687评论 2 351

推荐阅读更多精彩内容