blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00
Code Issues Projects Releases Wiki Activity

Merge branch 'dev' into feature/form

Browse Source
This commit is contained in:
陈嘉涵 2020-02-10 10:06:57 +08:00
commit f385c94040
64 changed files with 168 additions and 161 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
packages/vant-cli/site/desktop/components/Content.vue
View File

@ -37,6 +37,7 @@ export default {
}
a {
margin: 0 1px;
color: @van-doc-green;
-webkit-font-smoothing: auto;
}
@ -162,7 +163,7 @@ export default {
box-sizing: border-box;
width: 6px;
height: 6px;
margin-top: 8px;
margin-top: 10px;
border: 1px solid @van-doc-dark-grey;
border-radius: 50%;
content: '';

2
src/action-sheet/README.md
View File

@ -153,7 +153,7 @@ export default {
| Event | Description | Arguments |
|------|------|------|
| select | Triggered when click option | item, index |
| select | Triggered when click option | *action: Action, index: number* |
| cancel | Triggered when cancel click | - |
| click-overlay | Triggered when click overlay | - |
| open | Triggered when open ActionSheet | - |

6
src/action-sheet/README.zh-CN.md
View File

@ -141,7 +141,7 @@ export default {
| title | 顶部标题 | *string* | - |
| cancel-text | 取消按钮文字 | *string* | - |
| description `v2.2.8` | 选项上方的描述信息 | *string* | - |
| close-icon `v2.2.13` | 关闭 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | `cross` |
| close-icon `v2.2.13` | 关闭[图标名称](#/zh-CN/icon)或图片链接 | *string* | `cross` |
| duration `v2.0.3` | 动画时长，单位秒 | *number \| string* | `0.3` |
| round `v2.0.9` | 是否显示圆角 | *boolean* | `true` |
| overlay | 是否显示遮罩层 | *boolean* | `true` |
@ -149,7 +149,7 @@ export default {
| lazy-render | 是否在显示弹层时才渲染节点 | *boolean* | `true` |
| close-on-click-action | 是否在点击选项后关闭 | *boolean* | `false` |
| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `true` |
| safe-area-inset-bottom | 是否开启 [底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `true` |
| safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `true` |
| get-container | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | - |
### Action 数据结构
@ -169,7 +169,7 @@ export default {
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| select | 选中选项时触发，禁用或加载状态下不会触发 | item: 选项对应的对象, index: 选择对应的索引 |
| select | 选中选项时触发，禁用或加载状态下不会触发 | *action: Action, index: number* |
| cancel | 取消按钮点击时触发 | - |
| click-overlay | 点击遮罩层时触发 | - |
| open | 打开菜单时触发 | - |

2
src/address-edit/README.zh-CN.md
View File

@ -107,7 +107,7 @@ export default {
### 方法
通过 ref 可以获取到 AddressEdit 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 AddressEdit 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|

4
src/area/README.zh-CN.md
View File

@ -2,7 +2,7 @@
### 介绍
省市区三级联动选择，通常与 [弹出层](#/zh-CN/popup) 组件配合使用
省市区三级联动选择，通常与[弹出层](#/zh-CN/popup)组件配合使用
### 引入
@ -80,7 +80,7 @@ Vue.use(Area);
### 方法
通过 ref 可以获取到 Area 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 Area 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|

4
src/button/README.md
View File

@ -125,5 +125,5 @@ Vue.use(Button);
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when click button and not disabled or loading | event: Event |
| touchstart | Triggered when touch start | event: TouchEvent |
| click | Triggered when click button and not disabled or loading | *event: Event* |
| touchstart | Triggered when touch start | *event: TouchEvent* |

6
src/button/README.zh-CN.md
View File

@ -127,7 +127,7 @@ Vue.use(Button);
| size | 尺寸，可选值为 `large` `small` `mini` | *string* | `normal` |
| text | 按钮文字 | *string* | - |
| color `v2.1.8` | 按钮颜色，支持传入`linear-gradient`渐变色 | *string* | - |
| icon | 左侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
| tag | HTML 标签 | *string* | `button` |
| native-type | 原生 button 标签 type 属性 | *string* | - |
| block | 是否为块级元素 | *boolean* | `false` |
@ -148,5 +148,5 @@ Vue.use(Button);
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击按钮，且按钮状态不为加载或禁用时触发 | event: Event |
| touchstart | 开始触摸按钮时触发 | event: TouchEvent |
| click | 点击按钮，且按钮状态不为加载或禁用时触发 | *event: Event* |
| touchstart | 开始触摸按钮时触发 | *event: TouchEvent* |

4
src/calendar/README.md
View File

@ -249,8 +249,8 @@ Set `poppable` to `false`, the calendar will be displayed directly on the page i
| Event | Description | Arguments |
|------|------|------|
| select | Triggered when select date | value: Date \| Date[] |
| confirm | Triggered after date selection is complete，if `show-confirm` is` true`, it is triggered after clicking the confirm button | value: Date \| Date[] |
| select | Triggered when select date | *value: Date \| Date[]* |
| confirm | Triggered after date selection is complete，if `show-confirm` is` true`, it is triggered after clicking the confirm button | *value: Date \| Date[]* |
### Slots

8
src/calendar/README.zh-CN.md
View File

@ -227,7 +227,7 @@ export default {
| show-confirm | 是否展示确认按钮 | *boolean* | `true` |
| close-on-popstate `v2.4.4` | 是否在页面回退时自动关闭 | *boolean* | `false` |
| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `true` |
| safe-area-inset-bottom | 是否开启 [底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `true` |
| safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `true` |
| confirm-text | 确认按钮的文字 | *string* | `确定` |
| confirm-disabled-text | 确认按钮处于禁用状态时的文字 | *string* | `确定` |
| max-range `v2.4.3` | 日期区间最多可选天数，默认无限制 | *number \| string* | - |
@ -251,8 +251,8 @@ export default {
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| select | 点击任意日期时触发 | value: Date \| Date[] |
| confirm | 日期选择完成后触发，若`show-confirm`为`true`，则点击确认按钮后触发 | value: Date \| Date[] |
| select | 点击任意日期时触发 | *value: Date \| Date[]* |
| confirm | 日期选择完成后触发，若`show-confirm`为`true`，则点击确认按钮后触发 | *value: Date \| Date[]* |
### Slots
@ -263,7 +263,7 @@ export default {
### 方法
通过 ref 可以获取到 Calendar 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 Calendar 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|

4
src/card/README.md
View File

@ -82,8 +82,8 @@ Use slot to custom content.
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when clicked | event: Event |
| click-thumb | Triggered when thumb clicked | event: Event |
| click | Triggered when clicked | *event: Event* |
| click-thumb | Triggered when thumb clicked | *event: Event* |
### Slots

4
src/card/README.zh-CN.md
View File

@ -84,8 +84,8 @@ Vue.use(Card);
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击时触发 | event: Event |
| click-thumb | 点击自定义图片时触发 | event: Event |
| click | 点击时触发 | *event: Event* |
| click-thumb | 点击自定义图片时触发 | *event: Event* |
### Slots

2
src/cell/README.md
View File

@ -137,7 +137,7 @@ Vue.use(CellGroup);
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when click cell | event: Event |
| click | Triggered when click cell | *event: Event* |
### CellGroup Slots

4
src/cell/README.zh-CN.md
View File

@ -125,7 +125,7 @@ Vue.use(CellGroup);
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| icon | 左侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
| title | 左侧标题 | *number \| string* | - |
| value | 右侧内容 | *number \| string* | - |
| label | 标题下方的描述信息 | *string* | - |
@ -148,7 +148,7 @@ Vue.use(CellGroup);
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击单元格时触发 | event: Event |
| click | 点击单元格时触发 | *event: Event* |
### CellGroup Slots

16
src/checkbox/README.md
View File

@ -187,9 +187,9 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model (value) | Check status | *boolean* | `false` |
| name | Checkbox name | *any* | - |
| shape | Can be set to `square` | *string* | `round` |
| v-model | Check status | *boolean* | `false` |
| disabled | Disable checkbox | *boolean* | `false` |
| label-disabled | Whether to disable label click | *boolean* | `false` |
| label-position | Can be set to `left` | *string* | `right` |
@ -201,7 +201,7 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Names of all checked checkboxes | *any[]* | - |
| v-model (value) | Names of all checked checkboxes | *any[]* | - |
| max | Maximum amount of checked options | *number \| string* | `0`(Unlimited) |
| disabled | Disable all checkboxes | *boolean* | `false` |
| icon-size `v2.2.3` | Icon size of all checkboxes | *number \| string* | `20px` |
@ -211,21 +211,21 @@ export default {
| Event | Description | Parameters |
|------|------|------|
| change | Triggered when value changed | current value |
| click | Triggered when click checkbox | event: Event |
| change | Triggered when value changed | *checked: boolean* |
| click | Triggered when click checkbox | *event: Event* |
### CheckboxGroup Events
| Event | Description | Parameters |
|------|------|------|
| change | Triggered when value changed | current value |
| change | Triggered when value changed | *names: any[]* |
### Checkbox Slots
| Name | Description | SlotProps |
|------|------|------|
| default | Custom label | - |
| icon | Custom icon | checked: whether to be checked |
| icon | Custom icon | *checked: boolean* |
### CheckboxGroup Methods
@ -233,7 +233,7 @@ Use [ref](https://vuejs.org/v2/api/#ref) to get CheckboxGroup instance and call
| Name | Description | Attribute | Return value |
|------|------|------|------|
| toggleAll | Toggle check status of all checkboxes | checked?: boolean | - |
| toggleAll | Toggle check status of all checkboxes | *checked?: boolean* | - |
### Checkbox Methods
@ -241,4 +241,4 @@ Use [ref](https://vuejs.org/v2/api/#ref) to get Checkbox instance and call insta
| Name | Description | Attribute | Return value |
|------|------|------|------|
| toggle | Toggle check status | checked?: boolean | - |
| toggle | Toggle check status | *checked?: boolean* | - |

20
src/checkbox/README.zh-CN.md
View File

@ -203,9 +203,9 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| v-model (value) | 是否为选中状态 | *boolean* | `false` |
| name | 标识符 | *any* | - |
| shape | 形状，可选值为 `square` | *string* | `round` |
| v-model | 是否为选中状态 | *boolean* | `false` |
| disabled | 是否禁用复选框 | *boolean* | `false` |
| label-disabled | 是否禁用复选框文本点击 | *boolean* | `false` |
| label-position | 文本位置，可选值为 `left` | *string* | `right` |
@ -217,7 +217,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| v-model | 所有选中项的标识符 | *any[]* | - |
| v-model (value) | 所有选中项的标识符 | *any[]* | - |
| disabled | 是否禁用所有复选框 | *boolean* | `false` |
| max | 最大可选数，0 为无限制 | *number \| string* | `0` |
| icon-size `v2.2.3` | 所有复选框的图标大小，默认单位为`px` | *number \| string* | `20px` |
@ -227,34 +227,34 @@ export default {
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| change | 当绑定值变化时触发的事件 | 当前组件的值 |
| click | 点击复选框时触发 | event: Event |
| change | 当绑定值变化时触发的事件 | *checked: boolean* |
| click | 点击复选框时触发 | *event: Event* |
### CheckboxGroup Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| change | 当绑定值变化时触发的事件 | 当前组件的值 |
| change | 当绑定值变化时触发的事件 | *names: any[]* |
### Checkbox Slots
| 名称 | 说明 | SlotProps |
|------|------|------|
| default | 自定义文本 | - |
| icon | 自定义图标 | checked: 是否为选中状态 |
| icon | 自定义图标 | *checked: boolean* |
### CheckboxGroup 方法
通过 ref 可以获取到 CheckboxGroup 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 CheckboxGroup 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|
| toggleAll | 切换所有复选框，传`true`为选中，`false`为取消选中，不传参为取反 | checked?: boolean | - |
| toggleAll | 切换所有复选框，传`true`为选中，`false`为取消选中，不传参为取反 | *checked?: boolean* | - |
### Checkbox 方法
通过 ref 可以获取到 Checkbox 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 Checkbox 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|
| toggle | 切换选中状态，传`true`为选中，`false`为取消选中，不传参为取反 | checked?: boolean | - |
| toggle | 切换选中状态，传`true`为选中，`false`为取消选中，不传参为取反 | *checked?: boolean* | - |

4
src/col/README.md
View File

@ -112,10 +112,10 @@ Setting `type` to `flex` to enable flex layout
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when click row | event: Event |
| click | Triggered when click row | *event: Event* |
### Col Events
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when click col | event: Event |
| click | Triggered when click col | *event: Event* |

4
src/col/README.zh-CN.md
View File

@ -115,10 +115,10 @@ Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击时触发 | event: Event |
| click | 点击时触发 | *event: Event* |
### Col Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击时触发 | event: Event |
| click | 点击时触发 | *event: Event* |

2
src/collapse/README.zh-CN.md
View File

@ -101,7 +101,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| name | 唯一标识符，默认为索引值 | *number \| string* | `index` |
| icon | 标题栏左侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| icon | 标题栏左侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
| size | 标题栏大小，可选值为 `large` | *string* | - |
| title | 标题栏左侧内容 | *number \| string* | - |
| value | 标题栏右侧内容 | *number \| string* | - |

2
src/contact-card/README.md
View File

@ -145,7 +145,7 @@ export default {
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when clicked | event: Event |
| click | Triggered when clicked | *event: Event* |
### ContactList Props

2
src/contact-card/README.zh-CN.md
View File

@ -149,7 +149,7 @@ export default {
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击时触发 | event: Event |
| click | 点击时触发 | *event: Event* |
### ContactList Props

6
src/count-down/README.md
View File

@ -130,15 +130,15 @@ export default {
| Event | Description | Arguments |
|------|------|------|
| finish | Triggered when count down finished | - |
| change `v2.4.4` | Triggered when count down changed | timeData |
| change `v2.4.4` | Triggered when count down changed | *timeData: TimeData* |
### Slots
| Name | Description | SlotProps |
|------|------|------|
| default | Custom Content | timeData |
| default | Custom Content | *timeData: TimeData* |
### timeData Structure
### TimeData Structure
| Name | Description | Type |
|------|------|------|

8
src/count-down/README.zh-CN.md
View File

@ -140,15 +140,15 @@ export default {
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| finish | 倒计时结束时触发 | - |
| change `v2.4.4` | 倒计时变化时触发 | timeData |
| change `v2.4.4` | 倒计时变化时触发 | *timeData: TimeData* |
### Slots
| 名称 | 说明 | SlotProps |
|------|------|------|
| default | 自定义内容 | timeData |
| default | 自定义内容 | *timeData: TimeData* |
### timeData 格式
### TimeData 格式
| 名称 | 说明 | 类型 |
|------|------|------|
@ -160,7 +160,7 @@ export default {
### 方法
通过 ref 可以获取到 CountDown 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 CountDown 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|

4
src/datetime-picker/README.zh-CN.md
View File

@ -2,7 +2,7 @@
### 介绍
时间选择器，支持日期、年月、时分等维度，通常与 [弹出层](#/zh-CN/popup) 组件配合使用
时间选择器，支持日期、年月、时分等维度，通常与[弹出层](#/zh-CN/popup)组件配合使用
### 引入
@ -199,7 +199,7 @@ export default {
### 方法
通过 ref 可以获取到 DatetimePicker 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 DatetimePicker 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|

4
src/dropdown-menu/README.zh-CN.md
View File

@ -154,7 +154,7 @@ export default {
### DropdownItem 方法
通过 ref 可以获取到 DropdownItem 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 DropdownItem 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|
@ -166,4 +166,4 @@ export default {
|------|------|------|
| text | 文字 | *string* |
| value | 标识符 | *number \| string* |
| icon | 左侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* |
| icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | *string* |

14
src/field/README.md
View File

@ -249,13 +249,13 @@ Field support all native events of input tag
| Event | Description | Parameters |
|------|------|------|
| input | Triggered when input value changed | value: current value |
| focus | Triggered when input gets focus | event: Event |
| blur | Triggered when input loses focus | event: Event |
| clear | Triggered when click clear icon | event: Event |
| click | Triggered when click Field | event: Event |
| click-left-icon | Triggered when click the left icon of Field | event: Event |
| click-right-icon | Triggered when click the right icon of Field | event: Event |
| input | Triggered when input value changed | *value: string* |
| focus | Triggered when input gets focus | *event: Event* |
| blur | Triggered when input loses focus | *event: Event* |
| clear | Triggered when click clear icon | *event: Event* |
| click | Triggered when click Field | *event: Event* |
| click-left-icon | Triggered when click the left icon of Field | *event: Event* |
| click-right-icon | Triggered when click the right icon of Field | *event: Event* |
### Methods

20
src/field/README.zh-CN.md
View File

@ -259,8 +259,8 @@ export default {
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` |
| error-message-align | 错误提示文案对齐方式，可选值为 `center` `right` | *string* | `left` |
| autosize | 是否自适应内容高度，只对 textarea 有效，<br>可传入对象,如 { maxHeight: 100, minHeight: 50 }，<br>单位为`px` | *boolean \| object* | `false` |
| left-icon | 左侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| right-icon | 右侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| left-icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
| right-icon | 右侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
### Events
@ -268,17 +268,17 @@ export default {
| 事件 | 说明 | 回调参数 |
|------|------|------|
| input | 输入框内容变化时触发 | value: 输入框当前值 |
| focus | 输入框获得焦点时触发 | event: Event |
| blur | 输入框失去焦点时触发 | event: Event |
| clear | 点击清除按钮时触发 | event: Event |
| click | 点击时触发 | event: Event |
| click-left-icon | 点击左侧图标时触发 | event: Event |
| click-right-icon | 点击右侧图标时触发 | event: Event |
| input | 输入框内容变化时触发 | *value: string (当前输入的值)* |
| focus | 输入框获得焦点时触发 | *event: Event* |
| blur | 输入框失去焦点时触发 | *event: Event* |
| clear | 点击清除按钮时触发 | *event: Event* |
| click | 点击时触发 | *event: Event* |
| click-left-icon | 点击左侧图标时触发 | *event: Event* |
| click-right-icon | 点击右侧图标时触发 | *event: Event* |
### 方法
通过 ref 可以获取到 Field 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 Field 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|

4
src/goods-action/README.zh-CN.md
View File

@ -86,7 +86,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| safe-area-inset-bottom | 是否开启 [底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` |
| safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` |
### GoodsActionIcon Props
@ -108,7 +108,7 @@ export default {
| text | 按钮文字 | *string* | - |
| type | 按钮类型，可选值为 `primary` `info` `warning` `danger` | *string* | `default` |
| color `v2.1.8` | 按钮颜色，支持传入`linear-gradient`渐变色 | *string* | - |
| icon `v2.4.4` | 左侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| icon `v2.4.4` | 左侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
| disabled | 是否禁用按钮 | *boolean* | `false` | - |
| loading | 是否显示为加载状态 | *boolean* | `false` | - |
| url | 点击后跳转的链接地址 | *string* | - |

2
src/grid/README.md
View File

@ -126,7 +126,7 @@ Vue.use(GridItem);
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when clicked | event: Event |
| click | Triggered when clicked | *event: Event* |
### GridItem Slots

4
src/grid/README.zh-CN.md
View File

@ -133,7 +133,7 @@ Vue.use(GridItem);
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| text | 文字 | *string* | - |
| icon | [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| icon | [图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
| dot `v2.2.1` | 是否显示图标右上角小红点 | *boolean* | `false` |
| info `v2.2.1` | 图标右上角徽标的内容 | *number \| string* | - |
| url | 点击后跳转的链接地址 | *string* | - |
@ -144,7 +144,7 @@ Vue.use(GridItem);
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击格子时触发 | event: Event |
| click | 点击格子时触发 | *event: Event* |
### GridItem Slots

2
src/icon/README.md
View File

@ -97,4 +97,4 @@ import 'vant/lib/icon/local.css';
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when click icon | event: Event |
| click | Triggered when click icon | *event: Event* |

2
src/icon/README.zh-CN.md
View File

@ -103,4 +103,4 @@ import 'vant/lib/icon/local.css';
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击图标时触发 | event: Event |
| click | 点击图标时触发 | *event: Event* |

2
src/image/README.md
View File

@ -96,7 +96,7 @@ Vue.use(Lazyload);
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when click image | event: Event |
| click | Triggered when click image | *event: Event* |
| load | Triggered when image loaded | - |
| error | Triggered when image load failed | - |

6
src/image/README.zh-CN.md
View File

@ -111,8 +111,8 @@ Vue.use(Lazyload);
| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | *boolean* | `false` |
| show-error `v2.0.9` | 是否展示图片加载失败提示 | *boolean* | `true` |
| show-loading `v2.0.9` | 是否展示图片加载中提示 | *boolean* | `true` |
| error-icon `v2.4.2` | 失败时提示的 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | `warning-o` |
| loading-icon `v2.4.2` | 加载时提示的 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | `photo-o` |
| error-icon `v2.4.2` | 失败时提示的[图标名称](#/zh-CN/icon)或图片链接 | *string* | `warning-o` |
| loading-icon `v2.4.2` | 加载时提示的[图标名称](#/zh-CN/icon)或图片链接 | *string* | `photo-o` |
### 图片填充模式
@ -128,7 +128,7 @@ Vue.use(Lazyload);
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击图片时触发 | event: Event |
| click | 点击图片时触发 | *event: Event* |
| load | 图片加载完毕时触发 | - |
| error | 图片加载失败时触发 | - |

2
src/list/README.zh-CN.md
View File

@ -177,7 +177,7 @@ export default {
### 方法
通过 ref 可以获取到 List 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 List 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|

4
src/notice-bar/README.md
View File

@ -77,8 +77,8 @@ Vue.use(NoticeBar);
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when click NoticeBar | event: Event |
| close | Triggered when closed | event: Event |
| click | Triggered when click NoticeBar | *event: Event* |
| close | Triggered when closed | *event: Event* |
### Slots

6
src/notice-bar/README.zh-CN.md
View File

@ -75,7 +75,7 @@ Vue.use(NoticeBar);
| text | 通知文本内容 | *string* | `''` |
| color | 文本颜色 | *string* | `#f60` |
| background | 滚动条背景 | *string* | `#fff7cc` |
| left-icon | 左侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| left-icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
| delay | 动画延迟时间 (s) | *number \| string* | `1` |
| speed | 滚动速率 (px/s) | *number \| string* | `50` |
| scrollable | 是否在长度溢出时滚动播放 | *boolean* | `true` |
@ -85,8 +85,8 @@ Vue.use(NoticeBar);
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击通知栏时触发 | event: Event |
| close | 关闭通知栏时触发 | event: Event |
| click | 点击通知栏时触发 | *event: Event* |
| close | 关闭通知栏时触发 | *event: Event* |
### Slots

2
src/number-keyboard/README.zh-CN.md
View File

@ -153,7 +153,7 @@ export default {
| delete-button-text | 删除按钮文字 | *string* | `删除` |
| show-delete-key | 是否展示删除按钮 | *boolean* | `true` |
| hide-on-click-outside | 点击外部时是否收起键盘 | *boolean* | `true` |
| safe-area-inset-bottom | 是否开启 [底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `true` |
| safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `true` |
### Events

2
src/overlay/README.md
View File

@ -69,7 +69,7 @@ export default {
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when clicked | event: Event |
| click | Triggered when clicked | *event: Event* |
### Slots

2
src/overlay/README.zh-CN.md
View File

@ -75,7 +75,7 @@ export default {
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击时触发 | event: Event |
| click | 点击时触发 | *event: Event* |
### Slots

2
src/panel/README.zh-CN.md
View File

@ -44,7 +44,7 @@ Vue.use(Panel);
| title | 标题 | *string* | - |
| desc | 描述 | *string* | - |
| status | 状态 | *string* | - |
| icon | 标题左侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| icon | 标题左侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
### Slots

4
src/picker/README.zh-CN.md
View File

@ -2,7 +2,7 @@
### 介绍
提供多个选项集合供用户选择，支持单列选择和多列级联，通常与 [弹出层](#/zh-CN/popup) 组件配合使用
提供多个选项集合供用户选择，支持单列选择和多列级联，通常与[弹出层](#/zh-CN/popup)组件配合使用
### 引入
@ -318,7 +318,7 @@ export default {
### 方法
通过 ref 可以获取到 Picker 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 Picker 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|

2
src/popup/README.md
View File

@ -139,7 +139,7 @@ export default {
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when click Popup | event: Event |
| click | Triggered when click Popup | *event: Event* |
| open | Triggered when open Popup | - |
| opened | Triggered when opened Popup | - |
| close | Triggered when close Popup | - |

4
src/popup/README.zh-CN.md
View File

@ -144,13 +144,13 @@ export default {
| close-icon-position `v2.2.2` | 关闭图标位置，可选值为`top-left`<br>`bottom-left` `bottom-right` | *string* | `top-right` |
| transition | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | *string* | - |
| get-container | 指定挂载的节点 | *string \| () => Element* | - |
| safe-area-inset-bottom `v2.2.1` | 是否开启 [底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` |
| safe-area-inset-bottom `v2.2.1` | 是否开启[底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` |
### Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击弹出层时触发 | event: Event |
| click | 点击弹出层时触发 | *event: Event* |
| open | 打开弹出层时触发 | - |
| opened | 打开弹出层且动画结束后触发 | - |
| close | 关闭弹出层时触发 | - |

8
src/radio/README.md
View File

@ -148,7 +148,7 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Name of checked radio | *any* | - |
| v-model (v-model) | Name of checked radio | *any* | - |
| disabled | Disable all radios | *boolean* | `false` |
| icon-size `v2.2.3` | Icon size of all radios | *number \| string* | `20px` |
| checked-color `v2.2.3` | Checked color of all radios | *string* | `#1989fa` | - |
@ -157,17 +157,17 @@ export default {
| Event | Description | Parameters |
|------|------|------|
| click | Triggered when click radio | event: Event |
| click | Triggered when click radio | *event: Event* |
### RadioGroup Events
| Event | Description | Parameters |
|------|------|------|
| change | Triggered when value changed | current value |
| change | Triggered when value changed | *name: string* |
### Radio Slots
| Name | Description | SlotProps |
|------|------|------|
| default | Custom label | - |
| icon | Custom icon | checked: whether to be checked |
| icon | Custom icon | *checked: boolean* |

8
src/radio/README.zh-CN.md
View File

@ -158,7 +158,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| v-model | 当前选中项的标识符 | *any* | - |
| v-model (value) | 当前选中项的标识符 | *any* | - |
| disabled | 是否禁用所有单选框 | *boolean* | `false` |
| icon-size `v2.2.3` | 所有单选框的图标大小，默认单位为`px` | *number \| string* | `20px` |
| checked-color `v2.2.3` | 所有单选框的选中状态颜色 | *string* | `#1989fa` |
@ -167,17 +167,17 @@ export default {
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击单选框时触发 | event: Event |
| click | 点击单选框时触发 | *event: Event* |
### RadioGroup Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| change | 当绑定值变化时触发的事件 | 当前选中项的 name |
| change | 当绑定值变化时触发的事件 | *name: string* |
### Radio Slots
| 名称 | 说明 | SlotProps |
|------|------|------|
| default | 自定义文本 | - |
| icon | 自定义图标 | checked: 是否为选中状态 |
| icon | 自定义图标 | *checked: boolean* |

4
src/rate/README.zh-CN.md
View File

@ -117,8 +117,8 @@ export default {
| color | 选中时的颜色 | *string* | `#ffd21e` |
| void-color | 未选中时的颜色 | *string* | `#c8c9cc` |
| disabled-color | 禁用时的颜色 | *string* | `#bdbdbd` |
| icon | 选中时的 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | `star` |
| void-icon | 未选中时的 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | `star-o` |
| icon | 选中时的[图标名称](#/zh-CN/icon)或图片链接 | *string* | `star` |
| void-icon | 未选中时的[图标名称](#/zh-CN/icon)或图片链接 | *string* | `star-o` |
| allow-half | 是否允许半选 | *boolean* | `false` |
| readonly | 是否为只读状态 | *boolean* | `false` |
| disabled | 是否禁用评分 | *boolean* | `false` |

10
src/search/README.md
View File

@ -135,11 +135,11 @@ Use `action` slot to custom right button, `cancel` event will no longer be trigg
| Event | Description | Arguments |
|------|------|------|
| search | Triggered when confirm search | value: current value |
| input | Triggered when input value changed | value: current value |
| focus | Triggered when input gets focus | event: Event |
| blur | Triggered when input loses focus | event: Event |
| clear | Triggered when click clear icon | event: Event |
| search | Triggered when confirm search | *value: string* |
| input | Triggered when input value changed | *value: string* |
| focus | Triggered when input gets focus | *event: Event* |
| blur | Triggered when input loses focus | *event: Event* |
| clear | Triggered when click clear icon | *event: Event* |
| cancel | Triggered when click cancel button | - |
### Slots

14
src/search/README.zh-CN.md
View File

@ -128,18 +128,18 @@ export default {
| readonly | 是否将输入框设为只读 | *boolean* | `false` |
| error | 是否将输入内容标红 | *boolean* | `false` |
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` |
| left-icon | 输入框左侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | `search` |
| right-icon | 输入框右侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| left-icon | 输入框左侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | `search` |
| right-icon | 输入框右侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
### Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| search | 确定搜索时触发 | value: 输入框当前值 |
| input | 输入框内容变化时触发 | value: 输入框当前值 |
| focus | 输入框获得焦点时触发 | event: Event |
| blur | 输入框失去焦点时触发 | event: Event |
| clear | 点击清除按钮后触发 | event: Event |
| search | 确定搜索时触发 | *value: string (当前输入的值)* |
| input | 输入框内容变化时触发 | *value: string (当前输入的值)* |
| focus | 输入框获得焦点时触发 | *event: Event* |
| blur | 输入框失去焦点时触发 | *event: Event* |
| clear | 点击清除按钮后触发 | *event: Event* |
| cancel | 点击取消按钮时触发 | - |
### Slots

4
src/sku/README.zh-CN.md
View File

@ -144,7 +144,7 @@ export default {
| get-container | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | - |
| initial-sku | 默认选中的 sku，具体参考高级用法 | *object* | `{}` |
| show-soldout-sku | 是否展示售罄的 sku，默认展示并置灰 | *boolean* | `true` |
| safe-area-inset-bottom `v2.2.1` | 是否开启 [底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` |
| safe-area-inset-bottom `v2.2.1` | 是否开启[底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` |
| start-sale-num `v2.3.0` | 起售数量 | *number* | `1` |
| properties `v2.4.2` | 商品属性 | *array* | - |
@ -162,7 +162,7 @@ export default {
### 方法
通过 ref 可以获取到 Sku 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 Sku 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|

6
src/stepper/README.md
View File

@ -130,9 +130,9 @@ export default {
| Event | Description | Arguments |
|------|------|------|
| change | Triggered when value change | value: current value, detail: Detail info, contains name |
| change | Triggered when value change | *value: string, detail: { name: string }* |
| overlimit | Triggered when click disabled button | - |
| plus | Triggered when click plus button | - |
| minus | Triggered when click minus button | - |
| focus | Triggered when input focused | event: Event |
| blur | Triggered when input blured | event: Event |
| focus | Triggered when input focused | *event: Event* |
| blur | Triggered when input blured | *event: Event* |

8
src/stepper/README.zh-CN.md
View File

@ -131,7 +131,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| v-model | 当前输入值 | *number \| string* | - |
| v-model | 当前输入的值 | *number \| string* | - |
| min | 最小值 | *number \| string* | `1` |
| max | 最大值 | *number \| string* | - |
| default-value | 初始值，当 v-model 为空时生效 | *number \| string* | `1` |
@ -154,9 +154,9 @@ export default {
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| change | 当绑定值变化时触发的事件 | value: 当前组件的值, detail: 额外信息，包含 name 的字段 |
| change | 当绑定值变化时触发的事件 | *value: string, detail: { name: string }* |
| overlimit | 点击不可用的按钮时触发 | - |
| plus | 点击增加按钮时触发 | - |
| minus | 点击减少按钮时触发 | - |
| focus | 输入框聚焦时触发 | event: Event |
| blur | 输入框失焦时触发 | event: Event |
| focus | 输入框聚焦时触发 | *event: Event* |
| blur | 输入框失焦时触发 | *event: Event* |

4
src/submit-bar/README.zh-CN.md
View File

@ -79,12 +79,12 @@ Vue.use(SubmitBar);
| button-text | 按钮文字 | *string* | - |
| button-type | 按钮类型 | *string* | `danger` |
| tip | 提示文案 | *string* | - |
| tip-icon | 左侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| tip-icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
| currency | 货币符号 | *string* | `¥` |
| decimal-length | 价格小数点后位数 | *number \| string* | `2` |
| disabled | 是否禁用按钮 | *boolean* | `false` |
| loading | 是否显示加载中的按钮 | *boolean* | `false` |
| safe-area-inset-bottom | 是否开启 [底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` |
| safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` |
### Events

2
src/swipe-cell/README.zh-CN.md
View File

@ -145,7 +145,7 @@ beforeClose 的第一个参数为对象，对象中包含以下属性：
### 方法
通过 ref 可以获取到 SwipeCell 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 SwipeCell 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|

2
src/swipe/README.md
View File

@ -170,7 +170,7 @@ export default {
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when clicked | event: Event |
| click | Triggered when clicked | *event: Event* |
### Swipe Methods

4
src/swipe/README.zh-CN.md
View File

@ -176,11 +176,11 @@ export default {
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击时触发 | event: Event |
| click | 点击时触发 | *event: Event* |
### Swipe 方法
通过 ref 可以获取到 Swipe 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 Swipe 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|

6
src/switch/README.md
View File

@ -91,7 +91,7 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Check status of Switch | *any* | `false` |
| v-model | Check status of Switch | *ActiveValue \| InactiveValue* | `false` |
| loading | Whether to show loading icon | *boolean* | `false` |
| disabled | Whether to disable switch | *boolean* | `false` |
| size `v2.2.11` | Size of switch | *number \| string* | `30px` |
@ -104,5 +104,5 @@ export default {
| Event | Description | Parameters |
|------|------|------|
| change | Triggered when check status changed | checked: is switch checked |
| click `v2.2.11` | Triggered when clicked | event: Event |
| change | Triggered when check status changed | *value: any* |
| click `v2.2.11` | Triggered when clicked | *event: Event* |

8
src/switch/README.zh-CN.md
View File

@ -109,12 +109,12 @@ export default {
| size `v2.2.11` | 开关尺寸，默认单位为`px` | *number \| string* | `30px` |
| active-color | 打开时的背景色 | *string* | `#1989fa` |
| inactive-color | 关闭时的背景色 | *string* | `white` |
| active-value | 打开时的值 | *any* | `true` |
| inactive-value | 关闭时的值 | *any* | `false` |
| active-value | 打开时对应的值 | *any* | `true` |
| inactive-value | 关闭时对应的值 | *any* | `false` |
### Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| change | 开关状态切换回调 | checked: 是否选中开关 |
| click `v2.2.11` | 点击时触发 | event: Event |
| change | 开关状态切换时触发 | *value: any* |
| click `v2.2.11` | 点击时触发 | *event: Event* |

2
src/tab/README.zh-CN.md
View File

@ -242,7 +242,7 @@ export default {
### Tabs 方法
通过 ref 可以获取到 Tabs 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 Tabs 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|

4
src/tabbar/README.zh-CN.md
View File

@ -172,7 +172,7 @@ export default {
| active-color | 选中标签的颜色 | *string* | `#1989fa` |
| inactive-color | 未选中标签的颜色 | *string* | `#7d7e80` |
| route | 是否开启路由模式 | *boolean* | `false` |
| safe-area-inset-bottom | 是否开启 [底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` |
| safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` |
### Tabbar Events
@ -185,7 +185,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| name | 标签名称，作为匹配的标识符 | *number \| string* | 当前标签的索引值 |
| icon | [图标名称](#/zh-CN/icon) 或图片链接| *string* | - |
| icon | [图标名称](#/zh-CN/icon)或图片链接| *string* | - |
| dot | 是否显示图标右上角小红点 | *boolean* | `false` |
| info | 图标右上角徽标的内容 | *number \| string* | - |
| url | 点击后跳转的链接地址 | *string* | - |

16
src/tabs/index.js
View File

@ -6,10 +6,11 @@ import { isHidden } from '../utils/dom/style';
import { on, off } from '../utils/dom/event';
import { BORDER_TOP_BOTTOM } from '../utils/constant';
import {
setRootScrollTop,
getScroller,
getVisibleTop,
getElementTop,
getVisibleHeight,
getVisibleTop,
setRootScrollTop,
} from '../utils/dom/scroll';
// Mixins
@ -27,9 +28,14 @@ export default createComponent({
mixins: [
ParentMixin('vanTabs'),
BindEventMixin(function(bind) {
if (!this.scroller) {
this.scroller = getScroller(this.$el);
}
bind(window, 'resize', this.resize, true);
if (this.scrollspy) {
bind(window, 'scroll', this.onScroll, true);
bind(this.scroller, 'scroll', this.onScroll, true);
}
}),
],
@ -152,9 +158,9 @@ export default createComponent({
scrollspy(val) {
if (val) {
on(window, 'scroll', this.onScroll, true);
on(this.scroller, 'scroll', this.onScroll, true);
} else {
off(window, 'scroll', this.onScroll);
off(this.scroller, 'scroll', this.onScroll);
}
},
},

2
src/tag/README.md
View File

@ -135,5 +135,5 @@ export default {
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when clicked | event: Event |
| click | Triggered when clicked | *event: Event* |
| close | Triggered when click close icon | - |

2
src/tag/README.zh-CN.md
View File

@ -145,5 +145,5 @@ export default {
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击时触发 | event: Event |
| click | 点击时触发 | *event: Event* |
| close | 关闭标签时触发 | - |

2
src/toast/README.zh-CN.md
View File

@ -144,7 +144,7 @@ Toast.resetDefaultOptions('loading');
| type | 提示类型，可选值为 `loading` `success`<br>`fail` `html` | *string* | `text` |
| position | 位置，可选值为 `top` `bottom` | *string* | `middle` |
| message | 文本内容，支持通过`\n`换行 | *string* | `''` | - |
| icon `v2.0.1` | 自定义图标，支持传入 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| icon `v2.0.1` | 自定义图标，支持传入[图标名称](#/zh-CN/icon)或图片链接 | *string* | - |
| iconPrefix `v2.0.9` | 图标类名前缀 | *string* | `van-icon` |
| overlay `v2.2.13` | 是否显示背景遮罩层 | *boolean* | `false` |
| forbidClick | 是否禁止背景点击 | *boolean* | `false` |

2
src/uploader/README.zh-CN.md
View File

@ -229,7 +229,7 @@ before-read、after-read、before-delete 执行时会传递以下回调参数：
### 方法
通过 ref 可以获取到 Uploader 实例并调用实例方法，详见 [组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
通过 ref 可以获取到 Uploader 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|