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/nav-bar/README.md
+21 -21
View File
@@ -34,9 +34,9 @@ export default {
},
onClickRight() {
Toast('Button');
}
}
}
},
},
};
```
### Use Slot
@@ -44,7 +44,7 @@ export default {
```html
<van-nav-bar title="Title" left-text="Back" left-arrow>
<template #right>
<van-icon name="search"/>
<van-icon name="search" />
</template>
</van-nav-bar>
```
@@ -54,27 +54,27 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| title | Title | *string* | `''` |
| left-text | Left Text | *string* | `''` |
| right-text | Right Text | *string* | `''` |
| left-arrow | Whether to show left arrow | *boolean* | `false` |
| border | Whether to show bottom border | *boolean* | `true` |
| fixed | Whether to fixed top | *boolean* | `false` |
| placeholder `v2.5.9` | Whether to generage a placeholder element when fixed | *boolean* | `false` |
| z-index | Z-index | *number \| string* | `1` |
| --- | --- | --- | --- |
| title | Title | _string_ | `''` |
| left-text | Left Text | _string_ | `''` |
| right-text | Right Text | _string_ | `''` |
| left-arrow | Whether to show left arrow | _boolean_ | `false` |
| border | Whether to show bottom border | _boolean_ | `true` |
| fixed | Whether to fixed top | _boolean_ | `false` |
| placeholder `v2.5.9` | Whether to generage a placeholder element when fixed | _boolean_ | `false` |
| z-index | Z-index | _number \| string_ | `1` |
### Slots
| Name | Description |
|------|------|
| title | Custom title |
| left | Custom left side content |
| Name | Description |
| ----- | ------------------------- |
| title | Custom title |
| left | Custom left side content |
| right | Custom right side content |
### Events
| Event | Description | Arguments |
|------|------|------|
| click-left | Triggered when click left button | - |
| click-right | Triggered when click right button | - |
| Event | Description | Arguments |
| ----------- | --------------------------------- | --------- |
| click-left | Triggered when click left button | - |
| click-right | Triggered when click right button | - |
src/nav-bar/README.zh-CN.md
+21 -21
View File
@@ -34,9 +34,9 @@ export default {
},
onClickRight() {
Toast('按钮');
}
}
}
},
},
};
```
### 使用插槽
@@ -46,7 +46,7 @@ export default {
```html
<van-nav-bar title="标题" left-text="返回" left-arrow>
<template #right>
<van-icon name="search" size="18" />
<van-icon name="search" size="18" />
</template>
</van-nav-bar>
```
@@ -56,27 +56,27 @@ export default {
### Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| title | 标题 | *string* | `''` |
| left-text | 左侧文案 | *string* | `''` |
| right-text | 右侧文案 | *string* | `''` |
| left-arrow | 是否显示左侧箭头 | *boolean* | `false` |
| border | 是否显示下边框 | *boolean* | `true` |
| fixed | 是否固定在顶部 | *boolean* | `false` |
| placeholder `v2.5.9` | 固定在顶部时，是否在标签位置生成一个等高的占位元素 | *boolean* | `false` |
| z-index | 元素 z-index | *number \| string* | `1` |
| --- | --- | --- | --- |
| title | 标题 | _string_ | `''` |
| left-text | 左侧文案 | _string_ | `''` |
| right-text | 右侧文案 | _string_ | `''` |
| left-arrow | 是否显示左侧箭头 | _boolean_ | `false` |
| border | 是否显示下边框 | _boolean_ | `true` |
| fixed | 是否固定在顶部 | _boolean_ | `false` |
| placeholder `v2.5.9` | 固定在顶部时，是否在标签位置生成一个等高的占位元素 | _boolean_ | `false` |
| z-index | 元素 z-index | _number \| string_ | `1` |
### Slots
| 名称 | 说明 |
|------|------|
| title | 自定义标题 |
| left | 自定义左侧区域内容 |
| 名称 | 说明 |
| ----- | ------------------ |
| title | 自定义标题 |
| left | 自定义左侧区域内容 |
| right | 自定义右侧区域内容 |
### Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click-left | 点击左侧按钮时触发 | - |
| click-right | 点击右侧按钮时触发 | - |
| 事件名 | 说明 | 回调参数 |
| ----------- | ------------------ | -------- |
| click-left | 点击左侧按钮时触发 | - |
| click-right | 点击右侧按钮时触发 | - |