* [doc] update changes doc since 0.10
Project: http://git-wip-us.apache.org/repos/asf/incubator-weex/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex/commit/f4a57cc5 Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex/tree/f4a57cc5 Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex/diff/f4a57cc5 Branch: refs/heads/dev Commit: f4a57cc5a2efe3c259607d929c546b936c909682 Parents: 5c72f20 Author: moxun.ljf <furm...@foxmail.com> Authored: Wed Mar 29 11:46:51 2017 +0800 Committer: moxun.ljf <furm...@foxmail.com> Committed: Wed Mar 29 11:46:51 2017 +0800 ---------------------------------------------------------------------- doc/source/cn/references/components/list.md | 13 +++++++++++++ doc/source/cn/references/components/scroller.md | 16 +++++++++++++++- doc/source/cn/references/components/slider.md | 8 ++++++++ doc/source/cn/references/modules/dom.md | 1 + 4 files changed, 37 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-weex/blob/f4a57cc5/doc/source/cn/references/components/list.md ---------------------------------------------------------------------- diff --git a/doc/source/cn/references/components/list.md b/doc/source/cn/references/components/list.md index 4055fe3..3cc3049 100644 --- a/doc/source/cn/references/components/list.md +++ b/doc/source/cn/references/components/list.md @@ -42,6 +42,7 @@ version: 2.1 ## ç¹æ§ - `loadmoreoffset {number}`ï¼é»è®¤å¼ä¸º 0ï¼è§¦å `loadmore` äºä»¶æéè¦çåç´å移è·ç¦»ï¼è®¾å¤å±å¹åºé¨ä¸ `<list>` åºé¨ä¹é´çè·ç¦»ï¼ãå½ `<list>` çæ»å¨æ¡æ»å¨å°è¶³å¤æ¥è¿ `<list>` åºé¨æ¶å°ä¼è§¦å `loadmore` è¿ä¸ªäºä»¶ã +- `offset-accuracy {number}` <sup class="wx-v">0.11+</sup>ï¼æ§å¶`onscroll`äºä»¶è§¦åçé¢çï¼é»è®¤å¼ä¸º10ï¼è¡¨ç¤ºä¸¤æ¬¡`onscroll`äºä»¶ä¹é´å表è³å°æ»å¨äº10pxã注æï¼å°è¯¥å¼è®¾ç½®ä¸ºè¾å°çæ°å¼ä¼æé«æ»å¨äºä»¶éæ ·ç精度ï¼ä½åæ¶ä¹ä¼éä½é¡µé¢çæ§è½ã ## æ ·å¼ @@ -59,6 +60,15 @@ version: 2.1 - `loadmore` <sup class="wx-v">0.5+</sup>ï¼å¦æå表æ»å¨å°åºé¨å°ä¼ç«å³è§¦åè¿ä¸ªäºä»¶ï¼ä½ å¯ä»¥å¨è¿ä¸ªäºä»¶çå¤çå½æ°ä¸å è½½ä¸ä¸é¡µçå表项ã - `onscroll` <sup class="wx-v">0.11+</sup>: å表åçæ»å¨æ¶å°ä¼è§¦å该äºä»¶ï¼äºä»¶çé»è®¤æ½æ ·ç为10pxï¼å³å表æ¯æ»å¨10px触åä¸æ¬¡ï¼å¯éè¿å±æ§`offset-accuracy`设置æ½æ ·çã + + äºä»¶ä¸ event 对象å±æ§ï¼ + - `contentSize {Object}`ï¼å表çå 容尺寸 + - `width {number}`: å表å 容宽度 + - `height {number}`: å表å 容é«åº¦ + - `contentOffset {Object}`: å表çå移尺寸 + - `x {number}`: xè½´ä¸çå移é + - `y {number}`: yè½´ä¸çå移é + - éç¨äºä»¶ æ¯æææéç¨äºä»¶ï¼ @@ -76,6 +86,9 @@ version: 2.1 æ»å¨å°å表æ个æå®é¡¹æ¯å¸¸è§éæ±ï¼`<list>` æå±äºè¯¥åè½æ¯ææ»å¨å°æå® `<cell>`ãéè¿ `dom` module 访é®ï¼æ´å¤ä¿¡æ¯å¯åè [dom module](../modules/dom.html) ã +### resetLoadmore() <sup class="wx-v">0.9+</sup> +å¨é»è®¤æ åµä¸ï¼è§¦å`loadmore`äºä»¶åï¼å¦æå表ä¸å 容没æåçåæ´ï¼åä¸ä¸æ¬¡æ»å¨å°å表æ«å°¾æ¶å°ä¸ä¼å次触å`loadmore`äºä»¶ï¼ä½ å¯ä»¥éè¿è°ç¨`resetLoadmore()`æ¹æ³æ¥æç ´è¿ä¸éå¶ï¼è°ç¨è¯¥æ¹æ³åï¼ä¸ä¸æ¬¡æ»å¨å°å表æ«å°¾æ¶å°å¼ºå¶è§¦å`loadmore`ã + #### åæ° - `node {node}`ï¼æå®ç®æ èç¹ã http://git-wip-us.apache.org/repos/asf/incubator-weex/blob/f4a57cc5/doc/source/cn/references/components/scroller.md ---------------------------------------------------------------------- diff --git a/doc/source/cn/references/components/scroller.md b/doc/source/cn/references/components/scroller.md index 297f712..175b3f7 100644 --- a/doc/source/cn/references/components/scroller.md +++ b/doc/source/cn/references/components/scroller.md @@ -41,7 +41,8 @@ version: 2.1 ![mobile_preview](../images/scroller_1.jpg) -- `loadmoreretry {number}`ï¼é»è®¤å¼ä¸º 0ï¼å½ `loadmore` 失败æ¶æ¯å¦éç½® `loadmore` ç¸å ³ç UIï¼å¼ä¸ä¸æ ·å°±ä¼éç½®ã +- ~~`loadmoreretry {number}`ï¼é»è®¤å¼ä¸º 0ï¼å½ `loadmore` 失败æ¶æ¯å¦éç½® `loadmore` ç¸å ³ç UIï¼å¼ä¸ä¸æ ·å°±ä¼éç½®ã~~ 该å±æ§å·²åºå¼ï¼è¯·ä½¿ç¨`resetLoadmore()`å½æ°å®ç°éç½®`loadmore`çæä½ã +- `offset-accuracy {number}` <sup class="wx-v">0.11+</sup>ï¼æ§å¶`onscroll`äºä»¶è§¦åçé¢çï¼é»è®¤å¼ä¸º10ï¼è¡¨ç¤ºä¸¤æ¬¡`onscroll`äºä»¶ä¹é´å表è³å°æ»å¨äº10pxã注æï¼å°è¯¥å¼è®¾ç½®ä¸ºè¾å°çæ°å¼ä¼æé«æ»å¨äºä»¶éæ ·ç精度ï¼ä½åæ¶ä¹ä¼éä½é¡µé¢çæ§è½ã ## æ ·å¼ @@ -58,6 +59,16 @@ version: 2.1 ## äºä»¶ - `loadmore` <sup class="wx-v">v0.5+</sup>ï¼å¦ææ»å¨å°åºé¨å°ä¼ç«å³è§¦åè¿ä¸ªäºä»¶ï¼ä½ å¯ä»¥å¨è¿ä¸ªäºä»¶çå¤çå½æ°ä¸å è½½ä¸ä¸é¡µçå表项ã +- `onscroll` <sup class="wx-v">0.11+</sup>: å表åçæ»å¨æ¶å°ä¼è§¦å该äºä»¶ï¼äºä»¶çé»è®¤æ½æ ·ç为10pxï¼å³å表æ¯æ»å¨10px触åä¸æ¬¡ï¼å¯éè¿å±æ§`offset-accuracy`设置æ½æ ·çã + + äºä»¶ä¸ event 对象å±æ§ï¼ + - `contentSize {Object}`ï¼å表çå 容尺寸 + - `width {number}`: å表å 容宽度 + - `height {number}`: å表å 容é«åº¦ + - `contentOffset {Object}`: å表çå移尺寸 + - `x {number}`: xè½´ä¸çå移é + - `y {number}`: yè½´ä¸çå移é + - éç¨äºä»¶ æ¯æææéç¨äºä»¶ï¼ @@ -75,6 +86,9 @@ version: 2.1 æ»å¨å°å表æ个æå®é¡¹æ¯å¸¸è§éæ±ï¼`<list>` æå±äºè¯¥åè½æ¯ææ»å¨å°æå® `<cell>`ãéè¿ `dom` module 访é®ï¼æ´å¤ä¿¡æ¯å¯åè [dom module](../modules/dom.html) ã +### resetLoadmore() <sup class="wx-v">0.9+</sup> +å¨é»è®¤æ åµä¸ï¼è§¦å`loadmore`äºä»¶åï¼å¦æå表ä¸å 容没æåçåæ´ï¼åä¸ä¸æ¬¡æ»å¨å°å表æ«å°¾æ¶å°ä¸ä¼å次触å`loadmore`äºä»¶ï¼ä½ å¯ä»¥éè¿è°ç¨`resetLoadmore()`æ¹æ³æ¥æç ´è¿ä¸éå¶ï¼è°ç¨è¯¥æ¹æ³åï¼ä¸ä¸æ¬¡æ»å¨å°å表æ«å°¾æ¶å°å¼ºå¶è§¦å`loadmore`ã + #### åæ° - `node {node}`ï¼æå®ç®æ èç¹ã http://git-wip-us.apache.org/repos/asf/incubator-weex/blob/f4a57cc5/doc/source/cn/references/components/slider.md ---------------------------------------------------------------------- diff --git a/doc/source/cn/references/components/slider.md b/doc/source/cn/references/components/slider.md index 190e01d..049ff06 100644 --- a/doc/source/cn/references/components/slider.md +++ b/doc/source/cn/references/components/slider.md @@ -23,6 +23,8 @@ version: 2.1 - `interval {number}`ï¼å¼ä¸ºæ¯«ç§æ°ï¼æ¤å¼è®¾å® slider åæ¢æ¶é´é´éãå½ `auto-play` å¼ä¸º `true` æ¶çæã +- `offset-x-accuracy {number}`<sup class="wx-v">0.11+</sup>ï¼æ§å¶`onscroll`äºä»¶è§¦åçé¢çï¼é»è®¤å¼ä¸º10ï¼è¡¨ç¤ºä¸¤æ¬¡`onscroll`äºä»¶ä¹é´Slider Pageè³å°æ»å¨äº10pxã注æï¼å°è¯¥å¼è®¾ç½®ä¸ºè¾å°çæ°å¼ä¼æé«æ»å¨äºä»¶éæ ·ç精度ï¼ä½åæ¶ä¹ä¼éä½é¡µé¢çæ§è½ã + ## æ ·å¼ - éç¨æ ·å¼ï¼æ¯æææéç¨æ ·å¼ @@ -42,6 +44,12 @@ version: 2.1 äºä»¶ä¸ event 对象å±æ§ï¼ - `index`ï¼å±ç¤ºçå¾çç´¢å¼ +- `onscroll` <sup class="wx-v">0.11+</sup>: å表åçæ»å¨æ¶å°ä¼è§¦å该äºä»¶ï¼äºä»¶çé»è®¤æ½æ ·ç为10pxï¼å³å表æ¯æ»å¨10px触åä¸æ¬¡ï¼å¯éè¿å±æ§`offset-accuracy`设置æ½æ ·çã + + äºä»¶ä¸ event 对象å±æ§ï¼ + - `offsetXRatio {number}`ï¼è¡¨ç¤ºå½å页é¢çå移æ¯ä¾ï¼åå¼èå´ä¸º[-1, 1]ï¼è´å¼è¡¨ç¤ºå左侧æ»å¨ï¼æ£å¼åå³ãä¾å¦ï¼`-0.2`表示å½åitemæ20%çåºå被æ»å¨å°slider左侧边ç以å¤ï¼`0.3`表示å½åitemæ30%çåºå被æ»å¨å°sliderå³ä¾§è¾¹ç以å¤ã + + - éç¨äºä»¶ æ¯æææéç¨äºä»¶ï¼ http://git-wip-us.apache.org/repos/asf/incubator-weex/blob/f4a57cc5/doc/source/cn/references/modules/dom.md ---------------------------------------------------------------------- diff --git a/doc/source/cn/references/modules/dom.md b/doc/source/cn/references/modules/dom.md index 2fa153a..ed4f1c2 100644 --- a/doc/source/cn/references/modules/dom.md +++ b/doc/source/cn/references/modules/dom.md @@ -30,6 +30,7 @@ version: 2.1 - `node {Node}`ï¼ä½ è¦æ»å¨å°çé£ä¸ªèç¹ - `options {Object}`ï¼å¦ä¸é项 - `offset {number}`ï¼ä¸ä¸ªå°å ¶å¯è§ä½ç½®çå移è·ç¦»ï¼é»è®¤æ¯ `0` + - `animated {boolean}` <sup class="wx-v">0.10+</sup>ï¼æ¯å¦éè¦é带æ»å¨å¨ç»ï¼é»è®¤æ¯`true` #### 示ä¾