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

docs: update numeric type

Browse Source
This commit is contained in:
陈嘉涵 2020-01-29 10:11:09 +08:00
parent 36ba412f70
commit c6f424baa7
85 changed files with 197 additions and 197 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -128,7 +128,7 @@ export default {
| cancel-text | Text of cancel button | *string* | - |
| description `v2.2.8` | Description above the options | *string* | - |
| close-icon `v2.2.13` | Close icon name | *string* | `cross` |
| duration `v2.0.3` | Transition duration, unit second | *string \| number* | `0.3` |
| duration `v2.0.3` | Transition duration, unit second | *number \| string* | `0.3` |
| round `v2.0.9` | Whether to show round corner | *boolean* | `true` |
| overlay | Whether to show overlay | *boolean* | `true` |
| lock-scroll | Whether to lock background scroll | *boolean* | `true` |

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

@ -142,7 +142,7 @@ export default {
| cancel-text | 取消按钮文字 | *string* | - |
| description `v2.2.8` | 选项上方的描述信息 | *string* | - |
| close-icon `v2.2.13` | 关闭 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | `cross` |
| duration `v2.0.3` | 动画时长，单位秒 | *string \| number* | `0.3` |
| duration `v2.0.3` | 动画时长，单位秒 | *number \| string* | `0.3` |
| round `v2.0.9` | 是否显示圆角 | *boolean* | `true` |
| overlay | 是否显示遮罩层 | *boolean* | `true` |
| lock-scroll | 是否锁定背景滚动 | *boolean* | `true` |

8
src/address-edit/README.md
View File

@ -75,13 +75,13 @@ export default {
| show-search-result | Whether to show address search result | *boolean* | `false` |
| save-button-text | Save button text | *string* | `Save` |
| delete-button-text | Delete button text | *string* | `Delete` |
| detail-rows | Detail input rows | *string \| number* | `1` |
| detail-maxlength `v2.0.4` | Detail maxlength | *string \| number* | `200` |
| detail-rows | Detail input rows | *number \| string* | `1` |
| detail-maxlength `v2.0.4` | Detail maxlength | *number \| string* | `200` |
| is-saving | Whether to show save button loading status | *boolean* | `false` |
| is-deleting | Whether to show delete button loading status | *boolean* | `false` |
| tel-validator | The method to validate tel | *(tel: string) => boolean* | - |
| postal-validator `v2.1.2` | The method to validate postal | *(tel: string) => boolean* | - |
| validator | Custom validator | *(key, value) => string* | - |
| validator | Custom validator | *(key, val) => string* | - |
### Events
@ -114,7 +114,7 @@ Use [ref](https://vuejs.org/v2/api/#ref) to get AddressEdit instance and call in
| key | Description | Type |
|------|------|------|
| id | Address Id | *string \| number* |
| id | Address Id | *number \| string* |
| name | Name | *string* |
| tel | Phone | *string* |
| province | Province | *string* |

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

@ -75,13 +75,13 @@ export default {
| show-search-result | 是否显示搜索结果 | *boolean* | `false` |
| save-button-text | 保存按钮文字 | *string* | `保存` |
| delete-button-text | 删除按钮文字 | *string* | `删除` |
| detail-rows | 详细地址输入框行数 | *string \| number* | `1` |
| detail-maxlength `v2.0.4` | 详细地址最大长度 | *string \| number* | `200` |
| detail-rows | 详细地址输入框行数 | *number \| string* | `1` |
| detail-maxlength `v2.0.4` | 详细地址最大长度 | *number \| string* | `200` |
| is-saving | 是否显示保存按钮加载动画 | *boolean* | `false` |
| is-deleting | 是否显示删除按钮加载动画 | *boolean* | `false` |
| tel-validator | 手机号格式校验函数 | *string => boolean* | - |
| postal-validator `v2.1.2` | 邮政编码格式校验函数 | *string => boolean* | - |
| validator | 自定义校验函数 | *(key, value) => string* | - |
| validator | 自定义校验函数 | *(key, val) => string* | - |
### Events
@ -116,7 +116,7 @@ export default {
| key | 说明 | 类型 |
|------|------|------|
| id | 每条地址的唯一标识 | *string \| number* |
| id | 每条地址的唯一标识 | *number \| string* |
| name | 收货人姓名 | *string* |
| tel | 收货人手机号 | *string* |
| province | 省份 | *string* |

4
src/address-list/README.md
View File

@ -96,9 +96,9 @@ export default {
| Key | Description | Type |
|------|------|------|
| id | Id | *string \| number* |
| id | Id | *number \| string* |
| name | Name | *string* |
| tel | Phone | *string \| number* |
| tel | Phone | *number \| string* |
| address | Address | *string* |
| isDefault | Is default address | *boolean* |

4
src/address-list/README.zh-CN.md
View File

@ -96,9 +96,9 @@ export default {
| 键名 | 说明 | 类型 |
|------|------|------|
| id | 每条地址的唯一标识 | *string \| number* |
| id | 每条地址的唯一标识 | *number \| string* |
| name | 收货人姓名 | *string* |
| tel | 收货人手机号 | *string \| number* |
| tel | 收货人手机号 | *number \| string* |
| address | 收货地址 | *string* |
| isDefault | 是否为默认地址 | *boolean* |

2
src/area/README.md
View File

@ -61,7 +61,7 @@ Set `columns-num` with 2, you'll have a 2 level picker.
| value | the `code` of selected area | *string* | - |
| title | Toolbar title | *string* | - |
| area-list | Area data | *object* | - |
| columns-num | level of picker | *string \| number* | `3` |
| columns-num | level of picker | *number \| string* | `3` |
| columns-placeholder `v2.2.5` | placeholder of columns | *string[]* | `[]` |
| item-height | Option height | *number* | `44` |
| loading | Whether to show loading prompt | *boolean* | `false` |

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

@ -60,7 +60,7 @@ Vue.use(Area);
| value | 当前选中的省市区`code` | *string* | - |
| title | 顶部栏标题 | *string* | - |
| area-list | 省市区数据，格式见下方 | *object* | - |
| columns-num | 显示列数，3-省市区，2-省市，1-省 | *string \| number* | `3` |
| columns-num | 显示列数，3-省市区，2-省市，1-省 | *number \| string* | `3` |
| columns-placeholder `v2.2.5` | 列占位提示文字 | *string[]* | `[]` |
| loading | 是否显示加载状态 | *boolean* | `false` |
| item-height | 选项高度 | *number* | `44` |

4
src/calendar/README.md
View File

@ -218,7 +218,7 @@ Set `poppable` to `false`, the calendar will be displayed directly on the page i
| min-date | Min date | *Date* | Today |
| max-date | Max date | *Date* | Six months after the today |
| default-date | Default selected date | *Date \| Date[]* | Today |
| row-height | Row height | *string \| number* | `64` |
| row-height | Row height | *number \| string* | `64` |
| formatter | Day formatter | *(day: Day) => Day* | - |
| position | Popup position, can be set to `top` `right` `left` | *string* | `bottom` |
| poppable | Whether to show the calendar inside a popup | *boolean* | `true` |
@ -230,7 +230,7 @@ Set `poppable` to `false`, the calendar will be displayed directly on the page i
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `true` |
| confirm-text | Confirm button text | *string* | `Confirm` |
| confirm-disabled-text | Confirm button text when disabled | *string* | `Confirm` |
| max-range `v2.4.3` | Number of selectable days | *string \| number* | - |
| max-range `v2.4.3` | Number of selectable days | *number \| string* | - |
| range-prompt `v2.4.3` | Error message when exceeded max range | *string* | `Choose no more than xx days` |
| get-container `v2.4.4` | Return the mount node for Calendar | _string \| () => Element_ | - |

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

@ -218,7 +218,7 @@ export default {
| min-date | 最小日期 | *Date* | 当前日期 |
| max-date | 最大日期 | *Date* | 当前日期的六个月后 |
| default-date | 默认选中的日期 | *Date \| Date[]* | 今天 |
| row-height | 日期行高 | *string \| number* | `64` |
| row-height | 日期行高 | *number \| string* | `64` |
| formatter | 日期格式化函数 | *(day: Day) => Day* | - |
| position | 弹出位置，可选值为 `top` `right` `left` | *string* | `bottom` |
| poppable | 是否以弹层的形式展示日历 | *boolean* | `true` |
@ -230,7 +230,7 @@ export default {
| 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` | 日期区间最多可选天数，默认无限制 | *string \| number* | - |
| max-range `v2.4.3` | 日期区间最多可选天数，默认无限制 | *number \| string* | - |
| range-prompt `v2.4.3` | 选择超过区间范围时的提示文案 | *string* | `选择天数不能超过 xx 天` |
| get-container `v2.4.4` | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | - |

6
src/card/README.md
View File

@ -70,9 +70,9 @@ Use slot to custom content.
| title | Title | *string* | - |
| desc | Description | *string* | - |
| tag | Tag | *string* | - |
| num | number | *string \| number* | - |
| price | Price | *string \| number* | - |
| origin-price | Origin price | *string \| number* | - |
| num | number | *number \| string* | - |
| price | Price | *number \| string* | - |
| origin-price | Origin price | *number \| string* | - |
| centered | Whether content vertical centered | *boolean* | `false` |
| currency | Currency symbol | *string* | `¥` |
| thumb-link | Thumb link URL | *string* | - |

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

@ -72,9 +72,9 @@ Vue.use(Card);
| title | 标题 | *string* | - |
| desc | 描述 | *string* | - |
| tag | 图片角标 | *string* | - |
| num | 商品数量 | *string \| number* | - |
| price | 商品价格 | *string \| number* | - |
| origin-price | 商品划线原价 | *string \| number* | - |
| num | 商品数量 | *number \| string* | - |
| price | 商品价格 | *number \| string* | - |
| origin-price | 商品划线原价 | *number \| string* | - |
| centered | 内容是否垂直居中 | *boolean* | `false` |
| currency | 货币符号 | *string* | `¥` |
| thumb-link | 点击左侧图片后跳转的链接地址 | *string* | - |

4
src/cell/README.md
View File

@ -115,8 +115,8 @@ Vue.use(CellGroup);
| Attribute | Description | Type | Default |
|------|------|------|------|
| icon | Left Icon | *string* | - |
| title | Title | *string \| number* | - |
| value | Right text | *string \| number* | - |
| title | Title | *number \| string* | - |
| value | Right text | *number \| string* | - |
| label | Description below the title | *string* | - |
| size | Size，can be set to `large` | *string* | - |
| border | Whether to show inner border | *boolean* | `true` |

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

@ -126,8 +126,8 @@ Vue.use(CellGroup);
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| icon | 左侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| title | 左侧标题 | *string \| number* | - |
| value | 右侧内容 | *string \| number* | - |
| title | 左侧标题 | *number \| string* | - |
| value | 右侧内容 | *number \| string* | - |
| label | 标题下方的描述信息 | *string* | - |
| size | 单元格大小，可选值为 `large` | *string* | - |
| url | 点击后跳转的链接地址 | *string* | - |

6
src/checkbox/README.md
View File

@ -193,7 +193,7 @@ export default {
| disabled | Disable checkbox | *boolean* | `false` |
| label-disabled | Whether to disable label click | *boolean* | `false` |
| label-position | Can be set to `left` | *string* | `right` |
| icon-size | Icon size | *string \| number* | `20px` |
| icon-size | Icon size | *number \| string* | `20px` |
| checked-color | Checked color | *string* | `#1989fa` | - |
| bind-group `v2.2.4` | Whether to bind with CheckboxGroup | *boolean* | `true` |
@ -202,9 +202,9 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Names of all checked checkboxes | *any[]* | - |
| max | Maximum amount of checked options | *string \| number* | `0`(Unlimited) |
| 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 | *string \| number* | `20px` |
| icon-size `v2.2.3` | Icon size of all checkboxes | *number \| string* | `20px` |
| checked-color `v2.2.3` | Checked color of all checkboxes | *string* | `#1989fa` | - |
### Checkbox Events

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

@ -209,7 +209,7 @@ export default {
| disabled | 是否禁用复选框 | *boolean* | `false` |
| label-disabled | 是否禁用复选框文本点击 | *boolean* | `false` |
| label-position | 文本位置，可选值为 `left` | *string* | `right` |
| icon-size | 图标大小，默认单位为`px` | *string \| number* | `20px` |
| icon-size | 图标大小，默认单位为`px` | *number \| string* | `20px` |
| checked-color | 选中状态颜色 | *string* | `#1989fa` |
| bind-group `v2.2.4` | 是否与复选框组绑定 | *boolean* | `true` |
@ -219,8 +219,8 @@ export default {
|------|------|------|------|
| v-model | 所有选中项的标识符 | *any[]* | - |
| disabled | 是否禁用所有复选框 | *boolean* | `false` |
| max | 最大可选数，0 为无限制 | *string \| number* | `0` |
| icon-size `v2.2.3` | 所有复选框的图标大小，默认单位为`px` | *string \| number* | `20px` |
| max | 最大可选数，0 为无限制 | *number \| string* | `0` |
| icon-size `v2.2.3` | 所有复选框的图标大小，默认单位为`px` | *number \| string* | `20px` |
| checked-color `v2.2.3` | 所有复选框的选中状态颜色 | *string* | `#1989fa` |
### Checkbox Events

8
src/circle/README.md
View File

@ -113,14 +113,14 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current rate | *number* | - |
| rate | Target rate | *string \| number* | `100` |
| size | Circle size | *string \| number* | `100px` |
| rate | Target rate | *number \| string* | `100` |
| size | Circle size | *number \| string* | `100px` |
| color `v2.1.4` | Progress color, passing object to render gradient | *string \| object* | `#1989fa` |
| layer-color | Layer color | *string* | `#fff` |
| fill | Fill color | *string* | `none` |
| speed | Animate speed（rate/s）| *string \| number* | `0` |
| speed | Animate speed（rate/s）| *number \| string* | `0` |
| text | Text | *string* | - |
| stroke-width | Stroke width | *string \| number* | `40` |
| stroke-width | Stroke width | *number \| string* | `40` |
| stroke-linecap `v2.2.15` | Stroke linecap，can be set to `sqaure` `butt` | *string* | `round` |
| clockwise | Whether to be clockwise | *boolean* | `true` |

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

@ -125,14 +125,14 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| v-model | 当前进度 | *number* | - |
| rate | 目标进度 | *string \| number* | `100` |
| size | 圆环直径，默认单位为 `px` | *string \| number* | `100px` |
| rate | 目标进度 | *number \| string* | `100` |
| size | 圆环直径，默认单位为 `px` | *number \| string* | `100px` |
| color `v2.1.4` | 进度条颜色，传入对象格式可以定义渐变色 | *string \| object* | `#1989fa` |
| layer-color | 轨道颜色 | *string* | `#fff` |
| fill | 填充颜色 | *string* | `none` |
| speed | 动画速度（单位为 rate/s）| *string \| number* | `0` |
| speed | 动画速度（单位为 rate/s）| *number \| string* | `0` |
| text | 文字 | *string* | - |
| stroke-width | 进度条宽度 | *string \| number* | `40` |
| stroke-width | 进度条宽度 | *number \| string* | `40` |
| stroke-linecap `v2.2.15` | 进度条端点的形状，可选值为`sqaure` `butt` | *string* | `round` |
| clockwise | 是否顺时针增加 | *boolean* | `true` |

6
src/col/README.md
View File

@ -95,7 +95,7 @@ Setting `type` to `flex` to enable flex layout
| Attribute | Description | Type | Default |
|------|------|------|------|
| type | Layout type, can be set to `flex` | *string* | - |
| gutter | Grid spacing（px） | *string \| number* | - |
| gutter | Grid spacing（px） | *number \| string* | - |
| tag | Custom element tag | *string* | `div` |
| justify | Flex main axis，can be set to end/center/space-around/space-between | *string* | `start` |
| align | Flex cross axis, be set to center/bottom | *string* | `top` |
@ -104,8 +104,8 @@ Setting `type` to `flex` to enable flex layout
| Attribute | Description | Type | Default |
|------|------|------|------|
| span | number of column the grid spans | *string \| number* | - |
| offset | number of spacing on the left side of the grid | *string \| number* | - |
| span | number of column the grid spans | *number \| string* | - |
| offset | number of spacing on the left side of the grid | *number \| string* | - |
| tag | Custom element tag | *string* | `div` |
### Row Events

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

@ -98,7 +98,7 @@ Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| type | 布局方式，可选值为`flex` | *string* | - |
| gutter | 列元素之间的间距（单位为px） | *string \| number* | - |
| gutter | 列元素之间的间距（单位为px） | *number \| string* | - |
| tag | 自定义元素标签 | *string* | `div` |
| justify | Flex 主轴对齐方式，可选值为 `end` `center` <br> `space-around` `space-between` | *string* | `start` |
| align | Flex 交叉轴对齐方式，可选值为 `center` `bottom` | *string* | `top` |
@ -107,8 +107,8 @@ Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| span | 列元素宽度 | *string \| number* | - |
| offset | 列元素偏移距离 | *string \| number* | - |
| span | 列元素宽度 | *number \| string* | - |
| offset | 列元素偏移距离 | *number \| string* | - |
| tag | 自定义元素标签 | *string* | `div` |
### Row Events

8
src/collapse/README.md
View File

@ -86,7 +86,7 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Names of current active panels | accordion mode： *string \| number*<br>non-accordion mode：*(string \| number)[]* | - |
| v-model | Names of current active panels | accordion mode： *number \| string*<br>non-accordion mode：*(number \| string)[]* | - |
| accordion | Whether to be accordion mode | *boolean* | `false` |
| border | Whether to show outer border | *boolean* | `true` |
@ -100,11 +100,11 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| name | Name | *string \| number* | `index` |
| name | Name | *number \| string* | `index` |
| icon | Left Icon | *string* | - |
| size | Title size，can be set to `large` | *string* | - |
| title | Title | *string \| number* | - |
| value | Right text | *string \| number* | - |
| title | Title | *number \| string* | - |
| value | Right text | *number \| string* | - |
| label | Description below the title | *string* | - |
| border | Whether to show inner border | *boolean* | `true` |
| disabled | Whether to disabled collapse | *boolean* | `false` |

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

@ -86,7 +86,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| v-model | 当前展开面板的 name | 手风琴模式：*string \| number*<br>非手风琴模式：*(string \| number)[]* | - |
| v-model | 当前展开面板的 name | 手风琴模式：*number \| string*<br>非手风琴模式：*(number \| string)[]* | - |
| accordion | 是否开启手风琴模式 | *boolean* | `false` |
| border | 是否显示外边框 | *boolean* | `true` |
@ -100,12 +100,12 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| name | 唯一标识符，默认为索引值 | *string \| number* | `index` |
| name | 唯一标识符，默认为索引值 | *number \| string* | `index` |
| icon | 标题栏左侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| size | 标题栏大小，可选值为 `large` | *string* | - |
| title | 标题栏左侧内容 | *string \| number* | - |
| value | 标题栏右侧内容 | *string \| number* | - |
| label | 标题栏描述信息 | *string \| number* | - |
| title | 标题栏左侧内容 | *number \| string* | - |
| value | 标题栏右侧内容 | *number \| string* | - |
| label | 标题栏描述信息 | *number \| string* | - |
| border | 是否显示内边框 | *boolean* | `true` |
| is-link | 是否展示标题栏右侧箭头并开启点击反馈 | *boolean* | `true` |
| disabled | 是否禁用面板 | *boolean* | `false` |

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

@ -151,7 +151,7 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Id of chosen contact | *string \| number* | - |
| v-model | Id of chosen contact | *number \| string* | - |
| list | Contact list | *Contact[]* | `[]` |
| add-text | Add button text | *string* | `Add new contact` |
| default-tag-text `v2.3.0` | Default tag text | *string* | - |
@ -188,7 +188,7 @@ export default {
| key | Description | Type |
|------|------|------|
| id | ID | *string \| number* |
| id | ID | *number \| string* |
| name | Name | *string* |
| tel | Phone | *string* |
| isDefault | Is default contact | *boolean* |

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

@ -155,7 +155,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| v-model | 当前选中联系人的 id | *string \| number* | - |
| v-model | 当前选中联系人的 id | *number \| string* | - |
| list | 联系人列表 | *Contact[]* | `[]` |
| add-text | 新建按钮文案 | *string* | `新建联系人` |
| default-tag-text `v2.3.0` | 默认联系人标签文案 | *string* | - |
@ -191,7 +191,7 @@ export default {
| 键名 | 说明 | 类型 |
|------|------|------|
| id | 每位联系人的唯一标识 | *string \| number* |
| id | 每位联系人的唯一标识 | *number \| string* |
| name | 联系人姓名 | *string* |
| tel | 联系人手机号 | *string \| number* |
| tel | 联系人手机号 | *number \| string* |
| isDefault | 是否为默认联系人 | *boolean* |

4
src/dialog/README.md
View File

@ -115,7 +115,7 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| title | Title | *string* | - |
| width `v2.2.7` | Width | *string \| number* | `320px` |
| width `v2.2.7` | Width | *number \| string* | `320px` |
| message | Message | *string* | - |
| messageAlign | Message text align，can be set to `left` `right` | *string* | `center` |
| className | Custom className | *any* | - |
@ -141,7 +141,7 @@ export default {
|------|------|------|------|
| v-model | Whether to show dialog | *boolean* | - |
| title | Title | *string* | - |
| width `v2.2.7` | Width | *string \| number* | `320px` |
| width `v2.2.7` | Width | *number \| string* | `320px` |
| message | Message | *string* | - |
| message-align | Message align，can be set to `left` `right` | *string* | `center` |
| show-confirm-button | Whether to show confirm button | *boolean* | `true` |

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

@ -144,7 +144,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| title | 标题 | *string* | - |
| width `v2.2.7` | 弹窗宽度，默认单位为`px` | *string \| number* | `320px` |
| width `v2.2.7` | 弹窗宽度，默认单位为`px` | *number \| string* | `320px` |
| message | 文本内容，支持通过`\n`换行 | *string* | - |
| messageAlign | 内容对齐方式，可选值为`left` `right` | *string* | `center` |
| className | 自定义类名 | *any* | - |
@ -172,7 +172,7 @@ export default {
|------|------|------|------|
| v-model | 是否显示弹窗 | *boolean* | - |
| title | 标题 | *string* | - |
| width `v2.2.7` | 弹窗宽度，默认单位为`px` | *string \| number* | `320px` |
| width `v2.2.7` | 弹窗宽度，默认单位为`px` | *number \| string* | `320px` |
| message | 文本内容，支持通过`\n`换行 | *string* | - |
| message-align | 内容对齐方式，可选值为`left` `right` | *string* | `center` |
| show-confirm-button | 是否展示确认按钮 | *boolean* | `true` |

6
src/dropdown-menu/README.md
View File

@ -113,7 +113,7 @@ Use `active-color` prop to custom active color of the title and options
| Attribute | Description | Type | Default |
|------|------|------|------|
| active-color | Active color of title and option | *string* | `#1989fa` |
| z-index | z-index of menu item | *string \| number* | `10` |
| z-index | z-index of menu item | *number \| string* | `10` |
| duration | Transition duration, unit second | *number* | `0.2` |
| direction `v2.0.1` | Expand direction, can be set to `up` | *string* | `down` |
| overlay | Whether to show overlay | *boolean* | `true` |
@ -124,7 +124,7 @@ Use `active-color` prop to custom active color of the title and options
| Attribute | Description | Type | Default |
|------|------|------|------|
| value | Value of current option，can use `v-model` | *string \| number* | - |
| value | Value of current option，can use `v-model` | *number \| string* | - |
| title | Item title | *string* | Text of selected option |
| options | Options | *Option[]* | `[]` |
| disabled | Whether to disable dropdown item | *boolean* | `false` |
@ -161,5 +161,5 @@ Use [ref](https://vuejs.org/v2/api/#ref) to get DropdownItem instance and call i
| Key | Description | Type |
|------|------|------|
| text | Text | *string* |
| value | Value | *string \| number* |
| value | Value | *number \| string* |
| icon | Left icon | *string* |

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

@ -117,7 +117,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| active-color | 菜单标题和选项的选中态颜色 | *string* | `#1989fa` |
| z-index | 菜单栏 z-index 层级 | *string \| number* | `10` |
| z-index | 菜单栏 z-index 层级 | *number \| string* | `10` |
| duration | 动画时长，单位秒 | *number* | `0.2` |
| direction `v2.0.1` | 菜单展开方向，可选值为`up` | *string* | `down` |
| overlay | 是否显示遮罩层 | *boolean* | `true` |
@ -128,7 +128,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| value | 当前选中项对应的 value，可以通过`v-model`双向绑定 | *string \| number* | - |
| value | 当前选中项对应的 value，可以通过`v-model`双向绑定 | *number \| string* | - |
| title | 菜单项标题 | *string* | 当前选中项文字 |
| options | 选项数组 | *Option[]* | `[]` |
| disabled | 是否禁用菜单 | *boolean* | `false` |
@ -165,5 +165,5 @@ export default {
| 键名 | 说明 | 类型 |
|------|------|------|
| text | 文字 | *string* |
| value | 标识符 | *string \| number* |
| value | 标识符 | *number \| string* |
| icon | 左侧 [图标名称](#/zh-CN/icon) 或图片链接 | *string* |

6
src/field/README.md
View File

@ -214,11 +214,11 @@ Use `input-align` prop to align the input value
| Attribute | Description | Type | Default |
|------|------|------|------|
| value | Field value | *string \| number* | - |
| value | Field value | *number \| string* | - |
| label | Field label | *string* | - |
| type | Input type, can be set to `tel` `digit`<br>`number` `textarea` `password` | *string* | `text` |
| size | Size，can be set to `large` | *string* | - |
| maxlength | Max length of value | *string \| number* | - |
| maxlength | Max length of value | *number \| string* | - |
| placeholder | Placeholder | *string* | - |
| border | Whether to show inner border | *boolean* | `true` |
| disabled | Whether to disable field | *boolean* | `false` |
@ -234,7 +234,7 @@ Use `input-align` prop to align the input value
| arrow-direction `v2.0.4` | Can be set to `left` `up` `down` | *string* | `right` |
| error-message | Error message | *string* | `''` |
| label-class | Label className | *any* | - |
| label-width | Label width | *string \| number* | `90px` |
| label-width | Label width | *number \| string* | `90px` |
| label-align | Label text align, can be set to `center` `right` | *string* | `left` |
| input-align | Input text align, can be set to `center` `right` | *string* | `left` |
| error-message-align | Error message text align, can be set to `center` `right` | *string* | `left` |

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

@ -234,10 +234,10 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| label | 输入框左侧文本 | *string* | - |
| value | 当前输入的值 | *string \| number* | - |
| value | 当前输入的值 | *number \| string* | - |
| type | 输入框类型, 可选值为 `tel` `digit`<br>`number` `textarea` `password` 等 | *string* | `text` |
| size | 大小，可选值为 `large` | *string* | - |
| maxlength | 输入的最大字符数 | *string \| number* | - |
| maxlength | 输入的最大字符数 | *number \| string* | - |
| placeholder | 占位提示文字 | *string* | - |
| border | 是否显示内边框 | *boolean* | `true` |
| disabled | 是否禁用输入框 | *boolean* | `false` |
@ -253,7 +253,7 @@ export default {
| arrow-direction `v2.0.4` | 箭头方向，可选值为 `left` `up` `down` | *string* | `right` |
| error-message | 底部错误提示文案，为空时不展示 | *string* | `''` |
| label-class | 左侧文本额外类名 | *any* | - |
| label-width | 左侧文本宽度，默认单位为`px` | *string \| number* | `90px` |
| label-width | 左侧文本宽度，默认单位为`px` | *number \| string* | `90px` |
| label-align | 左侧文本对齐方式，可选值为 `center` `right` | *string* | `left` |
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` |
| error-message-align | 错误提示文案对齐方式，可选值为 `center` `right` | *string* | `left` |

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

@ -92,7 +92,7 @@ Use `info` prop to show badge in icon
| icon | Icon | *string* | - |
| color `v2.4.2` | Icon color | *string* | `#323233` |
| icon-class | Icon class name | *any* | `''` |
| info | Content of the badge | *string \| number* | - |
| info | Content of the badge | *number \| string* | - |
| url | Link | *string* | - |
| to | Target route of the link, same as to of vue-router | *string \| object* | - |
| replace | If true, the navigation will not leave a history record | *boolean* | `false` |

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

@ -96,7 +96,7 @@ export default {
| icon | 图标 | *string* | - |
| color `v2.4.2` | 图标颜色 | *string* | `#323233` |
| icon-class | 图标额外类名 | *any* | - |
| info | 图标右上角徽标的内容 | *string \| number* | - |
| info | 图标右上角徽标的内容 | *number \| string* | - |
| url | 点击后跳转的链接地址 | *string* | - |
| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - |
| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` |

6
src/grid/README.md
View File

@ -103,12 +103,12 @@ Vue.use(GridItem);
| Attribute | Description | Type | Default |
|------|------|------|------|
| column-num `v2.0.4` | Column Num | *number* | `4` |
| gutter | Gutter | *string \| number* | `0` |
| gutter | Gutter | *number \| string* | `0` |
| border | Whether to show border | *boolean* | `true` |
| center | Whether to center content | *boolean* | `true` |
| square | Whether to be square shape | *boolean* | `false` |
| clickable | Whether to show click feedback when clicked | *boolean* | `false` |
| icon-size `v2.2.6` | Icon size | *string \| number* | `28px` |
| icon-size `v2.2.6` | Icon size | *number \| string* | `28px` |
### GridItem Props
@ -117,7 +117,7 @@ Vue.use(GridItem);
| text | Text | *string* | - |
| icon | Icon name or URL | *string* | - |
| dot `v2.2.1` | Whether to show red dot | *boolean* | `false` |
| info `v2.2.1` | Content of the badge | *string \| number* | - |
| info `v2.2.1` | Content of the badge | *number \| string* | - |
| url | Link URL | *string* | - |
| to | Target route of the link, same as to of vue-router | *string \| object* | - |
| replace | If true, the navigation will not leave a history record | *boolean* | `false` |

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

@ -121,12 +121,12 @@ Vue.use(GridItem);
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| column-num `v2.0.4` | 列数 | *number* | `4` |
| gutter | 格子之间的间距，默认单位为`px` | *string \| number* | `0` |
| gutter | 格子之间的间距，默认单位为`px` | *number \| string* | `0` |
| border | 是否显示边框 | *boolean* | `true` |
| center | 是否将格子内容居中显示 | *boolean* | `true` |
| square | 是否将格子固定为正方形 | *boolean* | `false` |
| clickable | 是否开启格子点击反馈 | *boolean* | `false` |
| icon-size `v2.2.6` | 图标大小，默认单位为`px` | *string \| number* | `28px` |
| icon-size `v2.2.6` | 图标大小，默认单位为`px` | *number \| string* | `28px` |
### GridItem Props
@ -135,7 +135,7 @@ Vue.use(GridItem);
| text | 文字 | *string* | - |
| icon | [图标名称](#/zh-CN/icon) 或图片链接 | *string* | - |
| dot `v2.2.1` | 是否显示图标右上角小红点 | *boolean* | `false` |
| info `v2.2.1` | 图标右上角徽标的内容 | *string \| number* | - |
| info `v2.2.1` | 图标右上角徽标的内容 | *number \| string* | - |
| url | 点击后跳转的链接地址 | *string* | - |
| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - |
| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` |

4
src/icon/README.md
View File

@ -87,9 +87,9 @@ import 'vant/lib/icon/local.css';
|------|------|------|------|
| name | Icon name or URL | *string* | `''` |
| dot `v2.2.1` | Whether to show red dot | *boolean* | `false` |
| info | Content of the badge | *string \| number* | `''` |
| info | Content of the badge | *number \| string* | `''` |
| color | Icon color | *string* | `inherit` |
| size | Icon size | *string \| number* | `inherit` |
| size | Icon size | *number \| string* | `inherit` |
| class-prefix | ClassName prefix | *string* | `van-icon` |
| tag | HTML Tag | *string* | `i` |

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

@ -93,9 +93,9 @@ import 'vant/lib/icon/local.css';
|------|------|------|------|
| name | 图标名称或图片链接 | *string* | - |
| dot `v2.2.1` | 是否显示图标右上角小红点 | *boolean* | `false` |
| info | 图标右上角徽标的内容 | *string \| number* | - |
| info | 图标右上角徽标的内容 | *number \| string* | - |
| color | 图标颜色 | *string* | `inherit` |
| size | 图标大小，如 `20px` `2em`，默认单位为`px` | *string \| number* | `inherit` |
| size | 图标大小，如 `20px` `2em`，默认单位为`px` | *number \| string* | `inherit` |
| class-prefix | 类名前缀 | *string* | `van-icon` |
| tag | HTML 标签 | *string* | `i` |

6
src/image/README.md
View File

@ -72,9 +72,9 @@ Vue.use(Lazyload);
| src | Src | *string* | - |
| fit | Fit mode | *string* | `fill` |
| alt | Alt | *string* | - |
| width | Width | *string \| number* | - |
| height | Height | *string \| number* | - |
| radius `v2.1.6` | Border Radius | *string \| number* | `0` |
| width | Width | *number \| string* | - |
| height | Height | *number \| string* | - |
| radius `v2.1.6` | Border Radius | *number \| string* | `0` |
| round | Whether to be round | *boolean* | `false` |
| lazy-load | Whether to enable lazy load，should register [Lazyload](#/en-US/lazyload) component | *boolean* | `false` |
| show-error `v2.0.9` | Whether to show error placeholder | *boolean* | `true` |

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

@ -104,9 +104,9 @@ Vue.use(Lazyload);
| src | 图片链接 | *string* | - |
| fit | 图片填充模式 | *string* | `fill` |
| alt | 替代文本 | *string* | - |
| width | 宽度，默认单位为`px` | *string \| number* | - |
| height | 高度，默认单位为`px` | *string \| number* | - |
| radius `v2.1.6` | 圆角大小，默认单位为`px` | *string \| number* | `0` |
| width | 宽度，默认单位为`px` | *number \| string* | - |
| height | 高度，默认单位为`px` | *number \| string* | - |
| radius `v2.1.6` | 圆角大小，默认单位为`px` | *number \| string* | `0` |
| round | 是否显示为圆形 | *boolean* | `false` |
| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | *boolean* | `false` |
| show-error `v2.0.9` | 是否展示图片加载失败提示 | *boolean* | `true` |

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

@ -65,7 +65,7 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| index-list | Index List | *string[] \| number[]* | `A-Z` |
| z-index | z-index | *string \| number* | `1` |
| z-index | z-index | *number \| string* | `1` |
| sticky | Whether to enable anchor sticky top | *boolean* | `true` |
| sticky-offset-top `v2.0.7` | Anchor offset top when sticky | *number* | `0` |
| highlight-color | Index character highlight color | *string* | `#07c160` | - |
@ -74,7 +74,7 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| index | Index | *string \| number* | - |
| index | Index | *number \| string* | - |
### IndexBar Events

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

@ -69,7 +69,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| index-list | 索引字符列表 | *string[] \| number[]* | `A-Z` |
| z-index | z-index 层级 | *string \| number* | `1` |
| z-index | z-index 层级 | *number \| string* | `1` |
| sticky | 是否开启锚点自动吸顶 | *boolean* | `true` |
| sticky-offset-top `v2.0.7` | 锚点自动吸顶时与顶部的距离 | *number* | `0` |
| highlight-color | 索引字符高亮颜色 | *string* | `#07c160` |
@ -78,7 +78,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| index | 索引字符 | *string \| number* | - |
| index | 索引字符 | *number \| string* | - |
### IndexBar Events

4
src/loading/README.md
View File

@ -52,8 +52,8 @@ Vue.use(Loading);
|------|------|------|------|
| color | Loading color | *string* | `#c9c9c9` |
| type | Can be set to `spinner` | *string* | `circular` |
| size | Icon size | *string \| number* | `30px` |
| text-size | Text font size | *string \| number* | `14px` |
| size | Icon size | *number \| string* | `30px` |
| text-size | Text font size | *number \| string* | `14px` |
| vertical | Whether to arrange icons and text content vertically | *boolean* | `false` |
### Slots

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

@ -62,8 +62,8 @@ Vue.use(Loading);
|------|------|------|------|
| color | 颜色 | *string* | `#c9c9c9` |
| type | 类型，可选值为 `spinner` | *string* | `circular` |
| size | 加载图标大小，默认单位为`px` | *string \| number* | `30px` |
| text-size | 文字大小，默认单位为`px` | *string \| number* | `14px` |
| size | 加载图标大小，默认单位为`px` | *number \| string* | `30px` |
| text-size | 文字大小，默认单位为`px` | *number \| string* | `14px` |
| vertical | 是否垂直排列图标和文字内容 | *boolean* | `false` |
### Slots

2
src/nav-bar/README.md
View File

@ -59,7 +59,7 @@ export default {
| left-arrow | Whether to show left arrow | *boolean* | `false` |
| fixed | Whether to fixed top | *boolean* | `false` |
| border | Whether to show bottom border | *boolean* | `true` |
| z-index | Z-index | *string \| number* | `1` |
| z-index | Z-index | *number \| string* | `1` |
### Slots

2
src/nav-bar/README.zh-CN.md
View File

@ -61,7 +61,7 @@ export default {
| left-arrow | 是否显示左侧箭头 | *boolean* | `false` |
| fixed | 是否固定在顶部 | *boolean* | `false` |
| border | 是否显示下边框 | *boolean* | `true` |
| z-index | 元素 z-index | *string \| number* | `1` |
| z-index | 元素 z-index | *number \| string* | `1` |
### Slots

4
src/number-keyboard/README.md
View File

@ -139,9 +139,9 @@ Use `title` prop to set keyboard title
| show | Whether to show keyboard | *boolean* | - |
| theme | Keyboard theme，can be set to `default` `custom` | *string* | `default` |
| title | Keyboard title | *string* | - |
| maxlength `v2.0.2` | Value maxlength | *string \| number* | - |
| maxlength `v2.0.2` | Value maxlength | *number \| string* | - |
| transition | Whether to show transition animation | *boolean* | `true` |
| z-index | Keyboard z-index | *string \| number* | `100` |
| z-index | Keyboard z-index | *number \| string* | `100` |
| extra-key | Content of bottom left key | *string* | `''` |
| close-button-text | Close button text | *string* | `-` |
| delete-button-text | Delete button text | *string* | `delete` |

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

@ -145,9 +145,9 @@ export default {
| show | 是否显示键盘 | *boolean* | - |
| theme | 样式风格，可选值为 `default` `custom` | *string* | `default` |
| title | 键盘标题 | *string* | - |
| maxlength `v2.0.2` | 输入值最大长度 | *string \| number* | - |
| maxlength `v2.0.2` | 输入值最大长度 | *number \| string* | - |
| transition | 是否开启过场动画 | *boolean* | `true` |
| z-index | 键盘 z-index | *string \| number* | `100` |
| z-index | 键盘 z-index | *number \| string* | `100` |
| extra-key | 左下角按键内容 | *string* | `''` |
| close-button-text | 关闭按钮文字，空则不展示 | *string* | `-` |
| delete-button-text | 删除按钮文字 | *string* | `删除` |

4
src/overlay/README.md
View File

@ -60,8 +60,8 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| show | Whether to show overlay | *boolean* | `false` |
| z-index | z-index | *string \| number* | `1` |
| duration | Animation duration | *string \| number* | `0.3` |
| z-index | z-index | *number \| string* | `1` |
| duration | Animation duration | *number \| string* | `0.3` |
| class-name | ClassName | *string* | - |
| custom-class `v2.2.5` | Custom style | *object* | - |

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

@ -66,8 +66,8 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| show | 是否展示遮罩层 | *boolean* | `false` |
| z-index | z-index 层级 | *string \| number* | `1` |
| duration | 动画时长，单位秒 | *string \| number* | `0.3` |
| z-index | z-index 层级 | *number \| string* | `1` |
| duration | 动画时长，单位秒 | *number \| string* | `0.3` |
| class-name | 自定义类名 | *string* | - |
| custom-style `v2.2.5` | 自定义样式 | *object* | - |

2
src/password-input/README.md
View File

@ -135,7 +135,7 @@ export default {
| focused `v2.1.8` | Whether to show focused cursor | *boolean* | `false` |
| info | Bottom info | *string* | - |
| error-info | Bottom error info | *string* | - |
| gutter | Gutter of input | *string \| number* | `0` |
| gutter | Gutter of input | *number \| string* | `0` |
### Events

2
src/password-input/README.zh-CN.md
View File

@ -135,7 +135,7 @@ export default {
| focused `v2.1.8` | 是否已聚焦，聚焦时会显示光标 | *boolean* | `false` |
| info | 输入框下方文字提示 | *string* | - |
| error-info | 输入框下方错误提示 | *string* | - |
| gutter | 输入框格子之间的间距，如 `20px` `2em`，默认单位为`px` | *string \| number* | `0` |
| gutter | 输入框格子之间的间距，如 `20px` `2em`，默认单位为`px` | *number \| string* | `0` |
### Events

2
src/popup/README.md
View File

@ -122,7 +122,7 @@ export default {
| position | Can be set to `top` `bottom` `right` `left` | *string* | `center` |
| overlay-class | Custom overlay class | *string* | - |
| overlay-style | Custom overlay style | *object* | - |
| duration | Transition duration, unit second | *string \| number* | `0.3` |
| duration | Transition duration, unit second | *number \| string* | `0.3` |
| round `v2.0.7` | Whether to show round corner | *boolean* | `false` |
| lock-scroll | Whether to lock background scroll | *boolean* | `true` |
| lazy-render | Whether to lazy render util appeared | *boolean* | `true` |

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

@ -133,7 +133,7 @@ export default {
| position | 弹出位置，可选值为 `top` `bottom` `right` `left` | *string* | `center` |
| overlay-class | 自定义遮罩层类名 | *string* | - |
| overlay-style | 自定义遮罩层样式 | *object* | - |
| duration | 动画时长，单位秒 | *string \| number* | `0.3` |
| duration | 动画时长，单位秒 | *number \| string* | `0.3` |
| round `v2.0.7` | 是否显示圆角 | *boolean* | `false` |
| lock-scroll | 是否锁定背景滚动 | *boolean* | `true` |
| lazy-render | 是否在显示弹层时才渲染节点 | *boolean* | `true` |

2
src/progress/README.md
View File

@ -63,7 +63,7 @@ Use `pivot-text` to custom text，use `color` to custom bar color
|------|------|------|------|
| inactive | Whether to be gray | *boolean* | `false` |
| percentage | Percentage | *number* | `0` |
| stroke-width `v2.2.1` | Stroke width | *string \| number* | `4px` |
| stroke-width `v2.2.1` | Stroke width | *number \| string* | `4px` |
| show-pivot | Whether to show text | *boolean* | `true` |
| color | Color | *string* | `#1989fa` |
| text-color | Text color | *string* | `#fff` |

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

@ -66,7 +66,7 @@ Vue.use(Progress);
|------|------|------|------|
| inactive | 是否置灰 | *boolean* | `false` |
| percentage | 进度百分比 | *number* | `0` |
| stroke-width `v2.2.1` | 进度条粗细，默认单位为`px` | *string \| number* | `4px` |
| stroke-width `v2.2.1` | 进度条粗细，默认单位为`px` | *number \| string* | `4px` |
| show-pivot | 是否显示进度文字 | *boolean* | `true` |
| color | 进度条颜色 | *string* | `#1989fa` |
| text-color | 进度文字颜色 | *string* | `#fff` |

4
src/radio/README.md
View File

@ -141,7 +141,7 @@ export default {
| disabled | Whether to disable radio | *boolean* | `false` |
| label-disabled | Whether to disable label click | *boolean* | `false` |
| label-position | Can be set to `left` | *string* | `right` |
| icon-size | Icon size | *string \| number* | `20px` |
| icon-size | Icon size | *number \| string* | `20px` |
| checked-color | Checked color | *string* | `#1989fa` | - |
### RadioGroup Props
@ -150,7 +150,7 @@ export default {
|------|------|------|------|
| v-model | Name of checked radio | *any* | - |
| disabled | Disable all radios | *boolean* | `false` |
| icon-size `v2.2.3` | Icon size of all radios | *string \| number* | `20px` |
| 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` | - |
### Radio Events

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

@ -151,7 +151,7 @@ export default {
| disabled | 是否为禁用状态 | *boolean* | `false` |
| label-disabled | 是否禁用文本内容点击 | *boolean* | `false` |
| label-position | 文本位置，可选值为 `left` | *string* | `right` |
| icon-size | 图标大小，默认单位为`px` | *string \| number* | `20px` |
| icon-size | 图标大小，默认单位为`px` | *number \| string* | `20px` |
| checked-color | 选中状态颜色 | *string* | `#1989fa` |
### RadioGroup Props
@ -160,7 +160,7 @@ export default {
|------|------|------|------|
| v-model | 当前选中项的标识符 | *any* | - |
| disabled | 是否禁用所有单选框 | *boolean* | `false` |
| icon-size `v2.2.3` | 所有单选框的图标大小，默认单位为`px` | *string \| number* | `20px` |
| icon-size `v2.2.3` | 所有单选框的图标大小，默认单位为`px` | *number \| string* | `20px` |
| checked-color `v2.2.3` | 所有单选框的选中状态颜色 | *string* | `#1989fa` |
### Radio Events

4
src/rate/README.md
View File

@ -112,8 +112,8 @@ export default {
|------|------|------|------|
| v-model | Current rate | *number* | - |
| count | Count | *number* | `5` |
| size | Icon size| *string \| number* | `20px` |
| gutter | Icon gutter | *string \| number* | `4px` |
| size | Icon size| *number \| string* | `20px` |
| gutter | Icon gutter | *number \| string* | `4px` |
| color | Selected color | *string* | `#ffd21e` |
| void-color | Void color | *string* | `#c8c9cc` |
| disabled-color | Disabled color | *string* | `#bdbdbd` |

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

@ -112,8 +112,8 @@ export default {
|------|------|------|------|
| v-model | 当前分值 | *number* | - |
| count | 图标总数 | *number* | `5` |
| size | 图标大小，默认单位为`px` | *string \| number* | `20px` |
| gutter | 图标间距，默认单位为`px` | *string \| number* | `4px` |
| size | 图标大小，默认单位为`px` | *number \| string* | `20px` |
| gutter | 图标间距，默认单位为`px` | *number \| string* | `4px` |
| color | 选中时的颜色 | *string* | `#ffd21e` |
| void-color | 未选中时的颜色 | *string* | `#c8c9cc` |
| disabled-color | 禁用时的颜色 | *string* | `#bdbdbd` |

2
src/search/README.md
View File

@ -118,7 +118,7 @@ Use `action` slot to custom right button, `cancel` event will no longer be trigg
| label | Left side label | *string* | - |
| shape | Shape of field, can be set to `round` | *string* | `square` |
| background | Background color of field | *string* | `#f2f2f2` |
| maxlength | Max length of value | *string \| number* | - |
| maxlength | Max length of value | *number \| string* | - |
| placeholder | Placeholder | *string* | - |
| clearable | Whether to be clearable | *boolean* | `true` |
| autofocus | Whether to auto focus, unsupported in iOS | *boolean* | `false` |

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

@ -118,7 +118,7 @@ export default {
| label | 搜索框左侧文本 | *string* | - |
| shape | 搜索框形状，可选值为 `round` | *string* | `square` |
| background | 搜索框外部背景色 | *string* | `#f2f2f2` |
| maxlength | 输入的最大字符数 | *string \| number* | - |
| maxlength | 输入的最大字符数 | *number \| string* | - |
| placeholder | 占位提示文字 | *string* | - |
| clearable | 是否启用清除控件 | *boolean* | `true` |
| autofocus | 是否自动聚焦，iOS 系统不支持该属性 | *boolean* | `false` |

4
src/sidebar/README.md
View File

@ -85,7 +85,7 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Index of chosen item | *string \| number* | `0` |
| v-model | Index of chosen item | *number \| string* | `0` |
### Sidebar Events
@ -99,7 +99,7 @@ export default {
|------|------|------|------|
| title | Content | *string* | `''` |
| dot `v2.2.1` | Whether to show red dot | *boolean* | `false` |
| info | Content of the badge | *string \| number* | `''` |
| info | Content of the badge | *number \| string* | `''` |
| disabled `v2.2.0` | Whether to be disabled | *boolean* | `false` |
| url | Link | *string* | - |
| to `v2.0.4` | Target route of the link, same as to of vue-router | *string \| object* | - |

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

@ -94,7 +94,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| v-model `v2.0.4` | 当前导航项的索引 | *string \| number* | `0` |
| v-model `v2.0.4` | 当前导航项的索引 | *number \| string* | `0` |
### Sidebar Events
@ -108,7 +108,7 @@ export default {
|------|------|------|------|
| title | 内容 | *string* | `''` |
| dot `v2.2.1` | 是否显示右上角小红点 | *boolean* | `false` |
| info | 右上角徽标的内容 | *string \| number* | - |
| info | 右上角徽标的内容 | *number \| string* | - |
| disabled `v2.2.0` | 是否禁用该项 | *boolean* | `false` |
| url | 点击后跳转的链接地址 | *string* | - |
| to `v2.0.4` | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - |

6
src/skeleton/README.md
View File

@ -56,11 +56,11 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| row | Row count | *number* | `0` |
| row-width | Row width, can be array | *number \| string \| number[] \| string[]* | `100%` |
| row-width | Row width, can be array | *number \| number \| string[] \| string[]* | `100%` |
| title | Whether to show title placeholder | *boolean* | `false` |
| title-width | Title width | *string \| number* | `40%` |
| title-width | Title width | *number \| string* | `40%` |
| avatar | Whether to show avatar placeholder | *boolean* | `false` |
| avatar-size | Size of avatar placeholder | *string \| number* | `32px` |
| avatar-size | Size of avatar placeholder | *number \| string* | `32px` |
| avatar-shape | Shape of avatar placeholder，can be set to `square` | *string* | `round` |
| loading | Whether to show skeleton，pass `false` to show child component | *boolean* | `true` |
| animate | Whether to enable animation | *boolean* | `true` |

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

@ -62,11 +62,11 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| row | 段落占位图行数 | *number* | `0` |
| row-width | 段落占位图宽度，可传数组来设置每一行的宽度 | *number \| string \| number[] \| string[]* | `100%` |
| row-width | 段落占位图宽度，可传数组来设置每一行的宽度 | *number \| number \| string[] \| string[]* | `100%` |
| title | 是否显示标题占位图 | *boolean* | `false` |
| title-width | 标题占位图宽度 | *string \| number* | `40%` |
| title-width | 标题占位图宽度 | *number \| string* | `40%` |
| avatar | 是否显示头像占位图 | *boolean* | `false` |
| avatar-size | 头像占位图大小 | *string \| number* | `32px` |
| avatar-size | 头像占位图大小 | *number \| string* | `32px` |
| avatar-shape | 头像占位图形状，可选值为`square` | *string* | `round` |
| loading | 是否显示占位图，传`false`时会展示子组件内容 | *boolean* | `true` |
| animate | 是否开启动画 | *boolean* | `true` |

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

@ -123,7 +123,7 @@ export default {
| v-model | 是否显示sku | *boolean* | `false` |
| sku | 商品sku数据 | *object* | - |
| goods | 商品信息 | *object* | - |
| goods-id | 商品 id | *string \| number* | - |
| goods-id | 商品 id | *number \| string* | - |
| price-tag | 显示在价格后面的标签 | *string* | - |
| hide-stock | 是否显示商品剩余库存 | *boolean* | `false` |
| hide-quota-text | 是否显示限购提示 | *boolean* | `false` |

4
src/slider/README.md
View File

@ -102,8 +102,8 @@ export default {
| max | Max value | *number* | `100` |
| min | Min value | *number* | `0` |
| step | Step size | *number* | `1` |
| bar-height | Height of bar | *string \| number* | `2px` |
| button-size `v2.4.5` | Button size | *string \| number* | `24px` |
| bar-height | Height of bar | *number \| string* | `2px` |
| button-size `v2.4.5` | Button size | *number \| string* | `24px` |
| active-color | Active color of bar | *string* | `#1989fa` |
| inactive-color | Inactive color of bar | *string* | `#e5e5e5` |
| disabled | Whether to disable slider | *boolean* | `false` |

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

@ -104,8 +104,8 @@ Slider 垂直展示时，高度为 100% 父元素高度
| max | 最大值 | *number* | `100` |
| min | 最小值 | *number* | `0` |
| step | 步长 | *number* | `1` |
| bar-height | 进度条高度，默认单位为`px` | *string \| number* | `2px` |
| button-size `v2.4.5` | 滑块按钮大小，默认单位为`px` | *string \| number* | `24px` |
| bar-height | 进度条高度，默认单位为`px` | *number \| string* | `2px` |
| button-size `v2.4.5` | 滑块按钮大小，默认单位为`px` | *number \| string* | `24px` |
| active-color | 进度条激活态颜色 | *string* | `#1989fa` |
| inactive-color | 进度条非激活态颜色 | *string* | `#e5e5e5` |
| disabled | 是否禁用滑块 | *boolean* | `false` |

16
src/stepper/README.md
View File

@ -107,20 +107,20 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current value | *string \| number* | - |
| min | Min value | *string \| number* | `1` |
| max | Max value | *string \| number* | - |
| default-value | Default value, valid when v-model is empty | *string \| number* | `1` |
| step | Value change step | *string \| number* | `1` |
| name `v2.0.3` | Stepper name | *string \| number* | - |
| v-model | Current value | *number \| string* | - |
| min | Min value | *number \| string* | `1` |
| max | Max value | *number \| string* | - |
| default-value | Default value, valid when v-model is empty | *number \| string* | `1` |
| step | Value change step | *number \| string* | `1` |
| name `v2.0.3` | Stepper name | *number \| string* | - |
| integer | Whether to allow only integers | *boolean* | `false` |
| disabled | Disable value change | *boolean* | `false` |
| disable-plus `v2.2.16` | Whether to disable plus button | *boolean* | `false` |
| disable-minus `v2.2.16` | Whether to disable minus button | *boolean* | `false` |
| disable-input | Whether to disable input | *boolean* | `false` |
| async-change | Whether to enable async change | *boolean* | `false` | - |
| input-width | Input width | *string \| number* | `32px` |
| button-size `v2.0.5` | Button size | *string \| number* | `28px` |
| input-width | Input width | *number \| string* | `32px` |
| button-size `v2.0.5` | Button size | *number \| string* | `28px` |
| show-plus `v2.1.2` | Whether to show plus button | *boolean* | `true` |
| show-minus `v2.1.2` | Whether to show minus button | *boolean* | `true` |
| long-press `v2.4.3` | Whether to allow long press | *boolean* | `true` |

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

@ -131,20 +131,20 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| v-model | 当前输入值 | *string \| number* | - |
| min | 最小值 | *string \| number* | `1` |
| max | 最大值 | *string \| number* | - |
| default-value | 初始值，当 v-model 为空时生效 | *string \| number* | `1` |
| step | 步长，每次点击时改变的值 | *string \| number* | `1` |
| name `v2.2.11` | 标识符，可以在`change`事件回调参数中获取 | *string \| number* | - |
| v-model | 当前输入值 | *number \| string* | - |
| min | 最小值 | *number \| string* | `1` |
| max | 最大值 | *number \| string* | - |
| default-value | 初始值，当 v-model 为空时生效 | *number \| string* | `1` |
| step | 步长，每次点击时改变的值 | *number \| string* | `1` |
| name `v2.2.11` | 标识符，可以在`change`事件回调参数中获取 | *number \| string* | - |
| integer | 是否只允许输入整数 | *boolean* | `false` |
| disabled | 是否禁用步进器 | *boolean* | `false` |
| disable-plus `v2.2.16` | 是否禁用增加按钮 | *boolean* | `false` |
| disable-minus `v2.2.16` | 是否禁用减少按钮 | *boolean* | `false` |
| disable-input | 是否禁用输入框 | *boolean* | `false` |
| async-change | 是否开启异步变更，开启后需要手动控制输入值 | *boolean* | `false` |
| input-width | 输入框宽度，默认单位为`px` | *string \| number* | `32px` |
| button-size `v2.0.5` | 按钮大小以及输入框高度，默认单位为`px` | *string \| number* | `28px` |
| input-width | 输入框宽度，默认单位为`px` | *number \| string* | `32px` |
| button-size `v2.0.5` | 按钮大小以及输入框高度，默认单位为`px` | *number \| string* | `28px` |
| show-plus `v2.1.2` | 是否显示增加按钮 | *boolean* | `true` |
| show-minus `v2.1.2` | 是否显示减少按钮 | *boolean* | `true` |
| long-press `v2.4.3` | 是否开启长按手势 | *boolean* | `true` |

2
src/sticky/README.md
View File

@ -57,7 +57,7 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| offset-top | Offset top | *number* | `0` |
| z-index | z-index when sticky | *string \| number* | `99` |
| z-index | z-index when sticky | *number \| string* | `99` |
| container | Container DOM | *HTMLElement* | - |
### Events

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

@ -67,7 +67,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| offset-top | 吸顶时与顶部的距离，单位`px` | *number* | `0` |
| z-index | 吸顶时的 z-index | *string \| number* | `99` |
| z-index | 吸顶时的 z-index | *number \| string* | `99` |
| container | 容器对应的 HTML 节点 | *HTMLElement* | - |
### Events

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

@ -102,7 +102,7 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| name `v2.0.4` | Identifier of SwipeCell | *string \| number* | - |
| name `v2.0.4` | Identifier of SwipeCell | *number \| string* | - |
| before-close `v2.3.0` | Callback function before close | *Function* | - |
| disabled | Whether to disabled swipe | *boolean* | `false` |
| left-width | Width of the left swipe area | *number* | `auto` |

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

@ -110,7 +110,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| name `v2.0.4` | 标识符，可以在事件参数中获取到 | *string \| number* | - |
| name `v2.0.4` | 标识符，可以在事件参数中获取到 | *number \| string* | - |
| before-close `v2.3.0` | 关闭前的回调函数 | *Function* | - |
| disabled | 是否禁用滑动 | *boolean* | `false` |
| left-width | 指定左侧滑动区域宽度 | *number* | `auto` |

2
src/switch-cell/README.md
View File

@ -65,7 +65,7 @@ use `loading` property to keep component in loading state
| cell-size | Cell size，can be set to `large` | *string* | - |
| loading | whether switch is loading | *boolean* | `false` |
| disabled | whether to disable switch | *boolean* | `false` |
| size | Size of switch | *string \| number* | `24px` |
| size | Size of switch | *number \| string* | `24px` |
| active-color | Background of switch color when active | *string* | `#1989fa` |
| inactive-color | Background of switch color when inactive | *string* | `#fff` |
| active-value | Value when active | *any* | `true` |

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

@ -65,7 +65,7 @@ export default {
| cell-size | 单元格大小，可选值为 `large` | *string* | - |
| loading | 是否为加载状态 | *boolean* | `false` |
| disabled | 是否为禁用状态 | *boolean* | `false` |
| size | 开关尺寸 | *string \| number* | `24px` |
| size | 开关尺寸 | *number \| string* | `24px` |
| active-color | 开关时的背景色 | *string* | `#1989fa` |
| inactive-color | 开关时的背景色 | *string* | `#fff` |
| active-value | 打开时的值 | *any* | `true` |

2
src/switch/README.md
View File

@ -94,7 +94,7 @@ export default {
| v-model | Check status of Switch | *any* | `false` |
| loading | Whether to show loading icon | *boolean* | `false` |
| disabled | Whether to disable switch | *boolean* | `false` |
| size `v2.2.11` | Size of switch | *string \| number* | `30px` |
| size `v2.2.11` | Size of switch | *number \| string* | `30px` |
| active-color | Background color when active | *string* | `#1989fa` |
| inactive-color | Background color when inactive | *string* | `#fff` |
| active-value | Value when active | *any* | `true` |

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

@ -106,7 +106,7 @@ export default {
| v-model | 开关选中状态 | *any* | `false` |
| loading | 是否为加载状态 | *boolean* | `false` |
| disabled | 是否为禁用状态 | *boolean* | `false` |
| size `v2.2.11` | 开关尺寸，默认单位为`px` | *string \| number* | `30px` |
| size `v2.2.11` | 开关尺寸，默认单位为`px` | *number \| string* | `30px` |
| active-color | 打开时的背景色 | *string* | `#1989fa` |
| inactive-color | 关闭时的背景色 | *string* | `#fff` |
| active-value | 打开时的值 | *any* | `true` |

10
src/tab/README.md
View File

@ -193,13 +193,13 @@ In scrollspy mode, the list of content will be tiled
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Index of active tab | *string \| number* | `0` |
| v-model | Index of active tab | *number \| string* | `0` |
| type | Can be set to `line` `card` | *string* | `line` |
| color | Tab color | *string* | `#ee0a24` |
| duration | Toggle tab's animation time | *number* | `0.3` | - |
| background | Background color | *string* | `white` |
| line-width | Width of tab line | *string \| number* | Width of active tab |
| line-height | Height of tab line | *string \| number* | `3px` |
| line-width | Width of tab line | *number \| string* | Width of active tab |
| line-height | Height of tab line | *number \| string* | `3px` |
| animated | Whether to change tabs with animation | *boolean* | `false` |
| border | Whether to show border when `type="line"` | *boolean* | `true` |
| ellipsis | Whether to ellipsis too long title | *boolean* | `true` |
@ -219,8 +219,8 @@ In scrollspy mode, the list of content will be tiled
| title | Title | *string* | - |
| disabled | Whether to disable tab | *boolean* | `false` |
| dot `v2.3.0` | Whether to show red dot on the title | *boolean* | `false` |
| info `v2.3.0` | Content of the badge on the title | *string \| number* | - |
| name `v2.0.6` | Identifier | *string \| number* | Index of tab |
| info `v2.3.0` | Content of the badge on the title | *number \| string* | - |
| name `v2.0.6` | Identifier | *number \| string* | Index of tab |
| url `v2.2.1` | Link | *string* | - |
| to `v2.2.1` | Target route of the link, same as to of vue-router | *string \| object* | - |
| replace `v2.2.1` | If true, the navigation will not leave a history record | *boolean* | `false` |

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

@ -197,13 +197,13 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| v-model | 绑定当前选中标签的标识符 | *string \| number* | `0` |
| v-model | 绑定当前选中标签的标识符 | *number \| string* | `0` |
| type | 样式风格类型，可选值为`card` | *string* | `line` |
| color | 标签主题色 | *string* | `#ee0a24` |
| duration | 动画时间，单位秒 | *number* | `0.3` |
| background | 标签栏背景色 | *string* | `white` |
| line-width | 底部条宽度，默认单位 px | *string \| number* | `auto` |
| line-height | 底部条高度，默认单位 px | *string \| number* | `3px` |
| line-width | 底部条宽度，默认单位 px | *number \| string* | `auto` |
| line-height | 底部条高度，默认单位 px | *number \| string* | `3px` |
| animated | 是否开启切换标签内容时的转场动画 | *boolean* | `false` |
| border | 是否显示标签栏外边框，仅在`type="line"`时有效 | *boolean* | `true` |
| ellipsis | 是否省略过长的标题文字 | *boolean* | `true` |
@ -223,8 +223,8 @@ export default {
| title | 标题 | *string* | - |
| disabled | 是否禁用标签 | *boolean* | `false` |
| dot `v2.3.0` | 是否在标题右上角显示小红点 | *boolean* | `false` |
| info `v2.3.0` | 标题右上角徽标的内容 | *string \| number* | - |
| name `v2.0.6` | 标签名称，作为匹配的标识符 | *string \| number* | 标签的索引值 |
| info `v2.3.0` | 标题右上角徽标的内容 | *number \| string* | - |
| name `v2.0.6` | 标签名称，作为匹配的标识符 | *number \| string* | 标签的索引值 |
| url `v2.2.1` | 点击后跳转的链接地址 | *string* | - |
| to `v2.2.1` | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - |
| replace `v2.2.1` | 是否在跳转时替换当前页面历史 | *boolean* | `false` |

8
src/tabbar/README.md
View File

@ -158,10 +158,10 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Identifier of current tab | *string \| number* | `0` |
| v-model | Identifier of current tab | *number \| string* | `0` |
| fixed | Whether to fixed bottom | *boolean* | `true` |
| border | Whether to show border | *boolean* | `true` |
| z-index | Z-index | *string \| number* | `1` |
| z-index | Z-index | *number \| string* | `1` |
| active-color | Color of active tab item | *string* | `#1989fa` |
| inactive-color | Color of inactive tab item | *string* | `#7d7e80` |
| route | Whether to enable route mode | *boolean* | `false` |
@ -177,10 +177,10 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| name | Identifier | *string \| number* | Item index |
| name | Identifier | *number \| string* | Item index |
| icon | Icon name | *string* | - |
| dot | Whether to show red dot | *boolean* | - |
| info | Content of the badge | *string \| number* | - |
| info | Content of the badge | *number \| string* | - |
| url | Link | *string* | - |
| to | Target route of the link, same as to of vue-router | *string \| object* | - |
| replace | If true, the navigation will not leave a history record | *boolean* | `false` |

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

@ -165,10 +165,10 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| v-model | 当前选中标签的名称或索引值 | *string \| number* | `0` |
| v-model | 当前选中标签的名称或索引值 | *number \| string* | `0` |
| fixed | 是否固定在底部 | *boolean* | `true` |
| border | 是否显示外边框 | *boolean* | `true` |
| z-index | 元素 z-index | *string \| number* | `1` |
| z-index | 元素 z-index | *number \| string* | `1` |
| active-color | 选中标签的颜色 | *string* | `#1989fa` |
| inactive-color | 未选中标签的颜色 | *string* | `#7d7e80` |
| route | 是否开启路由模式 | *boolean* | `false` |
@ -184,10 +184,10 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| name | 标签名称，作为匹配的标识符 | *string \| number* | 当前标签的索引值 |
| name | 标签名称，作为匹配的标识符 | *number \| string* | 当前标签的索引值 |
| icon | [图标名称](#/zh-CN/icon) 或图片链接| *string* | - |
| dot | 是否显示图标右上角小红点 | *boolean* | `false` |
| info | 图标右上角徽标的内容 | *string \| number* | - |
| info | 图标右上角徽标的内容 | *number \| string* | - |
| url | 点击后跳转的链接地址 | *string* | - |
| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - |
| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` |

4
src/tree-select/README.md
View File

@ -112,9 +112,9 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| items | Required datasets for the component | *Item[]* | `[]` |
| height | Height | *string \| number* | `300` |
| height | Height | *number \| string* | `300` |
| main-Active-index | The index of selected parent node | *number* | `0` |
| active-id | Id of selected item | *string \| number \| (string \| number)[]* | `0` |
| active-id | Id of selected item | *number \| string \| (number \| string)[]* | `0` |
| max `v2.2.0` | Maximum number of selected items | *number* | `Infinity` |
### Events

4
src/tree-select/README.zh-CN.md
View File

@ -120,9 +120,9 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| items | 分类显示所需的数据 | *Item[]* | `[]` |
| height | 高度，默认单位为`px` | *string \| number* | `300` |
| height | 高度，默认单位为`px` | *number \| string* | `300` |
| main-active-index | 左侧选中项的索引 | *number* | `0` |
| active-id | 右侧选中项的 id，支持传入数组 | *string \| number \| (string \| number)[]* | `0` |
| active-id | 右侧选中项的 id，支持传入数组 | *number \| string \| (number \| string)[]* | `0` |
| max `v2.2.0` | 右侧项最大选中个数 | *number* | `Infinity` |
### Events

4
src/uploader/README.md
View File

@ -111,9 +111,9 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| name `v2.0.3` | Input name | *string \| number* | - |
| name `v2.0.3` | Input name | *number \| string* | - |
| accept | Accepted file type | *string* | `image/*` |
| preview-size | Size of preview image | *string \| number* | `80px` |
| preview-size | Size of preview image | *number \| string* | `80px` |
| preview-image `v2.1.5` | Whether to show image preview | *boolean* | `true` |
| preview-full-image | Whethe to show full screen image preview when click image | *boolean* | `true` |
| multiple | Whether to enable multiple selection pictures | *boolean* | `false` |

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

@ -127,9 +127,9 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| name `v2.0.3` | 标识符，可以在回调函数的第二项参数中获取 | *string \| number* | - |
| name `v2.0.3` | 标识符，可以在回调函数的第二项参数中获取 | *number \| string* | - |
| accept | 接受的文件类型 | *string* | `image/*` |
| preview-size | 预览图和上传区域的尺寸，默认单位为`px` | *string \| number* | `80px` |
| preview-size | 预览图和上传区域的尺寸，默认单位为`px` | *number \| string* | `80px` |
| preview-image | 是否在上传完成后展示预览图 | *boolean* | `true` |
| preview-full-image `v2.1.5` | 是否在点击预览图后展示全屏图片预览 | *boolean* | `true` |
| multiple | 是否开启图片多选，部分安卓机型不支持 | *boolean* | `false` |