Yao d331b69b0c
[Doc] 更新文档网站 (#204)
* 修改组件 readme

* remove empty line
2018-04-28 12:06:39 +08:00

67 lines
3.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## Cell 单元格
### 使用指南
#### 单个 cell 使用示例
~~~json
{
...
"usingComponents": {
"zan-cell": "../../dist/cell/index",
}
...
}
~~~
~~~wxml
<zan-cell title="单行列表" label="附加描述" value="详细信息"></zan-cell>
~~~
#### cell 组使用示例
多个 cell 组件必须作为 `cell-group` 组件的子组件,否则可能出现显示问题。
```json
{
...
"usingComponents": {
"zan-cell": "../../dist/cell/index",
"zan-cell-group": "../../dist/cell-group/index"
}
...
}
```
```wxml
<zan-cell-group>
<zan-cell title="只显示箭头" is-link="{{true}}"></zan-cell>
<zan-cell title="跳转到首页" is-link="/pages/dashboard/index"></zan-cell>
<zan-cell title="单行列表" label="附加描述" value="详细信息"></zan-cell>
<zan-cell title="表单">
<input slot="footer" type="digit" placeholder="带小数点的数字键盘"/>
</zan-cell>
<zan-cell title="开关">
<switch slot="footer" checked/>
</zan-cell>
</zan-cell-group>
```
### 属性与事件
| 名称 | 类型 | 是否必须 | 默认 | 描述 |
| ------------- | ----------- | -------- | ----- | -------------------------------------------------------------------------------------------------------- |
| title | String | 否 | 无 | 左侧标题 |
| label | Boolean | 否 | false | 标题下方的描述信息 |
| value | String | 否 | 取消 | 右侧内容 |
| isLink | Boolean | 否 | false | 是否展示右侧箭头并开启尝试以 url 跳转 |
| url | String | 否 | - | 当 isLink 设置为 true 时,点击 cell 会尝试跳转到该路径 |
| linkType | String | 否 | navigateTo | 链接跳转类型,可选值为 `navigateTo``redirectTo``switchTab``reLaunch` |
| onlyTapFooter | Boolean | 否 | false | 只有点击 footer 区域才触发 tab 事件 |
| bindtap | EventHandle | 否 | 无 | 点击 cell 时触发,`onlyTapFooter``true` 时点击 footer 区域触发 |
### 可用的 slot
| 名称 | 是否必须 | 默认 | 描述 |
| ------------- | ----------- | ---- | --------------------------------------------------------------------- |
| 默认 | 否 | 无 | 左侧除了 `title``label` 外的自定义 wxml 内容 |
| icon | 否 | 无 | 标题前自定义的 icon可使用 `icon` 自定义组件,具体使用参考 icon 组件 |
| footer | 否 | 无 | 右侧自定义 wxml 内容,如果设置了 `value` 属性,则不生效 |