You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@weex.apache.org by mo...@apache.org on 2018/12/23 12:58:06 UTC
[incubator-weex-site] branch draft updated: Update docs for div, a,
cell
This is an automated email from the ASF dual-hosted git repository.
moshen pushed a commit to branch draft
in repository https://gitbox.apache.org/repos/asf/incubator-weex-site.git
The following commit(s) were added to refs/heads/draft by this push:
new 4aa70d7 Update docs for div, a, cell
4aa70d7 is described below
commit 4aa70d772180dd6fff6fa010bc16f8829fc701ca
Author: wqyfavor <qi...@taobao.com>
AuthorDate: Sun Dec 23 20:57:57 2018 +0800
Update docs for div, a, cell
---
docs/docs/components/a.md | 22 +++++++++++++++-------
docs/docs/components/cell.md | 6 ++++--
docs/docs/components/div.md | 38 ++++++++------------------------------
docs/zh/docs/components/a.md | 13 ++++++++++---
docs/zh/docs/components/cell.md | 6 ++++--
docs/zh/docs/components/div.md | 38 ++++++++++++--------------------------
6 files changed, 53 insertions(+), 70 deletions(-)
diff --git a/docs/docs/components/a.md b/docs/docs/components/a.md
index 6e4d40f..999e50b 100644
--- a/docs/docs/components/a.md
+++ b/docs/docs/components/a.md
@@ -1,3 +1,5 @@
+# <a>
+
## Summary
`<a>` is mainly used for navigation between weex pages。
@@ -8,12 +10,11 @@
## Basic Usage
Wrap the element navigating from with `<a>`
-
- <a href="http://dotwe.org/raw/dist/a5e3760925ac3b9d68a3aa0cc0298857.bundle.wx">
- <text>Jump</text>
- </a>
-
-Refer the [demo](http://dotwe.org/vue/1cec564d6e25c169a0a9a92db3a00955).
+```Html
+<a href="http://dotwe.org/raw/dist/a5e3760925ac3b9d68a3aa0cc0298857.bundle.wx">
+ <text>Jump</text>
+</a>
+```
## Attributes
@@ -29,4 +30,11 @@ Support [common events](../events/common-events.html)
> **Notes:** The execution order of callback function of click and href is **undefined**. Do **not** use click event to do the preprocessing of `href`.
## Examples
-* [Basic usage for `<a>`](http://dotwe.org/vue/1cec564d6e25c169a0a9a92db3a00955) .
+
+```Html
+<a href="http://emas-ha-remote-log-poc.oss-cn-beijing.aliyuncs.com/eweex/app/biz-docs-com-mod/upload/271ccdca-db41-423d-981c-c7c6751ba479/show_1.js">
+ <text>主会场</text>
+</a>
+```
+
+[Demo](http://dotwe.org/vue/3b789771e48be92a70bd682f084b84b5)
diff --git a/docs/docs/components/cell.md b/docs/docs/components/cell.md
index 2c3d991..d16440f 100644
--- a/docs/docs/components/cell.md
+++ b/docs/docs/components/cell.md
@@ -1,3 +1,5 @@
+# <cell>
+
## Summary
This component must be used as a subcomponent of a [`list`](./list.html) [`recycler`](./list.html) [`waterfall`](./waterfall.html) component.
@@ -19,13 +21,13 @@ This type of component supports all kinds of weex component as its child compone
### Styles
-* **common styles**. Check out [common styles](/wiki/common-styles.html).
+* **common styles**. Check out [common styles](../styles/common-styles.html).
**Notes:** Cell itself is a container and its layout info is managed by parent component such as list. So `margin` should not be specified for a cell.
### Events
-* **common events**. Check out [common events](/wiki/common-events.html).
+* **common events**. Check out [common events](../events/common-events.html).
### Example
diff --git a/docs/docs/components/div.md b/docs/docs/components/div.md
index f9ce7f6..401ddac 100644
--- a/docs/docs/components/div.md
+++ b/docs/docs/components/div.md
@@ -1,45 +1,23 @@
-# Div Component
+# <div>
-`<div>` is a base container component.support all
+## Summary
-- [common styles](/wiki/common-styles.html)
-- [common events](/wiki/common-events.html)
-- flexbox layout
-
-similar to `div` in `html`
+`<div>` is the base container component.
## Child Components
-`<div>` is base container component ,support all compenents as child (include `div` self)
-
-## Attributes
-
-* **common attributes**.
+`<div>` supports all kinds of components as it child including `<div>`.
## Styles
* **common styles**. support [common styles](../styles/common-styles.html).
## Events
+
* **common events**. support [common events](../events/common-events.html).
## Other
-* don't add text in `<div>`directly。if need show text, use `<text>`,see Example
-* `<div>` can't scroll automatic in native. even component's height above screen's height
-* `<div>` for good performance,depth level don't be too deep, suggest __depth level < 14__
-
-## Example
-
-
-- code
-
- ``` vue{2}
- <template>
- <div>
- <text>Hello World!</text>
- </div>
- </template>
- ```
-
-- [try it](http://dotwe.org/vue/57cc2dd8955b0ead3e5b46e3df2f58b9) (naitve can't scroll automatic)you scan use [<list>](/docs/list.html)、[<scroller>](/docs/scroller.html) for scroll
+* Don't add text in `<div>`directly. Use `<text>` instead.
+* In Weex, `<div>` cannot scroll.
+* Depth level of `<div>` should be controlled for better performance. We sugges lower than 14 depth level.
diff --git a/docs/zh/docs/components/a.md b/docs/zh/docs/components/a.md
index 4ad79e3..d0af8e3 100644
--- a/docs/zh/docs/components/a.md
+++ b/docs/zh/docs/components/a.md
@@ -1,6 +1,14 @@
+# <a>
+
## 简介
-<a> 组件用于实现页面间的跳转。
+`<a>` 组件用于实现页面间的跳转。
+
+```Html
+<a href="http://dotwe.org/raw/dist/a5e3760925ac3b9d68a3aa0cc0298857.bundle.wx">
+ <text>Jump</text>
+</a>
+```
## 属性
@@ -19,7 +27,6 @@
- 不能直接在 `<a>` 中添加文本。
- `click` 事件的回调函数和 `href` 跳转的执行顺序**未被定义**,**不要**使用 `click` 来进行 `href` 跳转前的逻辑处理。
-
## 示例
```Html
@@ -28,4 +35,4 @@
</a>
```
-[运行case](http://dotwe.org/vue/3b789771e48be92a70bd682f084b84b5)
+[示例](http://dotwe.org/vue/3b789771e48be92a70bd682f084b84b5)
diff --git a/docs/zh/docs/components/cell.md b/docs/zh/docs/components/cell.md
index fa46a4b..8b76cfb 100644
--- a/docs/zh/docs/components/cell.md
+++ b/docs/zh/docs/components/cell.md
@@ -1,3 +1,5 @@
+# <cell>
+
## 简介
Cell 必须以一级子组件的形式存在于 [`list`](./list.html) [`recycler`](./list.html) [`waterfall`](./waterfall.html) 中。
@@ -19,13 +21,13 @@ Cell 支持添加任意类型的组件作为自己的子组件。
## 样式
-* **通用样式** 支持所有[通用样式](/cn/wiki/common-styles.html)。
+* **通用样式** 支持所有[通用样式](../styles/common-styles.html)。
**Notes:** Cell 的排版的位置是由父容器控制的,所以一般不要为其指定 `margin` 样式。
## 事件
-* **通用事件** 支持所有[通用事件](/cn/wiki/common-events.html)。
+* **通用事件** 支持所有[通用事件](../events/common-events.html)。
### Example
diff --git a/docs/zh/docs/components/div.md b/docs/zh/docs/components/div.md
index 5eacf2d..58f4f10 100644
--- a/docs/zh/docs/components/div.md
+++ b/docs/zh/docs/components/div.md
@@ -1,37 +1,23 @@
-# 简介
+# <div>
-`<div>` 组件是用于包装其它组件的最基本容器。支持所有的通用样式、特性、flexbox 布局。其类似于 HTML 的 `<div>` 容器,
+## 简介
-## 子组件
-
-`<div>` 是基本容器组件,支持包括 `<div>` 在内的任何组件作为自己的子组件。
+`<div>` 是通用容器。
-## 属性
+## 子组件
-* **通用属性**.
+`<div>` 支持各种类型的子元素,包括 `<div>` 自己。
## 样式
-* **通用样式**. 参见[通用样式](../styles/common-styles.html).
-
-## 事件
-
-* **通用事件**. 参见[通用事件](../events/common-events.html).
-
-## 其它
+* **通用样式** 支持所有[通用样式](../styles/common-styles.html)。
-* 不能直接在 `<div>` 中添加文本。如果要展示文本,应该使用 `<text>` 组件。
-* `<div>` 在 native 中不可滚动,即使显式设置高度也一样。
-* `<div>` 为了有一个好的性能,嵌套层级不宜过深,建议 __深度<14层__ 。
+## Events
-## 例子
+* **通用事件** 支持所有[通用事件](../events/common-events.html)。
-``` vue{2}
-<template>
- <div>
- <text>Hello World!</text>
- </div>
-</template>
-```
+## Other
-- [运行case](http://dotwe.org/vue/57cc2dd8955b0ead3e5b46e3df2f58b9) (naitve 不可滚动)需要使用 [<list>](/docs/list.html)、[<scroller>](/docs/scroller.html) 组件实现。
+* 不要在 `<div>` 中直接添加文本,而要使用 `<text>` 组件。
+* 在 Weex 中,`<div>` 不可滚动。
+* 要控制 `<div>` 的层级,建议不要超过14层,否则会很影响页面性能。