alighasami/vant
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: prettier all markdown files

Browse Source
This commit is contained in:
chenjiahan
2020-04-11 09:17:33 +08:00
committed by neverland
parent 48067f79db
commit 7f84f8a487
140 changed files with 4441 additions and 4723 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/cell/README.zh-CN.md
+38 -42
View File
@@ -96,10 +96,7 @@ Vue.use(CellGroup);
<van-cell title="单元格" icon="shop-o">
<!-- 使用 right-icon 插槽来自定义右侧图标 -->
<template #right-icon>
<van-icon
name="search"
style="line-height: inherit;"
/>
<van-icon name="search" style="line-height: inherit;" />
</template>
</van-cell>
```
@@ -112,59 +109,58 @@ Vue.use(CellGroup);
<van-cell center title="单元格" value="内容" label="描述信息" />
```
## API
### CellGroup Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| title | 分组标题 | *string* | `-` |
| border | 是否显示外边框 | *boolean* | `true` |
| 参数 | 说明 | 类型 | 默认值 |
| ------ | -------------- | --------- | ------ |
| title | 分组标题 | _string_ | `-` |
| border | 是否显示外边框 | _boolean_ | `true` |
### Cell Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| title | 左侧标题 | *number \| string* | - |
| value | 右侧内容 | *number \| string* | - |
| label | 标题下方的描述信息 | *string* | - |
| size | 单元格大小，可选值为 `large` | *string* | - |
| icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
| icon-prefix `v2.5.3` | 图标类名前缀，同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | *string* | `van-icon` |
| url | 点击后跳转的链接地址 | *string* | - |
| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - |
| border | 是否显示内边框 | *boolean* | `true` |
| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` |
| clickable | 是否开启点击反馈 | *boolean* | `false` |
| is-link | 是否展示右侧箭头并开启点击反馈 | *boolean* | `false` |
| required | 是否显示表单必填星号 | *boolean* | `false` |
| center | 是否使内容垂直居中 | *boolean* | `false` |
| arrow-direction | 箭头方向，可选值为 `left` `up` `down` | *string* | `right` |
| title-style | 左侧标题额外样式 | *any* | - |
| title-class | 左侧标题额外类名 | *any* | - |
| value-class | 右侧内容额外类名 | *any* | - |
| label-class | 描述信息额外类名 | *any* | - |
| --- | --- | --- | --- |
| title | 左侧标题 | _number \| string_ | - |
| value | 右侧内容 | _number \| string_ | - |
| label | 标题下方的描述信息 | _string_ | - |
| size | 单元格大小，可选值为 `large` | _string_ | - |
| icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | _string_ | - |
| icon-prefix `v2.5.3` | 图标类名前缀，同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
| url | 点击后跳转的链接地址 | _string_ | - |
| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | _string \| object_ | - |
| border | 是否显示内边框 | _boolean_ | `true` |
| replace | 是否在跳转时替换当前页面历史 | _boolean_ | `false` |
| clickable | 是否开启点击反馈 | _boolean_ | `false` |
| is-link | 是否展示右侧箭头并开启点击反馈 | _boolean_ | `false` |
| required | 是否显示表单必填星号 | _boolean_ | `false` |
| center | 是否使内容垂直居中 | _boolean_ | `false` |
| arrow-direction | 箭头方向，可选值为 `left` `up` `down` | _string_ | `right` |
| title-style | 左侧标题额外样式 | _any_ | - |
| title-class | 左侧标题额外类名 | _any_ | - |
| value-class | 右侧内容额外类名 | _any_ | - |
| label-class | 描述信息额外类名 | _any_ | - |
### Cell Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击单元格时触发 | *event: Event* |
| 事件名 | 说明 | 回调参数 |
| ------ | ---------------- | -------------- |
| click | 点击单元格时触发 | _event: Event_ |
### CellGroup Slots
| 名称 | 说明 |
|------|------|
| default | 默认插槽 |
| title | 自定义分组标题 |
| 名称 | 说明 |
| ------- | -------------- |
| default | 默认插槽 |
| title | 自定义分组标题 |
### Cell Slots
| 名称 | 说明 |
|------|------|
| default | 自定义右侧内容 |
| title | 自定义左侧标题 |
| label | 自定义标题下方描述 |
| icon | 自定义左侧图标 |
| 名称 | 说明 |
| ---------- | ----------------------------- |
| default | 自定义右侧内容 |
| title | 自定义左侧标题 |
| label | 自定义标题下方描述 |
| icon | 自定义左侧图标 |
| right-icon | 自定义右侧按钮，默认为`arrow` |