From 51bc1cee8a267833e0088e163a0d5150f4cec1e5 Mon Sep 17 00:00:00 2001 From: chenjiahan <chenjiahan@youzan.com> Date: Sun, 10 Jan 2021 19:08:09 +0800 Subject: [PATCH] docs: remove all v2 version tag --- src/action-bar/README.md | 4 +-- src/action-bar/README.zh-CN.md | 6 ++-- src/action-sheet/README.md | 12 +++---- src/action-sheet/README.zh-CN.md | 12 +++---- src/address-edit/README.md | 8 ++--- src/address-edit/README.zh-CN.md | 28 ++++++++-------- src/address-list/README.md | 12 +++---- src/address-list/README.zh-CN.md | 28 ++++++++-------- src/area/README.md | 14 ++++---- src/area/README.zh-CN.md | 14 ++++---- src/button/README.md | 12 +++---- src/button/README.zh-CN.md | 12 +++---- src/calendar/README.md | 40 +++++++++++------------ src/calendar/README.zh-CN.md | 46 +++++++++++++------------- src/cell/README.md | 2 +- src/cell/README.zh-CN.md | 2 +- src/checkbox/README.md | 2 +- src/checkbox/README.zh-CN.md | 2 +- src/collapse/README.md | 6 ++-- src/collapse/README.zh-CN.md | 2 +- src/contact-edit/README.md | 4 +-- src/contact-edit/README.zh-CN.md | 4 +-- src/contact-list/README.md | 2 +- src/contact-list/README.zh-CN.md | 12 +++---- src/count-down/README.md | 8 ++--- src/count-down/README.zh-CN.md | 8 ++--- src/coupon-list/README.md | 2 +- src/coupon-list/README.zh-CN.md | 2 +- src/datetime-picker/README.md | 30 ++++++++--------- src/datetime-picker/README.zh-CN.md | 26 +++++++-------- src/dialog/README.md | 8 ++--- src/dialog/README.zh-CN.md | 4 +-- src/dropdown-menu/README.md | 2 +- src/dropdown-menu/README.zh-CN.md | 2 +- src/empty/README.md | 2 +- src/empty/README.zh-CN.md | 2 +- src/field/README.md | 32 +++++++++--------- src/field/README.zh-CN.md | 50 ++++++++++++++--------------- src/form/README.md | 26 +++++++-------- src/form/README.zh-CN.md | 26 +++++++-------- src/grid/README.md | 6 ++-- src/grid/README.zh-CN.md | 6 ++-- src/icon/README.md | 18 +++++------ src/icon/README.zh-CN.md | 2 +- src/image-preview/README.md | 16 ++++----- src/image-preview/README.zh-CN.md | 16 ++++----- src/image/README.md | 16 ++++----- src/image/README.zh-CN.md | 16 ++++----- src/index-bar/README.md | 6 ++-- src/index-bar/README.zh-CN.md | 14 ++++---- src/nav-bar/README.md | 4 +-- src/nav-bar/README.zh-CN.md | 4 +-- src/notice-bar/README.md | 10 +++--- src/notice-bar/README.zh-CN.md | 10 +++--- src/number-keyboard/README.md | 10 +++--- src/number-keyboard/README.zh-CN.md | 14 ++++---- src/overlay/README.md | 2 +- src/overlay/README.zh-CN.md | 2 +- src/pagination/README.md | 6 ++-- src/pagination/README.zh-CN.md | 6 ++-- src/picker/README.md | 34 ++++++++++---------- src/picker/README.zh-CN.md | 34 ++++++++++---------- src/popover/README.md | 2 +- src/popover/README.zh-CN.md | 2 +- src/popup/README.md | 22 ++++++------- src/popup/README.zh-CN.md | 20 ++++++------ src/pull-refresh/README.md | 2 +- src/pull-refresh/README.zh-CN.md | 2 +- src/radio/README.md | 2 +- src/radio/README.zh-CN.md | 2 +- src/rate/README.md | 2 +- src/rate/README.zh-CN.md | 2 +- src/search/README.md | 2 +- src/search/README.zh-CN.md | 2 +- src/share-sheet/README.md | 4 +-- src/share-sheet/README.zh-CN.md | 12 +++---- src/sidebar/README.md | 8 ++--- src/sidebar/README.zh-CN.md | 8 ++--- src/skeleton/README.md | 2 +- src/skeleton/README.zh-CN.md | 2 +- src/slider/README.md | 2 +- src/slider/README.zh-CN.md | 2 +- src/stepper/README.md | 8 ++--- src/stepper/README.zh-CN.md | 8 ++--- src/steps/README.md | 4 +-- src/steps/README.zh-CN.md | 8 ++--- src/sticky/README.md | 2 +- src/sticky/README.zh-CN.md | 2 +- src/submit-bar/README.md | 16 ++++----- src/submit-bar/README.zh-CN.md | 16 ++++----- src/swipe-cell/README.md | 2 +- src/swipe/README.md | 6 ++-- src/swipe/README.zh-CN.md | 32 +++++++++--------- src/tab/README.md | 14 ++++---- src/tab/README.zh-CN.md | 14 ++++---- src/tabbar/README.md | 8 ++--- src/tabbar/README.zh-CN.md | 8 ++--- src/tree-select/README.md | 2 +- src/tree-select/README.zh-CN.md | 2 +- src/uploader/README.md | 12 +++---- src/uploader/README.zh-CN.md | 18 +++++------ 101 files changed, 525 insertions(+), 527 deletions(-) diff --git a/src/action-bar/README.md b/src/action-bar/README.md index b067d66cf..bd19b05a2 100644 --- a/src/action-bar/README.md +++ b/src/action-bar/README.md @@ -95,7 +95,7 @@ Use `badge` prop to show badge in icon. | --- | --- | --- | --- | | text | Button text | _string_ | - | | icon | Icon | _string_ | - | -| color `v2.4.2` | Icon color | _string_ | `#323233` | +| color | Icon color | _string_ | `#323233` | | icon-class | Icon class name | _any_ | `''` | | dot `2.5.5` | Whether to show red dot | _boolean_ | - | | badge `2.5.6` | Content of the badge | _number \| string_ | - | @@ -110,7 +110,7 @@ Use `badge` prop to show badge in icon. | text | Button text | _string_ | - | | type | Button type, Can be set to `primary` `info` `warning` `danger` | _string_ | `default` | | color | Button color, support linear-gradient | _string_ | - | -| icon `v2.4.4` | Left Icon | _string_ | - | +| icon | Left Icon | _string_ | - | | disabled | Whether to disable button | _boolean_ | `false` | | loading | Whether show loading status | _boolean_ | `false` | | url | Link | _string_ | - | diff --git a/src/action-bar/README.zh-CN.md b/src/action-bar/README.zh-CN.md index 28d5ad844..48dd75760 100644 --- a/src/action-bar/README.zh-CN.md +++ b/src/action-bar/README.zh-CN.md @@ -99,10 +99,10 @@ export default { | --- | --- | --- | --- | | text | 按钮文字 | _string_ | - | | icon | 图标 | _string_ | - | -| color `v2.4.2` | 图标颜色 | _string_ | `#323233` | +| color | 图标颜色 | _string_ | `#323233` | | icon-class | 图标额外类名 | _any_ | - | | dot `2.5.5` | 是否显示图标右上角小红点 | _boolean_ | `false` | -| badge `v2.5.6` | 图标右上角徽标的内容 | _number \| string_ | - | +| badge | 图标右上角徽标的内容 | _number \| string_ | - | | url | 点击后跳转的链接地址 | _string_ | - | | to | 点击后跳转的目标路由对象,同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | _string \| object_ | - | | replace | 是否在跳转时替换当前页面历史 | _boolean_ | `false` | @@ -114,7 +114,7 @@ export default { | text | 按钮文字 | _string_ | - | | type | 按钮类型,可选值为 `primary` `info` `warning` `danger` | _string_ | `default` | | color | 按钮颜色,支持传入 `linear-gradient` 渐变色 | _string_ | - | -| icon `v2.4.4` | 左侧[图标名称](#/zh-CN/icon)或图片链接 | _string_ | - | +| icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | _string_ | - | | disabled | 是否禁用按钮 | _boolean_ | `false` | - | | loading | 是否显示为加载状态 | _boolean_ | `false` | - | | url | 点击后跳转的链接地址 | _string_ | - | diff --git a/src/action-sheet/README.md b/src/action-sheet/README.md index 23c2868fc..82cd2952f 100644 --- a/src/action-sheet/README.md +++ b/src/action-sheet/README.md @@ -172,14 +172,14 @@ export default { | title | Title | _string_ | - | | cancel-text | Text of cancel button | _string_ | - | | description | Description above the options | _string_ | - | -| closeable `v2.10.5` | Whether to show close icon | _boolean_ | `true` | +| closeable | Whether to show close icon | _boolean_ | `true` | | close-icon | Close icon name | _string_ | `cross` | | duration | Transition duration, unit second | _number \| string_ | `0.3` | | round | Whether to show round corner | _boolean_ | `true` | | overlay | Whether to show overlay | _boolean_ | `true` | | lock-scroll | Whether to lock background scroll | _boolean_ | `true` | | lazy-render | Whether to lazy render util appeared | _boolean_ | `true` | -| close-on-popstate `v2.5.3` | Whether to close when popstate | _boolean_ | `false` | +| close-on-popstate | Whether to close when popstate | _boolean_ | `false` | | close-on-click-action | Whether to close when an action is clicked | _boolean_ | `false` | | close-on-click-overlay | Whether to close when overlay is clicked | _boolean_ | `true` | | safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` | @@ -210,10 +210,10 @@ export default { ### Slots -| Name | Description | -| --------------------- | ------------------ | -| default | Custom content | -| description `v2.10.4` | Custom description | +| Name | Description | +| ----------- | ------------------ | +| default | Custom content | +| description | Custom description | ### Less Variables diff --git a/src/action-sheet/README.zh-CN.md b/src/action-sheet/README.zh-CN.md index 755758d19..703382d05 100644 --- a/src/action-sheet/README.zh-CN.md +++ b/src/action-sheet/README.zh-CN.md @@ -186,14 +186,14 @@ export default { | title | 顶部标题 | _string_ | - | | cancel-text | 取消按钮文字 | _string_ | - | | description | 选项上方的描述信息 | _string_ | - | -| closeable `v2.10.5` | 是否显示关闭图标 | _boolean_ | `true` | +| closeable | 是否显示关闭图标 | _boolean_ | `true` | | close-icon | 关闭[图标名称](#/zh-CN/icon)或图片链接 | _string_ | `cross` | | duration | 动画时长,单位秒 | _number \| string_ | `0.3` | | round | 是否显示圆角 | _boolean_ | `true` | | overlay | 是否显示遮罩层 | _boolean_ | `true` | | lock-scroll | 是否锁定背景滚动 | _boolean_ | `true` | | lazy-render | 是否在显示弹层时才渲染节点 | _boolean_ | `true` | -| close-on-popstate `v2.5.3` | 是否在页面回退时自动关闭 | _boolean_ | `false` | +| close-on-popstate | 是否在页面回退时自动关闭 | _boolean_ | `false` | | close-on-click-action | 是否在点击选项后关闭 | _boolean_ | `false` | | close-on-click-overlay | 是否在点击遮罩层后关闭 | _boolean_ | `true` | | safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `true` | @@ -226,10 +226,10 @@ export default { ### Slots -| 名称 | 说明 | -| --------------------- | -------------------- | -| default | 自定义面板的展示内容 | -| description `v2.10.4` | 自定义描述文案 | +| 名称 | 说明 | +| ----------- | -------------------- | +| default | 自定义面板的展示内容 | +| description | 自定义描述文案 | ### 样式变量 diff --git a/src/address-edit/README.md b/src/address-edit/README.md index e407abadc..e35296db5 100644 --- a/src/address-edit/README.md +++ b/src/address-edit/README.md @@ -75,7 +75,7 @@ export default { | --- | --- | --- | --- | | area-list | Area List | _object_ | - | | area-columns-placeholder | placeholder of area columns | _string[]_ | `[]` | -| area-placeholder `v2.6.1` | placeholder of area input field | _string_ | `Area` | +| area-placeholder | placeholder of area input field | _string_ | `Area` | | address-info | Address Info | _AddressInfo_ | `{}` | | search-result | Address search result | _SearchResult[]_ | `[]` | | show-postal | Whether to show postal field | _boolean_ | `false` | @@ -84,7 +84,7 @@ export default { | show-search-result | Whether to show address search result | _boolean_ | `false` | | show-area | Whether to show area cell | _boolean_ | `true` | | show-detail | Whether to show detail field | _boolean_ | `true` | -| disable-area `v2.5.0` | Whether to disable area select | _boolean_ | `false` | +| disable-area | Whether to disable area select | _boolean_ | `false` | | save-button-text | Save button text | _string_ | `Save` | | delete-button-text | Delete button text | _string_ | `Delete` | | detail-rows | Detail input rows | _number \| string_ | `1` | @@ -92,7 +92,7 @@ export default { | 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_ | - | -| tel-maxlength `v2.10.0` | Tel maxlength | _number \| string_ | - | +| tel-maxlength | Tel maxlength | _number \| string_ | - | | postal-validator | The method to validate postal | _(tel: string) => boolean_ | - | | validator | Custom validator | _(key, val) => string_ | - | @@ -105,7 +105,7 @@ export default { | delete | Emitted when confirming delete | content:form content | | cancel-delete | Emitted when canceling delete | content:form content | | select-search | Emitted when a search result is selected | value: search content | -| click-area `v2.5.9` | Emitted when the area field is clicked | - | +| click-area | Emitted when the area field is clicked | - | | change-area | Emitted when area changed | values: area values | | change-detail | Emitted when address detail changed | value: address detail | | change-default | Emitted when switching default address | value: checked | diff --git a/src/address-edit/README.zh-CN.md b/src/address-edit/README.zh-CN.md index 784306ed4..5a21fef23 100644 --- a/src/address-edit/README.zh-CN.md +++ b/src/address-edit/README.zh-CN.md @@ -79,7 +79,7 @@ export default { | --- | --- | --- | --- | | area-list | 地区列表 | _object_ | - | | area-columns-placeholder | 地区选择列占位提示文字 | _string[]_ | `[]` | -| area-placeholder `v2.6.1` | 地区输入框占位提示文字 | _string_ | `选择省 / 市 / 区` | +| area-placeholder | 地区输入框占位提示文字 | _string_ | `选择省 / 市 / 区` | | address-info | 收货人信息初始值 | _AddressInfo_ | `{}` | | search-result | 详细地址搜索结果 | _SearchResult[]_ | `[]` | | show-postal | 是否显示邮政编码 | _boolean_ | `false` | @@ -88,7 +88,7 @@ export default { | show-search-result | 是否显示搜索结果 | _boolean_ | `false` | | show-area | 是否显示地区 | _boolean_ | `true` | | show-detail | 是否显示详细地址 | _boolean_ | `true` | -| disable-area `v2.5.0` | 是否禁用地区选择 | _boolean_ | `false` | +| disable-area | 是否禁用地区选择 | _boolean_ | `false` | | save-button-text | 保存按钮文字 | _string_ | `保存` | | delete-button-text | 删除按钮文字 | _string_ | `删除` | | detail-rows | 详细地址输入框行数 | _number \| string_ | `1` | @@ -96,23 +96,23 @@ export default { | is-saving | 是否显示保存按钮加载动画 | _boolean_ | `false` | | is-deleting | 是否显示删除按钮加载动画 | _boolean_ | `false` | | tel-validator | 手机号格式校验函数 | _string => boolean_ | - | -| tel-maxlength `v2.10.0` | 手机号最大长度 | _number \| string_ | - | +| tel-maxlength | 手机号最大长度 | _number \| string_ | - | | postal-validator | 邮政编码格式校验函数 | _string => boolean_ | - | | validator | 自定义校验函数 | _(key, val) => string_ | - | ### Events -| 事件名 | 说明 | 回调参数 | -| --- | --- | --- | -| save | 点击保存按钮时触发 | content:表单内容 | -| focus | 输入框聚焦时触发 | key: 聚焦的输入框对应的 key | -| delete | 确认删除地址时触发 | content:表单内容 | -| cancel-delete | 取消删除地址时触发 | content:表单内容 | -| select-search | 选中搜索结果时触发 | value: 搜索结果 | -| click-area `v2.5.9` | 点击收件地区时触发 | - | -| change-area | 修改收件地区时触发 | values: 地区信息 | -| change-detail | 修改详细地址时触发 | value: 详细地址内容 | -| change-default | 切换是否使用默认地址时触发 | value: 是否选中 | +| 事件名 | 说明 | 回调参数 | +| -------------- | -------------------------- | --------------------------- | +| save | 点击保存按钮时触发 | content:表单内容 | +| focus | 输入框聚焦时触发 | key: 聚焦的输入框对应的 key | +| delete | 确认删除地址时触发 | content:表单内容 | +| cancel-delete | 取消删除地址时触发 | content:表单内容 | +| select-search | 选中搜索结果时触发 | value: 搜索结果 | +| click-area | 点击收件地区时触发 | - | +| change-area | 修改收件地区时触发 | values: 地区信息 | +| change-detail | 修改详细地址时触发 | value: 详细地址内容 | +| change-default | 切换是否使用默认地址时触发 | value: 是否选中 | ### Slots diff --git a/src/address-list/README.md b/src/address-list/README.md index 89f427699..c831bdd89 100644 --- a/src/address-list/README.md +++ b/src/address-list/README.md @@ -87,7 +87,7 @@ export default { | disabled-text | Disabled text | _string_ | - | | switchable | Whether to allow switch address | _boolean_ | `true` | | add-button-text | Add button text | _string_ | `Add new address` | -| default-tag-text `v2.3.0` | Default tag text | _string_ | - | +| default-tag-text | Default tag text | _string_ | - | ### Events @@ -112,11 +112,11 @@ export default { ### Slots -| Name | Description | SlotProps | -| -------------------- | ------------------------------ | --------- | -| default | Custom content after list | - | -| top | Custom content before list | - | -| item-bottom `v2.5.0` | Custom content after list item | item | +| Name | Description | SlotProps | +| ----------- | ------------------------------ | --------- | +| default | Custom content after list | - | +| top | Custom content before list | - | +| item-bottom | Custom content after list item | item | ### Less Variables diff --git a/src/address-list/README.zh-CN.md b/src/address-list/README.zh-CN.md index 1277fc8bf..7ccf9f53c 100644 --- a/src/address-list/README.zh-CN.md +++ b/src/address-list/README.zh-CN.md @@ -83,15 +83,15 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | -| ------------------------- | ----------------- | ----------- | ---------- | -| v-model | 当前选中地址的 id | _string_ | - | -| list | 地址列表 | _Address[]_ | `[]` | -| disabled-list | 不可配送地址列表 | _Address[]_ | `[]` | -| disabled-text | 不可配送提示文案 | _string_ | - | -| switchable | 是否允许切换地址 | _boolean_ | `true` | -| add-button-text | 底部按钮文字 | _string_ | `新增地址` | -| default-tag-text `v2.3.0` | 默认地址标签文字 | _string_ | - | +| 参数 | 说明 | 类型 | 默认值 | +| ---------------- | ----------------- | ----------- | ---------- | +| v-model | 当前选中地址的 id | _string_ | - | +| list | 地址列表 | _Address[]_ | `[]` | +| disabled-list | 不可配送地址列表 | _Address[]_ | `[]` | +| disabled-text | 不可配送提示文案 | _string_ | - | +| switchable | 是否允许切换地址 | _boolean_ | `true` | +| add-button-text | 底部按钮文字 | _string_ | `新增地址` | +| default-tag-text | 默认地址标签文字 | _string_ | - | ### Events @@ -116,11 +116,11 @@ export default { ### Slots -| 名称 | 说明 | 参数 | -| -------------------- | -------------------- | ---------- | -| default | 在列表下方插入内容 | - | -| top | 在顶部插入内容 | - | -| item-bottom `v2.5.0` | 在列表项底部插入内容 | 列表项的值 | +| 名称 | 说明 | 参数 | +| ----------- | -------------------- | ---------- | +| default | 在列表下方插入内容 | - | +| top | 在顶部插入内容 | - | +| item-bottom | 在列表项底部插入内容 | 列表项的值 | ### 样式变量 diff --git a/src/area/README.md b/src/area/README.md index 4f538c148..b8432f855 100644 --- a/src/area/README.md +++ b/src/area/README.md @@ -65,8 +65,8 @@ To have a selected value,simply pass the `code` of target area to `value` prop | area-list | Area list data | _object_ | - | | columns-placeholder | Placeholder of columns | _string[]_ | `[]` | | loading | Whether to show loading prompt | _boolean_ | `false` | -| readonly `v2.10.5` | Whether to be readonly | _boolean_ | `false` | -| item-height `v2.8.6` | Option height, supports `px` `vw` `vh` `rem` unit, default `px` | _number \| string_ | `44` | +| readonly | Whether to be readonly | _boolean_ | `false` | +| item-height | Option height, supports `px` `vw` `vh` `rem` unit, default `px` | _number \| string_ | `44` | | columns-num | Level of picker | _number \| string_ | `3` | | visible-item-count | Count of visible columns | _number \| string_ | `6` | | swipe-duration | Duration of the momentum animation,unit `ms` | _number \| string_ | `1000` | @@ -82,11 +82,11 @@ To have a selected value,simply pass the `code` of target area to `value` prop ### Slots -| Name | Description | -| ----------------------- | ---------------------------- | -| title `v2.5.3` | Custom title | -| columns-top `v2.5.3` | Custom content above columns | -| columns-bottom `v2.5.3` | Custom content below columns | +| Name | Description | +| -------------- | ---------------------------- | +| title | Custom title | +| columns-top | Custom content above columns | +| columns-bottom | Custom content below columns | ### Methods diff --git a/src/area/README.zh-CN.md b/src/area/README.zh-CN.md index cc7e0b2ee..71630e354 100644 --- a/src/area/README.zh-CN.md +++ b/src/area/README.zh-CN.md @@ -65,8 +65,8 @@ app.use(Area); | area-list | 省市区数据,格式见下方 | _object_ | - | | columns-placeholder | 列占位提示文字 | _string[]_ | `[]` | | loading | 是否显示加载状态 | _boolean_ | `false` | -| readonly `v2.10.5` | 是否为只读状态,只读状态下无法切换选项 | _boolean_ | `false` | -| item-height `v2.8.6` | 选项高度,支持 `px` `vw` `vh` `rem` 单位,默认 `px` | _number \| string_ | `44` | +| readonly | 是否为只读状态,只读状态下无法切换选项 | _boolean_ | `false` | +| item-height | 选项高度,支持 `px` `vw` `vh` `rem` 单位,默认 `px` | _number \| string_ | `44` | | columns-num | 显示列数,3-省市区,2-省市,1-省 | _number \| string_ | `3` | | visible-item-count | 可见的选项个数 | _number \| string_ | `6` | | swipe-duration | 快速滑动时惯性滚动的时长,单位`ms` | _number \| string_ | `1000` | @@ -82,11 +82,11 @@ app.use(Area); ### Slots -| 名称 | 说明 | -| ----------------------- | ------------------ | -| title `v2.5.3` | 自定义标题内容 | -| columns-top `v2.5.3` | 自定义选项上方内容 | -| columns-bottom `v2.5.3` | 自定义选项下方内容 | +| 名称 | 说明 | +| -------------- | ------------------ | +| title | 自定义标题内容 | +| columns-top | 自定义选项上方内容 | +| columns-bottom | 自定义选项下方内容 | ### 方法 diff --git a/src/button/README.md b/src/button/README.md index 27cc220b7..602ca39db 100644 --- a/src/button/README.md +++ b/src/button/README.md @@ -111,8 +111,8 @@ app.use(Button); | text | Text | _string_ | - | | color | Color, support linear-gradient | _string_ | - | | icon | Left Icon | _string_ | - | -| icon-prefix `v2.6.0` | Icon className prefix | _string_ | `van-icon` | -| icon-position `v2.10.7` | Icon position, can be set to `right` | _string_ | `left` | +| icon-prefix | Icon className prefix | _string_ | `van-icon` | +| icon-position | Icon position, can be set to `right` | _string_ | `left` | | tag | HTML Tag | _string_ | `button` | | native-type | Native Type Attribute | _string_ | `button` | | plain | Whether to be plain button | _boolean_ | `false` | @@ -137,10 +137,10 @@ app.use(Button); ### Slots -| Name | Description | -| ----------------- | ------------------- | -| default | Default slot | -| loading `v2.10.1` | Custom loading icon | +| Name | Description | +| ------- | ------------------- | +| default | Default slot | +| loading | Custom loading icon | ### Less Variables diff --git a/src/button/README.zh-CN.md b/src/button/README.zh-CN.md index fb5a960e5..107a6a998 100644 --- a/src/button/README.zh-CN.md +++ b/src/button/README.zh-CN.md @@ -137,8 +137,8 @@ app.use(Button); | text | 按钮文字 | _string_ | - | | color | 按钮颜色,支持传入 `linear-gradient` 渐变色 | _string_ | - | | icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | _string_ | - | -| icon-prefix `v2.6.0` | 图标类名前缀,同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | -| icon-position `v2.10.7` | 图标展示位置,可选值为 `right` | _string_ | `left` | +| icon-prefix | 图标类名前缀,同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | +| icon-position | 图标展示位置,可选值为 `right` | _string_ | `left` | | tag | 按钮根节点的 HTML 标签 | _string_ | `button` | | native-type | 原生 button 标签的 type 属性 | _string_ | `button` | | block | 是否为块级元素 | _boolean_ | `false` | @@ -164,10 +164,10 @@ app.use(Button); ### Slots -| 名称 | 说明 | -| ----------------- | -------------- | -| default | 按钮内容 | -| loading `v2.10.1` | 自定义加载图标 | +| 名称 | 说明 | +| ------- | -------------- | +| default | 按钮内容 | +| loading | 自定义加载图标 | ### 样式变量 diff --git a/src/calendar/README.md b/src/calendar/README.md index efb0fd62e..15faa7689 100644 --- a/src/calendar/README.md +++ b/src/calendar/README.md @@ -247,7 +247,7 @@ Set `poppable` to `false`, the calendar will be displayed directly on the page i | Attribute | Description | Type | Default | | --- | --- | --- | --- | -| type `v2.5.4` | Type,can be set to `range` `multiple` | _string_ | `single` | +| type | Type,can be set to `range` `multiple` | _string_ | `single` | | title | Title of calendar | _string_ | `Calendar` | | color | Color for the bottom button and selected date | _string_ | `#ee0a24` | | min-date | Min date | _Date_ | Today | @@ -256,15 +256,15 @@ Set `poppable` to `false`, the calendar will be displayed directly on the page i | row-height | Row height | _number \| string_ | `64` | | formatter | Day formatter | _(day: Day) => Day_ | - | | poppable | Whether to show the calendar inside a popup | _boolean_ | `true` | -| lazy-render `v2.8.1` | Whether to enable lazy render | _boolean_ | `true` | +| lazy-render | Whether to enable lazy render | _boolean_ | `true` | | show-mark | Whether to show background month mark | _boolean_ | `true` | -| show-title `v2.5.5` | Whether to show title | _boolean_ | `true` | -| show-subtitle `v2.5.5` | Whether to show subtitle | _boolean_ | `true` | +| show-title | Whether to show title | _boolean_ | `true` | +| show-subtitle | Whether to show subtitle | _boolean_ | `true` | | show-confirm | Whether to show confirm button | _boolean_ | `true` | -| readonly `v2.10.5` | Whether to be readonly | _boolean_ | `false` | +| readonly | Whether to be readonly | _boolean_ | `false` | | confirm-text | Confirm button text | _string_ | `Confirm` | | confirm-disabled-text | Confirm button text when disabled | _string_ | `Confirm` | -| first-day-of-week `v2.9.2` | Set the start day of week | _0-6_ | `0` | +| first-day-of-week | Set the start day of week | _0-6_ | `0` | ### Poppable Props @@ -275,10 +275,10 @@ Following props are supported when the poppable is true | v-model:show | Whether to show calendar | _boolean_ | `false` | | position | Popup position, can be set to `top` `right` `left` | _string_ | `bottom` | | round | Whether to show round corner | _boolean_ | `true` | -| close-on-popstate `v2.4.4` | Whether to close when popstate | _boolean_ | `true` | +| close-on-popstate | Whether to close when popstate | _boolean_ | `true` | | close-on-click-overlay | Whether to close when overlay is clicked | _boolean_ | `true` | | safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` | -| teleport `v2.4.4` | Return the mount node for Calendar | _string \| Element_ | - | +| teleport | Return the mount node for Calendar | _string \| Element_ | - | ### Range Props @@ -286,9 +286,9 @@ Following props are supported when the type is range | Attribute | Description | Type | Default | | --- | --- | --- | --- | -| max-range `v2.4.3` | Number of selectable days | _number \| string_ | Unlimitied | -| range-prompt `v2.4.3` | Error message when exceeded max range | _string_ | `Choose no more than xx days` | -| allow-same-day `v2.5.6` | Whether the start and end time of the range is allowed on the same day | _boolean_ | `false` | +| max-range | Number of selectable days | _number \| string_ | Unlimitied | +| range-prompt | Error message when exceeded max range | _string_ | `Choose no more than xx days` | +| allow-same-day | Whether the start and end time of the range is allowed on the same day | _boolean_ | `false` | ### Multiple Props @@ -296,8 +296,8 @@ Following props are supported when the type is multiple | Attribute | Description | Type | Default | | --- | --- | --- | --- | -| max-range `v2.7.2` | Max count of selectable days | _number \| string_ | Unlimitied | -| range-prompt `v2.4.3` | Error message when exceeded max count | _string_ | `Choose no more than xx days` | +| max-range | Max count of selectable days | _number \| string_ | Unlimitied | +| range-prompt | Error message when exceeded max count | _string_ | `Choose no more than xx days` | ### Data Structure of Day @@ -316,12 +316,12 @@ Following props are supported when the type is multiple | --- | --- | --- | | select | Emitted when date is selected | _value: Date \| Date[]_ | | confirm | Emitted after date selection is complete,if `show-confirm` is `true`, it is Emitted after clicking the confirm button | _value: Date \| Date[]_ | -| open `v2.5.2` | Emitted when opening Popup | - | -| close `v2.5.2` | Emitted when closing Popup | - | -| opened `v2.5.2` | Emitted when Popup is opened | - | -| closed `v2.5.2` | Emitted when Popup is closed | - | -| unselect `v2.7.2` | Emitted when unselect date when type is multiple | _value: Date_ | -| month-show `v2.8.2` | Emitted when a month enters the visible area | _{ date: Date, title: string }_ | +| open | Emitted when opening Popup | - | +| close | Emitted when closing Popup | - | +| opened | Emitted when Popup is opened | - | +| closed | Emitted when Popup is closed | - | +| unselect | Emitted when unselect date when type is multiple | _value: Date_ | +| month-show | Emitted when a month enters the visible area | _{ date: Date, title: string }_ | ### Slots @@ -337,7 +337,7 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Calend | Name | Description | Attribute | Return value | | --- | --- | --- | --- | | reset | Reset selected date to default date | - | - | -| scrollToDate `v2.12.2` | Scroll to date | _date: Date_ | - | +| scrollToDate | Scroll to date | _date: Date_ | - | ### Less Variables diff --git a/src/calendar/README.zh-CN.md b/src/calendar/README.zh-CN.md index d9b61042c..5fb6e2437 100644 --- a/src/calendar/README.zh-CN.md +++ b/src/calendar/README.zh-CN.md @@ -251,7 +251,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| type `v2.5.4` | 选择类型:<br>`single`表示选择单个日期,<br>`multiple`表示选择多个日期,<br>`range`表示选择日期区间 | _string_ | `single` | +| type | 选择类型:<br>`single`表示选择单个日期,<br>`multiple`表示选择多个日期,<br>`range`表示选择日期区间 | _string_ | `single` | | title | 日历标题 | _string_ | `日期选择` | | color | 主题色,对底部按钮和选中日期生效 | _string_ | `#ee0a24` | | min-date | 可选择的最小日期 | _Date_ | 当前日期 | @@ -260,15 +260,15 @@ export default { | row-height | 日期行高 | _number \| string_ | `64` | | formatter | 日期格式化函数 | _(day: Day) => Day_ | - | | poppable | 是否以弹层的形式展示日历 | _boolean_ | `true` | -| lazy-render `v2.8.1` | 是否只渲染可视区域的内容 | _boolean_ | `true` | +| lazy-render | 是否只渲染可视区域的内容 | _boolean_ | `true` | | show-mark | 是否显示月份背景水印 | _boolean_ | `true` | -| show-title `v2.5.5` | 是否展示日历标题 | _boolean_ | `true` | -| show-subtitle `v2.5.5` | 是否展示日历副标题(年月) | _boolean_ | `true` | +| show-title | 是否展示日历标题 | _boolean_ | `true` | +| show-subtitle | 是否展示日历副标题(年月) | _boolean_ | `true` | | show-confirm | 是否展示确认按钮 | _boolean_ | `true` | -| readonly `v2.10.5` | 是否为只读状态,只读状态下不能选择日期 | _boolean_ | `false` | +| readonly | 是否为只读状态,只读状态下不能选择日期 | _boolean_ | `false` | | confirm-text | 确认按钮的文字 | _string_ | `确定` | | confirm-disabled-text | 确认按钮处于禁用状态时的文字 | _string_ | `确定` | -| first-day-of-week `v2.9.2` | 设置周起始日 | _0-6_ | `0` | +| first-day-of-week | 设置周起始日 | _0-6_ | `0` | ### Poppable Props @@ -279,10 +279,10 @@ export default { | v-model:show | 是否显示日历弹窗 | _boolean_ | `false` | | position | 弹出位置,可选值为 `top` `right` `left` | _string_ | `bottom` | | round | 是否显示圆角弹窗 | _boolean_ | `true` | -| close-on-popstate `v2.4.4` | 是否在页面回退时自动关闭 | _boolean_ | `true` | +| close-on-popstate | 是否在页面回退时自动关闭 | _boolean_ | `true` | | close-on-click-overlay | 是否在点击遮罩层后关闭 | _boolean_ | `true` | | safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `true` | -| teleport `v2.4.4` | 指定挂载的节点,[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| Element_ | - | +| teleport | 指定挂载的节点,[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| Element_ | - | ### Range Props @@ -290,9 +290,9 @@ export default { | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| max-range `v2.4.3` | 日期区间最多可选天数 | _number \| string_ | 无限制 | -| range-prompt `v2.4.3` | 范围选择超过最多可选天数时的提示文案 | _string_ | `选择天数不能超过 xx 天` | -| allow-same-day `v2.5.6` | 是否允许日期范围的起止时间为同一天 | _boolean_ | `false` | +| max-range | 日期区间最多可选天数 | _number \| string_ | 无限制 | +| range-prompt | 范围选择超过最多可选天数时的提示文案 | _string_ | `选择天数不能超过 xx 天` | +| allow-same-day | 是否允许日期范围的起止时间为同一天 | _boolean_ | `false` | ### Multiple Props @@ -300,8 +300,8 @@ export default { | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| max-range `v2.7.2` | 日期最多可选天数 | _number \| string_ | 无限制 | -| range-prompt `v2.4.3` | 选择超过最多可选天数时的提示文案 | _string_ | `选择天数不能超过 xx 天` | +| max-range | 日期最多可选天数 | _number \| string_ | 无限制 | +| range-prompt | 选择超过最多可选天数时的提示文案 | _string_ | `选择天数不能超过 xx 天` | ### Day 数据结构 @@ -322,12 +322,12 @@ export default { | --- | --- | --- | | select | 点击并选中任意日期时触发 | _value: Date \| Date[]_ | | confirm | 日期选择完成后触发,若 `show-confirm` 为 `true`,则点击确认按钮后触发 | _value: Date \| Date[]_ | -| open `v2.5.2` | 打开弹出层时触发 | - | -| close `v2.5.2` | 关闭弹出层时触发 | - | -| opened `v2.5.2` | 打开弹出层且动画结束后触发 | - | -| closed `v2.5.2` | 关闭弹出层且动画结束后触发 | - | -| unselect `v2.7.2` | 当日历组件的 `type` 为 `multiple` 时,取消选中日期时触发 | _value: Date_ | -| month-show `v2.8.2` | 当某个月份进入可视区域时触发 | _{ date: Date, title: string }_ | +| open | 打开弹出层时触发 | - | +| close | 关闭弹出层时触发 | - | +| opened | 打开弹出层且动画结束后触发 | - | +| closed | 关闭弹出层且动画结束后触发 | - | +| unselect | 当日历组件的 `type` 为 `multiple` 时,取消选中日期时触发 | _value: Date_ | +| month-show | 当某个月份进入可视区域时触发 | _{ date: Date, title: string }_ | ### Slots @@ -340,10 +340,10 @@ export default { 通过 ref 可以获取到 Calendar 实例并调用实例方法,详见[组件实例方法](#/zh-CN/advanced-usage#zu-jian-shi-li-fang-fa)。 -| 方法名 | 说明 | 参数 | 返回值 | -| ---------------------- | ---------------------- | ------------ | ------ | -| reset | 重置选中的日期到默认值 | - | - | -| scrollToDate `v2.12.2` | 滚动到某个日期 | _date: Date_ | - | +| 方法名 | 说明 | 参数 | 返回值 | +| ------------ | ---------------------- | ------------ | ------ | +| reset | 重置选中的日期到默认值 | - | - | +| scrollToDate | 滚动到某个日期 | _date: Date_ | - | ### 样式变量 diff --git a/src/cell/README.md b/src/cell/README.md index aefcedff0..ffc45cf41 100644 --- a/src/cell/README.md +++ b/src/cell/README.md @@ -137,7 +137,7 @@ app.use(CellGroup); | label | Description below the title | _string_ | - | | size | Size,can be set to `large` | _string_ | - | | icon | Left Icon | _string_ | - | -| icon-prefix `v2.5.3` | Icon className prefix | _string_ | `van-icon` | +| icon-prefix | Icon className prefix | _string_ | `van-icon` | | border | Whether to show inner border | _boolean_ | `true` | | center | Whether to center content vertically | _boolean_ | `true` | | url | Link URL | _string_ | - | diff --git a/src/cell/README.zh-CN.md b/src/cell/README.zh-CN.md index a313b0775..408396d3c 100644 --- a/src/cell/README.zh-CN.md +++ b/src/cell/README.zh-CN.md @@ -144,7 +144,7 @@ app.use(CellGroup); | label | 标题下方的描述信息 | _string_ | - | | size | 单元格大小,可选值为 `large` | _string_ | - | | icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | _string_ | - | -| icon-prefix `v2.5.3` | 图标类名前缀,同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | +| icon-prefix | 图标类名前缀,同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | | url | 点击后跳转的链接地址 | _string_ | - | | to | 点击后跳转的目标路由对象,同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | _string \| object_ | - | | border | 是否显示内边框 | _boolean_ | `true` | diff --git a/src/checkbox/README.md b/src/checkbox/README.md index 8e99de63b..5595b5bf6 100644 --- a/src/checkbox/README.md +++ b/src/checkbox/README.md @@ -258,7 +258,7 @@ export default { | v-model | Names of all checked checkboxes | _any[]_ | - | | disabled | Whether to disable all checkboxes | _boolean_ | `false` | | max | Maximum amount of checked options | _number \| string_ | `0`(Unlimited) | -| direction `v2.5.0` | Direction, can be set to `horizontal` | _string_ | `vertical` | +| direction | Direction, can be set to `horizontal` | _string_ | `vertical` | | icon-size | Icon size of all checkboxes | _number \| string_ | `20px` | | checked-color | Checked color of all checkboxes | _string_ | `#1989fa` | - | diff --git a/src/checkbox/README.zh-CN.md b/src/checkbox/README.zh-CN.md index b08966cc0..1a9941aec 100644 --- a/src/checkbox/README.zh-CN.md +++ b/src/checkbox/README.zh-CN.md @@ -280,7 +280,7 @@ export default { | v-model | 所有选中项的标识符 | _any[]_ | - | | disabled | 是否禁用所有复选框 | _boolean_ | `false` | | max | 最大可选数,`0`为无限制 | _number \| string_ | `0` | -| direction `v2.5.0` | 排列方向,可选值为 `horizontal` | _string_ | `vertical` | +| direction | 排列方向,可选值为 `horizontal` | _string_ | `vertical` | | icon-size | 所有复选框的图标大小,默认单位为 `px` | _number \| string_ | `20px` | | checked-color | 所有复选框的选中状态颜色 | _string_ | `#1989fa` | diff --git a/src/collapse/README.md b/src/collapse/README.md index 60c0e7bc8..c7b7a0cc5 100644 --- a/src/collapse/README.md +++ b/src/collapse/README.md @@ -149,9 +149,9 @@ export default { Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get CollapseItem instance and call instance methods. -| Name | Description | Attribute | Return value | -| --- | --- | --- | --- | -| toggle `v2.10.9` | Toggle expanded status | _expanded: boolean_ | - | +| Name | Description | Attribute | Return value | +| ------ | ---------------------- | ------------------- | ------------ | +| toggle | Toggle expanded status | _expanded: boolean_ | - | ### Less Variables diff --git a/src/collapse/README.zh-CN.md b/src/collapse/README.zh-CN.md index 2577a52b0..7f6572272 100644 --- a/src/collapse/README.zh-CN.md +++ b/src/collapse/README.zh-CN.md @@ -153,7 +153,7 @@ export default { | 方法名 | 说明 | 参数 | 返回值 | | --- | --- | --- | --- | -| toggle `v2.10.9` | 切换面试展开状态,传 `true` 为展开,`false` 为收起,不传参为切换 | _expand?: boolean_ | - | +| toggle | 切换面试展开状态,传 `true` 为展开,`false` 为收起,不传参为切换 | _expand?: boolean_ | - | ### 样式变量 diff --git a/src/contact-edit/README.md b/src/contact-edit/README.md index ab5af0535..7409cd7d2 100644 --- a/src/contact-edit/README.md +++ b/src/contact-edit/README.md @@ -59,8 +59,8 @@ export default { | 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_ | - | -| show-set-default `v2.3.0` | Whether to show default contact switch | _boolean_ | `false` | -| set-default-label `v2.3.0` | default contact switch label | _string_ | - | +| show-set-default | Whether to show default contact switch | _boolean_ | `false` | +| set-default-label | default contact switch label | _string_ | - | ### Events diff --git a/src/contact-edit/README.zh-CN.md b/src/contact-edit/README.zh-CN.md index d12da3454..0116ca0ae 100644 --- a/src/contact-edit/README.zh-CN.md +++ b/src/contact-edit/README.zh-CN.md @@ -63,8 +63,8 @@ export default { | is-saving | 是否显示保存按钮加载动画 | _boolean_ | `false` | | is-deleting | 是否显示删除按钮加载动画 | _boolean_ | `false` | | tel-validator | 手机号格式校验函数 | _(tel: string) => boolean_ | - | -| show-set-default `v2.3.0` | 是否显示默认联系人栏 | _boolean_ | `false` | -| set-default-label `v2.3.0` | 默认联系人栏文案 | _string_ | - | +| show-set-default | 是否显示默认联系人栏 | _boolean_ | `false` | +| set-default-label | 默认联系人栏文案 | _string_ | - | ### Events diff --git a/src/contact-list/README.md b/src/contact-list/README.md index 85f73b585..1f8889e20 100644 --- a/src/contact-list/README.md +++ b/src/contact-list/README.md @@ -77,7 +77,7 @@ export default { | 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_ | - | +| default-tag-text | Default tag text | _string_ | - | ### Events diff --git a/src/contact-list/README.zh-CN.md b/src/contact-list/README.zh-CN.md index 9e0161285..dc6e1044d 100644 --- a/src/contact-list/README.zh-CN.md +++ b/src/contact-list/README.zh-CN.md @@ -76,12 +76,12 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| v-model | 当前选中联系人的 id | _number \| string_ | - | -| list | 联系人列表 | _Contact[]_ | `[]` | -| add-text | 新建按钮文案 | _string_ | `新建联系人` | -| default-tag-text `v2.3.0` | 默认联系人标签文案 | _string_ | - | +| 参数 | 说明 | 类型 | 默认值 | +| ---------------- | ------------------- | ------------------ | ------------ | +| v-model | 当前选中联系人的 id | _number \| string_ | - | +| list | 联系人列表 | _Contact[]_ | `[]` | +| add-text | 新建按钮文案 | _string_ | `新建联系人` | +| default-tag-text | 默认联系人标签文案 | _string_ | - | ### Events diff --git a/src/count-down/README.md b/src/count-down/README.md index 8c4ca9997..3ebdad90e 100644 --- a/src/count-down/README.md +++ b/src/count-down/README.md @@ -145,10 +145,10 @@ export default { ### Events -| Event | Description | Arguments | -| --- | --- | --- | -| finish | Emitted when count down finished | - | -| change `v2.4.4` | Emitted when count down changed | _currentTime: CurrentTime_ | +| Event | Description | Arguments | +| ------ | -------------------------------- | -------------------------- | +| finish | Emitted when count down finished | - | +| change | Emitted when count down changed | _currentTime: CurrentTime_ | ### Slots diff --git a/src/count-down/README.zh-CN.md b/src/count-down/README.zh-CN.md index a0b8d3c1b..4bd6c586b 100644 --- a/src/count-down/README.zh-CN.md +++ b/src/count-down/README.zh-CN.md @@ -159,10 +159,10 @@ export default { ### Events -| 事件名 | 说明 | 回调参数 | -| --------------- | ---------------- | -------------------------- | -| finish | 倒计时结束时触发 | - | -| change `v2.4.4` | 倒计时变化时触发 | _currentTime: CurrentTime_ | +| 事件名 | 说明 | 回调参数 | +| ------ | ---------------- | -------------------------- | +| finish | 倒计时结束时触发 | - | +| change | 倒计时变化时触发 | _currentTime: CurrentTime_ | ### Slots diff --git a/src/coupon-list/README.md b/src/coupon-list/README.md index b73ecad38..96226f5f6 100644 --- a/src/coupon-list/README.md +++ b/src/coupon-list/README.md @@ -112,7 +112,7 @@ export default { | input-placeholder | Input placeholder | _string_ | `Coupon code` | | currency | Currency symbol | _string_ | `¥` | | empty-image | Placeholder image when list is empty | _string_ | `https://img.yzcdn.cn/vant/coupon-empty.png` | -| show-count `v2.3.0` | Whether to show coupon count in tab title | _boolean_ | `true` | +| show-count | Whether to show coupon count in tab title | _boolean_ | `true` | ### CouponList Events diff --git a/src/coupon-list/README.zh-CN.md b/src/coupon-list/README.zh-CN.md index d91f82bb3..2d23dfcfc 100644 --- a/src/coupon-list/README.zh-CN.md +++ b/src/coupon-list/README.zh-CN.md @@ -114,7 +114,7 @@ export default { | show-exchange-bar | 是否展示兑换栏 | _boolean_ | `true` | | currency | 货币符号 | _string_ | `¥` | | empty-image | 列表为空时的占位图 | _string_ | `https://img.yzcdn.cn/vant/coupon-empty.png` | -| show-count `v2.3.0` | 是否展示可用 / 不可用数量 | _boolean_ | `true` | +| show-count | 是否展示可用 / 不可用数量 | _boolean_ | `true` | ### CouponList Events diff --git a/src/datetime-picker/README.md b/src/datetime-picker/README.md index f6b78b3b0..7a3f7e738 100644 --- a/src/datetime-picker/README.md +++ b/src/datetime-picker/README.md @@ -283,11 +283,11 @@ export default { | cancel-button-text | Text of cancel button | _string_ | `Cancel` | | show-toolbar | Whether to show toolbar | _boolean_ | `true` | | loading | Whether to show loading prompt | _boolean_ | `false` | -| readonly `v2.10.5` | Whether to be readonly | _boolean_ | `false` | +| readonly | Whether to be readonly | _boolean_ | `false` | | filter | Option filter | _(type, vals) => vals_ | - | | formatter | Option text formatter | _(type, val) => val_ | - | -| columns-order `v2.9.2` | Array for ordering columns, where item can be set to<br> `year`, `month`, `day`, `hour` and `minute` | _string[]_ | - | -| item-height `v2.8.6` | Option height, supports `px` `vw` `vh` `rem` unit, default `px` | _number \| string_ | `44` | +| columns-order | Array for ordering columns, where item can be set to<br> `year`, `month`, `day`, `hour` and `minute` | _string[]_ | - | +| item-height | Option height, supports `px` `vw` `vh` `rem` unit, default `px` | _number \| string_ | `44` | | visible-item-count | Count of visible columns | _number \| string_ | `6` | | swipe-duration | Duration of the momentum animation,unit `ms` | _number \| string_ | `1000` | @@ -321,20 +321,20 @@ Following props are supported when the type is time ### Slots -| Name | Description | SlotProps | -| --- | --- | --- | -| default `v2.11.1` | Custom toolbar content | - | -| title `v2.11.1` | Custom title | - | -| confirm `v2.11.1` | Custom confirm button text | - | -| cancel `v2.11.1` | Custom cancel button text | - | -| option `v2.11.1` | Custom option content | _option: string \| object_ | -| columns-top `v2.11.1` | Custom content above columns | - | -| columns-bottom `v2.11.1` | Custom content below columns | - | +| Name | Description | SlotProps | +| -------------- | ---------------------------- | -------------------------- | +| default | Custom toolbar content | - | +| title | Custom title | - | +| confirm | Custom confirm button text | - | +| cancel | Custom cancel button text | - | +| option | Custom option content | _option: string \| object_ | +| columns-top | Custom content above columns | - | +| columns-bottom | Custom content below columns | - | ### Methods Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get DatetimePicker instance and call instance methods. -| Name | Description | Attribute | Return value | -| ------------------ | ------------------- | --------- | ------------ | -| getPicker `v2.5.3` | get Picker instance | - | - | +| Name | Description | Attribute | Return value | +| --------- | ------------------- | --------- | ------------ | +| getPicker | get Picker instance | - | - | diff --git a/src/datetime-picker/README.zh-CN.md b/src/datetime-picker/README.zh-CN.md index 2c4968485..345e7e046 100644 --- a/src/datetime-picker/README.zh-CN.md +++ b/src/datetime-picker/README.zh-CN.md @@ -292,11 +292,11 @@ export default { | cancel-button-text | 取消按钮文字 | _string_ | `取消` | | show-toolbar | 是否显示顶部栏 | _boolean_ | `true` | | loading | 是否显示加载状态 | _boolean_ | `false` | -| readonly `v2.10.5` | 是否为只读状态,只读状态下无法切换选项 | _boolean_ | `false` | +| readonly | 是否为只读状态,只读状态下无法切换选项 | _boolean_ | `false` | | filter | 选项过滤函数 | _(type, vals) => vals_ | - | | formatter | 选项格式化函数 | _(type, val) => val_ | - | -| columns-order `v2.9.2` | 自定义列排序数组, 子项可选值为<br> `year`、`month`、`day`、`hour`、`minute` | _string[]_ | - | -| item-height `v2.8.6` | 选项高度,支持 `px` `vw` `vh` `rem` 单位,默认 `px` | _number \| string_ | `44` | +| columns-order | 自定义列排序数组, 子项可选值为<br> `year`、`month`、`day`、`hour`、`minute` | _string[]_ | - | +| item-height | 选项高度,支持 `px` `vw` `vh` `rem` 单位,默认 `px` | _number \| string_ | `44` | | visible-item-count | 可见的选项个数 | _number \| string_ | `6` | | swipe-duration | 快速滑动时惯性滚动的时长,单位`ms` | _number \| string_ | `1000` | @@ -330,15 +330,15 @@ export default { ### Slots -| 名称 | 说明 | 参数 | -| --- | --- | --- | -| default `v2.11.1` | 自定义整个顶部栏的内容 | - | -| title `v2.11.1` | 自定义标题内容 | - | -| confirm `v2.11.1` | 自定义确认按钮内容 | - | -| cancel `v2.11.1` | 自定义取消按钮内容 | - | -| option `v2.11.1` | 自定义选项内容 | _option: string \| object_ | -| columns-top `v2.11.1` | 自定义选项上方内容 | - | -| columns-bottom `v2.11.1` | 自定义选项下方内容 | - | +| 名称 | 说明 | 参数 | +| -------------- | ---------------------- | -------------------------- | +| default | 自定义整个顶部栏的内容 | - | +| title | 自定义标题内容 | - | +| confirm | 自定义确认按钮内容 | - | +| cancel | 自定义取消按钮内容 | - | +| option | 自定义选项内容 | _option: string \| object_ | +| columns-top | 自定义选项上方内容 | - | +| columns-bottom | 自定义选项下方内容 | - | ### 方法 @@ -346,7 +346,7 @@ export default { | 方法名 | 说明 | 参数 | 返回值 | | --- | --- | --- | --- | -| getPicker `v2.5.3` | 获取 Picker 实例,用于调用 Picker 的[实例方法](#/zh-CN/picker#fang-fa) | - | - | +| getPicker | 获取 Picker 实例,用于调用 Picker 的[实例方法](#/zh-CN/picker#fang-fa) | - | - | ## 常见问题 diff --git a/src/dialog/README.md b/src/dialog/README.md index 5965a63e0..e4350b758 100644 --- a/src/dialog/README.md +++ b/src/dialog/README.md @@ -142,7 +142,7 @@ export default { | width | Dialog width | _number \| string_ | `320px` | | message | Message | _string_ | - | | messageAlign | Message text align,can be set to `left` `right` | _string_ | `center` | -| theme `v2.10.0` | theme style,can be set to `round` | _string_ | `default` | +| theme | theme style,can be set to `round` | _string_ | `default` | | className | Custom className | _any_ | - | | showConfirmButton | Whether to show confirm button | _boolean_ | `true` | | showCancelButton | Whether to show cancel button | _boolean_ | `false` | @@ -156,7 +156,7 @@ export default { | closeOnPopstate | Whether to close when popstate | _boolean_ | `true` | | closeOnClickOverlay | Whether to close when overlay is clicked | _boolean_ | `false` | | lockScroll | Whether to lock body scroll | _boolean_ | `true` | -| allowHtml `v2.8.7` | Whether to allow HTML rendering in message | _boolean_ | `false` | +| allowHtml | Whether to allow HTML rendering in message | _boolean_ | `false` | | beforeClose | Callback function before close | _(action) => boolean \| Promise_ | - | | transition | Transition, equivalent to `name` prop of [transtion](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | - | | teleport | Return the mount node for Dialog | _string \| Element_ | `body` | @@ -170,7 +170,7 @@ export default { | width | Width | _number \| string_ | `320px` | | message | Message | _string_ | - | | message-align | Message align,can be set to `left` `right` | _string_ | `center` | -| theme `v2.10.0` | theme style,can be set to `round-button` | _string_ | `default` | +| theme | theme style,can be set to `round-button` | _string_ | `default` | | show-confirm-button | Whether to show confirm button | _boolean_ | `true` | | show-cancel-button | Whether to show cancel button | _boolean_ | `false` | | cancel-button-text | Cancel button text | _string_ | `Cancel` | @@ -184,7 +184,7 @@ export default { | close-on-click-overlay | Whether to close when overlay is clicked | _boolean_ | `false` | | lazy-render | Whether to lazy render util appeared | _boolean_ | `true` | | lock-scroll | Whether to lock background scroll | _boolean_ | `true` | -| allow-html `v2.8.7` | Whether to allow HTML rendering in message | _boolean_ | `false` | +| allow-html | Whether to allow HTML rendering in message | _boolean_ | `false` | | before-close | Callback function before close | _(action) => boolean \| Promise_ | - | | transition | Transition, equivalent to `name` prop of [transtion](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | - | | teleport | Return the mount node for Dialog | _string \| Element_ | - | diff --git a/src/dialog/README.zh-CN.md b/src/dialog/README.zh-CN.md index c6f6d67c2..1343210b6 100644 --- a/src/dialog/README.zh-CN.md +++ b/src/dialog/README.zh-CN.md @@ -191,7 +191,7 @@ export default { | closeOnPopstate | 是否在页面回退时自动关闭 | _boolean_ | `true` | | closeOnClickOverlay | 是否在点击遮罩层后关闭弹窗 | _boolean_ | `false` | | lockScroll | 是否锁定背景滚动 | _boolean_ | `true` | -| allowHtml `v2.8.7` | 是否允许 message 内容中渲染 HTML | _boolean_ | `false` | +| allowHtml | 是否允许 message 内容中渲染 HTML | _boolean_ | `false` | | beforeClose | 关闭前的回调函数,返回 `false` 可阻止关闭,支持返回 Promise | _(action) => boolean \| Promise_ | - | | transition | 动画类名,等价于 [transtion](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的`name`属性 | _string_ | - | | teleport | 指定挂载的节点,[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| Element_ | `body` | @@ -221,7 +221,7 @@ export default { | close-on-click-overlay | 是否在点击遮罩层后关闭弹窗 | _boolean_ | `false` | | lazy-render | 是否在显示弹层时才渲染节点 | _boolean_ | `true` | | lock-scroll | 是否锁定背景滚动 | _boolean_ | `true` | -| allow-html `v2.8.7` | 是否允许 message 内容中渲染 HTML | _boolean_ | `false` | +| allow-html | 是否允许 message 内容中渲染 HTML | _boolean_ | `false` | | before-close | 关闭前的回调函数,返回 `false` 可阻止关闭,支持返回 Promise | _(action) => boolean \| Promise_ | - | | transition | 动画类名,等价于 [transtion](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的 `name` 属性 | _string_ | - | | teleport | 指定挂载的节点,[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| Element_ | - | diff --git a/src/dropdown-menu/README.md b/src/dropdown-menu/README.md index e73b092dc..471a96d6c 100644 --- a/src/dropdown-menu/README.md +++ b/src/dropdown-menu/README.md @@ -157,7 +157,7 @@ Use `active-color` prop to custom active color of the title and options. | title | Item title | _string_ | Text of selected option | | options | Options | _Option[]_ | `[]` | | disabled | Whether to disable dropdown item | _boolean_ | `false` | -| lazy-render `v2.8.5` | Whether to lazy render util opened | _boolean_ | `true` | +| lazy-render | Whether to lazy render util opened | _boolean_ | `true` | | title-class | Title class | _string_ | - | | teleport | Return the mount node for menu | _string \| Element_ | - | diff --git a/src/dropdown-menu/README.zh-CN.md b/src/dropdown-menu/README.zh-CN.md index 64189e5c2..eb34376b9 100644 --- a/src/dropdown-menu/README.zh-CN.md +++ b/src/dropdown-menu/README.zh-CN.md @@ -165,7 +165,7 @@ export default { | title | 菜单项标题 | _string_ | 当前选中项文字 | | options | 选项数组 | _Option[]_ | `[]` | | disabled | 是否禁用菜单 | _boolean_ | `false` | -| lazy-render `v2.8.5` | 是否在首次展开时才渲染菜单内容 | _boolean_ | `true` | +| lazy-render | 是否在首次展开时才渲染菜单内容 | _boolean_ | `true` | | title-class | 标题额外类名 | _string_ | - | | teleport | 指定挂载的节点,[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| Element_ | - | diff --git a/src/empty/README.md b/src/empty/README.md index a0a95d598..c1e3fce70 100644 --- a/src/empty/README.md +++ b/src/empty/README.md @@ -69,7 +69,7 @@ Use the image prop to display different placeholder images. | Attribute | Description | Type | Default | | --- | --- | --- | --- | | image | Image type,can be set to `error` `network` `search` or image URL | _string_ | `default` | -| image-size `v2.10.11` | Image size | _number \| string_ | - | +| image-size | Image size | _number \| string_ | - | | description | Desciption | _string_ | - | ### Slots diff --git a/src/empty/README.zh-CN.md b/src/empty/README.zh-CN.md index 2d8e958a6..350796a64 100644 --- a/src/empty/README.zh-CN.md +++ b/src/empty/README.zh-CN.md @@ -78,7 +78,7 @@ Empty 组件内置了多种占位图片类型,可以在不同业务场景下 | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | image | 图片类型,可选值为 `error` `network` `search`,支持传入图片 URL | _string_ | `default` | -| image-size `v2.10.11` | 图片大小,默认单位为 `px` | _number \| string_ | - | +| image-size | 图片大小,默认单位为 `px` | _number \| string_ | - | | description | 图片下方的描述文字 | _string_ | - | ### Slots diff --git a/src/field/README.md b/src/field/README.md index c37e4d16a..a407f7d6b 100644 --- a/src/field/README.md +++ b/src/field/README.md @@ -233,7 +233,7 @@ Use `input-align` prop to align the input value. | --- | --- | --- | --- | | v-model | Field value | _number \| string_ | - | | label | Field label | _string_ | - | -| name `v2.5.0` | Name | _string_ | - | +| name | Name | _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 | _number \| string_ | - | @@ -241,19 +241,19 @@ Use `input-align` prop to align the input value. | border | Whether to show inner border | _boolean_ | `true` | | disabled | Whether to disable field | _boolean_ | `false` | | readonly | Whether to be readonly | _boolean_ | `false` | -| colon `v2.7.2` | Whether to display colon after label | _boolean_ | `false` | +| colon | Whether to display colon after label | _boolean_ | `false` | | required | Whether to show required mark | _boolean_ | `false` | | center | Whether to center content vertically | _boolean_ | `true` | | clearable | Whether to be clearable | _boolean_ | `false` | -| clear-trigger `v2.9.1` | When to display the clear icon, `always` means to display the icon when value is not empty, `focus` means to display the icon when input is focused | _string_ | `focus` | +| clear-trigger | When to display the clear icon, `always` means to display the icon when value is not empty, `focus` means to display the icon when input is focused | _string_ | `focus` | | clickable | Whether to show click feedback when clicked | _boolean_ | `false` | | is-link | Whether to show link icon | _boolean_ | `false` | | autofocus | Whether to auto focus, unsupported in iOS | _boolean_ | `false` | | show-word-limit | Whether to show word limit, need to set the `maxlength` prop | _boolean_ | `false` | | error | Whether to show error info | _boolean_ | `false` | | error-message | Error message | _string_ | - | -| formatter `v2.4.2` | Input value formatter | _Function_ | - | -| format-trigger `v2.8.7` | When to format value,can be set to `onBlur` | _string_ | `onChange` | +| formatter | Input value formatter | _Function_ | - | +| format-trigger | When to format value,can be set to `onBlur` | _string_ | `onChange` | | arrow-direction | Can be set to `left` `up` `down` | _string_ | `right` | | label-class | Label className | _any_ | - | | label-width | Label width | _number \| string_ | `6.2em` | @@ -263,8 +263,8 @@ Use `input-align` prop to align the input value. | autosize | Textarea auto resize,can accpet an object,<br>e.g. { maxHeight: 100, minHeight: 50 } | _boolean \| object_ | `false` | | left-icon | Left side icon name | _string_ | - | | right-icon | Right side icon name | _string_ | - | -| icon-prefix `v2.5.3` | Icon className prefix | _string_ | `van-icon` | -| rules `v2.5.0` | Form validation rules | _Rule[]_ | - | +| icon-prefix | Icon className prefix | _string_ | `van-icon` | +| rules | Form validation rules | _Rule[]_ | - | | autocomplete `v3.0.3` | [autocomplete](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) attribute of native input element | _string_ | - | ### Events @@ -278,7 +278,7 @@ Field support all native events of input tag | blur | Emitted when input is blured | _event: Event_ | | clear | Emitted when the clear icon is clicked | _event: Event_ | | click | Emitted when component is clicked | _event: Event_ | -| click-input `v2.8.1` | Emitted when the input is clicked | _event: Event_ | +| click-input | Emitted when the input is clicked | _event: Event_ | | click-left-icon | Emitted when the left icon is clicked | _event: Event_ | | click-right-icon | Emitted when the right icon is clicked | _event: Event_ | @@ -293,14 +293,14 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Field ### Slots -| Name | Description | -| -------------- | --------------------------- | -| label | Custom label | -| input | Custom input | -| left-icon | Custom left icon | -| right-icon | Custom right icon | -| button | Insert button | -| extra `v2.8.2` | Custom content on the right | +| Name | Description | +| ---------- | --------------------------- | +| label | Custom label | +| input | Custom input | +| left-icon | Custom left icon | +| right-icon | Custom right icon | +| button | Insert button | +| extra | Custom content on the right | ### Less Variables diff --git a/src/field/README.zh-CN.md b/src/field/README.zh-CN.md index bf60eee62..090153bae 100644 --- a/src/field/README.zh-CN.md +++ b/src/field/README.zh-CN.md @@ -256,7 +256,7 @@ export default { | --- | --- | --- | --- | | v-model | 当前输入的值 | _number \| string_ | - | | label | 输入框左侧文本 | _string_ | - | -| name `v2.5.0` | 名称,提交表单的标识符 | _string_ | - | +| name | 名称,提交表单的标识符 | _string_ | - | | type | 输入框类型, 可选值为 `tel` `digit`<br>`number` `textarea` `password` 等 | _string_ | `text` | | size | 大小,可选值为 `large` | _string_ | - | | maxlength | 输入的最大字符数 | _number \| string_ | - | @@ -264,19 +264,19 @@ export default { | border | 是否显示内边框 | _boolean_ | `true` | | disabled | 是否禁用输入框 | _boolean_ | `false` | | readonly | 是否只读 | _boolean_ | `false` | -| colon `v2.7.2` | 是否在 label 后面添加冒号 | _boolean_ | `false` | +| colon | 是否在 label 后面添加冒号 | _boolean_ | `false` | | required | 是否显示表单必填星号 | _boolean_ | `false` | | center | 是否使内容垂直居中 | _boolean_ | `false` | | clearable | 是否启用清除图标,点击清除图标后会清空输入框 | _boolean_ | `false` | -| clear-trigger `v2.9.1` | 显示清除图标的时机,`always` 表示输入框不为空时展示,<br>`focus` 表示输入框聚焦且不为空时展示 | _string_ | `focus` | +| clear-trigger | 显示清除图标的时机,`always` 表示输入框不为空时展示,<br>`focus` 表示输入框聚焦且不为空时展示 | _string_ | `focus` | | clickable | 是否开启点击反馈 | _boolean_ | `false` | | is-link | 是否展示右侧箭头并开启点击反馈 | _boolean_ | `false` | | autofocus | 是否自动聚焦,iOS 系统不支持该属性 | _boolean_ | `false` | | show-word-limit | 是否显示字数统计,需要设置`maxlength`属性 | _boolean_ | `false` | | error | 是否将输入内容标红 | _boolean_ | `false` | | error-message | 底部错误提示文案,为空时不展示 | _string_ | - | -| formatter `v2.4.2` | 输入内容格式化函数 | _Function_ | - | -| format-trigger `v2.8.7` | 格式化函数触发的时机,可选值为 `onBlur` | _string_ | `onChange` | +| formatter | 输入内容格式化函数 | _Function_ | - | +| format-trigger | 格式化函数触发的时机,可选值为 `onBlur` | _string_ | `onChange` | | arrow-direction | 箭头方向,可选值为 `left` `up` `down` | _string_ | `right` | | label-class | 左侧文本额外类名 | _any_ | - | | label-width | 左侧文本宽度,默认单位为`px` | _number \| string_ | `6.2em` | @@ -286,22 +286,22 @@ export default { | autosize | 是否自适应内容高度,只对 textarea 有效,<br>可传入对象,如 { maxHeight: 100, minHeight: 50 },<br>单位为`px` | _boolean \| object_ | `false` | | left-icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | _string_ | - | | right-icon | 右侧[图标名称](#/zh-CN/icon)或图片链接 | _string_ | - | -| icon-prefix `v2.5.3` | 图标类名前缀,同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | -| rules `v2.5.0` | 表单校验规则,详见 [Form 组件](#/zh-CN/form#rule-shu-ju-jie-gou) | _Rule[]_ | - | +| icon-prefix | 图标类名前缀,同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | +| rules | 表单校验规则,详见 [Form 组件](#/zh-CN/form#rule-shu-ju-jie-gou) | _Rule[]_ | - | | autocomplete `v3.0.3` | input 标签原生的[自动完成属性](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) | _string_ | - | ### Events -| 事件 | 说明 | 回调参数 | -| -------------------- | -------------------- | ------------------------------ | -| update:model-value | 输入框内容变化时触发 | _value: string (当前输入的值)_ | -| focus | 输入框获得焦点时触发 | _event: Event_ | -| blur | 输入框失去焦点时触发 | _event: Event_ | -| clear | 点击清除按钮时触发 | _event: Event_ | -| click | 点击 Field 时触发 | _event: Event_ | -| click-input `v2.8.1` | 点击输入区域时触发 | _event: Event_ | -| click-left-icon | 点击左侧图标时触发 | _event: Event_ | -| click-right-icon | 点击右侧图标时触发 | _event: Event_ | +| 事件 | 说明 | 回调参数 | +| ------------------ | -------------------- | ------------------------------ | +| update:model-value | 输入框内容变化时触发 | _value: string (当前输入的值)_ | +| focus | 输入框获得焦点时触发 | _event: Event_ | +| blur | 输入框失去焦点时触发 | _event: Event_ | +| clear | 点击清除按钮时触发 | _event: Event_ | +| click | 点击 Field 时触发 | _event: Event_ | +| click-input | 点击输入区域时触发 | _event: Event_ | +| click-left-icon | 点击左侧图标时触发 | _event: Event_ | +| click-right-icon | 点击右侧图标时触发 | _event: Event_ | ### 方法 @@ -314,14 +314,14 @@ export default { ### Slots -| 名称 | 说明 | -| -------------- | ---------------------------------------------------------- | -| label | 自定义输入框 label 标签 | -| input | 自定义输入框,使用此插槽后,与输入框相关的属性和事件将失效 | -| left-icon | 自定义输入框头部图标 | -| right-icon | 自定义输入框尾部图标 | -| button | 自定义输入框尾部按钮 | -| extra `v2.8.2` | 自定义输入框最右侧的额外内容 | +| 名称 | 说明 | +| ---------- | ---------------------------------------------------------- | +| label | 自定义输入框 label 标签 | +| input | 自定义输入框,使用此插槽后,与输入框相关的属性和事件将失效 | +| left-icon | 自定义输入框头部图标 | +| right-icon | 自定义输入框尾部图标 | +| button | 自定义输入框尾部按钮 | +| extra | 自定义输入框最右侧的额外内容 | ### 样式变量 diff --git a/src/form/README.md b/src/form/README.md index 3098f7893..263062ad8 100644 --- a/src/form/README.md +++ b/src/form/README.md @@ -475,26 +475,26 @@ export default { | label-align | Field label align, can be set to `center` `right` | _string_ | `left` | | input-align | Field input align, can be set to `center` `right` | _string_ | `left` | | error-message-align | Error message align, can be set to `center` `right` | _string_ | `left` | -| validate-trigger `v2.5.2` | When to validate the form,can be set to `onChange`、`onSubmit` | _string_ | `onBlur` | +| validate-trigger | When to validate the form,can be set to `onChange`、`onSubmit` | _string_ | `onBlur` | | colon | Whether to display colon after label | _boolean_ | `false` | -| disabled `v2.12.2` | Whether to disable form | _boolean_ | `false` | -| readonly `v2.12.2` | Whether to be readonly | _boolean_ | `false` | +| disabled | Whether to disable form | _boolean_ | `false` | +| readonly | Whether to be readonly | _boolean_ | `false` | | validate-first | Whether to stop the validation when a rule fails | _boolean_ | `false` | -| scroll-to-error `v2.5.2` | Whether to scroll to the error field when validation failed | _boolean_ | `false` | -| show-error `v2.6.0` | Whether to highlight input when validation failed | _boolean_ | `true` | -| show-error-message `v2.5.8` | Whether to show error message when validation failed | _boolean_ | `true` | -| submit-on-enter `v2.8.3` | Whether to submit form on enter | _boolean_ | `true` | +| scroll-to-error | Whether to scroll to the error field when validation failed | _boolean_ | `false` | +| show-error | Whether to highlight input when validation failed | _boolean_ | `true` | +| show-error-message | Whether to show error message when validation failed | _boolean_ | `true` | +| submit-on-enter | Whether to submit form on enter | _boolean_ | `true` | ### Data Structure of Rule | Key | Description | Type | | --- | --- | --- | | required | Whether to be a required field | _boolean_ | -| message `v2.5.3` | Error message | _string \| (value, rule) => string_ | -| validator `v2.5.3` | Custom validator | _(value, rule) => boolean \| Promise_ | -| pattern `v2.5.3` | Regex pattern | _RegExp_ | -| trigger `v2.5.2` | When to validate the form,can be set to `onChange`、`onBlur` | _string_ | -| formatter `v2.5.3` | Format value before validate | _(value, rule) => any_ | +| message | Error message | _string \| (value, rule) => string_ | +| validator | Custom validator | _(value, rule) => boolean \| Promise_ | +| pattern | Regex pattern | _RegExp_ | +| trigger | When to validate the form,can be set to `onChange`、`onBlur` | _string_ | +| formatter | Format value before validate | _(value, rule) => any_ | ### validate-trigger @@ -520,7 +520,7 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Form i | submit | Submit form | - | - | | validate | Validate form | _name?: string \| string[]_ | _Promise_ | | resetValidation | Reset validation | _name?: string \| string[]_ | - | -| scrollToField `v2.8.3` | Scroll to field | _name: string, alignToTop: boolean_ | - | +| scrollToField | Scroll to field | _name: string, alignToTop: boolean_ | - | ### Slots diff --git a/src/form/README.zh-CN.md b/src/form/README.zh-CN.md index 9a5231783..8dfa92db7 100644 --- a/src/form/README.zh-CN.md +++ b/src/form/README.zh-CN.md @@ -508,15 +508,15 @@ export default { | label-align | 表单项 label 对齐方式,可选值为 `center` `right` | _string_ | `left` | | input-align | 输入框对齐方式,可选值为 `center` `right` | _string_ | `left` | | error-message-align | 错误提示文案对齐方式,可选值为 `center` `right` | _string_ | `left` | -| validate-trigger `v2.5.2` | 表单校验触发时机,可选值为 `onChange`、`onSubmit`,详见下表 | _string_ | `onBlur` | +| validate-trigger | 表单校验触发时机,可选值为 `onChange`、`onSubmit`,详见下表 | _string_ | `onBlur` | | colon | 是否在 label 后面添加冒号 | _boolean_ | `false` | -| disabled `v2.12.2` | 是否禁用表单中的所有输入框 | _boolean_ | `false` | -| readonly `v2.12.2` | 是否将表单中的所有输入框设置为只读 | _boolean_ | `false` | +| disabled | 是否禁用表单中的所有输入框 | _boolean_ | `false` | +| readonly | 是否将表单中的所有输入框设置为只读 | _boolean_ | `false` | | validate-first | 是否在某一项校验不通过时停止校验 | _boolean_ | `false` | -| scroll-to-error `v2.5.2` | 是否在提交表单且校验不通过时滚动至错误的表单项 | _boolean_ | `false` | -| show-error `v2.6.0` | 是否在校验不通过时标红输入框 | _boolean_ | `true` | -| show-error-message `v2.5.8` | 是否在校验不通过时在输入框下方展示错误提示 | _boolean_ | `true` | -| submit-on-enter `v2.8.3` | 是否在按下回车键时提交表单 | _boolean_ | `true` | +| scroll-to-error | 是否在提交表单且校验不通过时滚动至错误的表单项 | _boolean_ | `false` | +| show-error | 是否在校验不通过时标红输入框 | _boolean_ | `true` | +| show-error-message | 是否在校验不通过时在输入框下方展示错误提示 | _boolean_ | `true` | +| submit-on-enter | 是否在按下回车键时提交表单 | _boolean_ | `true` | > 表单项的 API 参见:[Field 组件](#/zh-CN/field#api) @@ -527,11 +527,11 @@ export default { | 键名 | 说明 | 类型 | | --- | --- | --- | | required | 是否为必选字段 | _boolean_ | -| message `v2.5.3` | 错误提示文案 | _string \| (value, rule) => string_ | -| validator `v2.5.3` | 通过函数进行校验 | _(value, rule) => boolean \| Promise_ | -| pattern `v2.5.3` | 通过正则表达式进行校验 | _RegExp_ | -| trigger `v2.5.2` | 本项规则的触发时机,可选值为 `onChange`、`onBlur` | _string_ | -| formatter `v2.5.3` | 格式化函数,将表单项的值转换后进行校验 | _(value, rule) => any_ | +| message | 错误提示文案 | _string \| (value, rule) => string_ | +| validator | 通过函数进行校验 | _(value, rule) => boolean \| Promise_ | +| pattern | 通过正则表达式进行校验 | _RegExp_ | +| trigger | 本项规则的触发时机,可选值为 `onChange`、`onBlur` | _string_ | +| formatter | 格式化函数,将表单项的值转换后进行校验 | _(value, rule) => any_ | ### validate-trigger 可选值 @@ -559,7 +559,7 @@ export default { | submit | 提交表单,与点击提交按钮的效果等价 | - | - | | validate | 验证表单,支持传入 `name` 来验证单个或部分表单项 | _name?: string \| string[]_ | _Promise_ | | resetValidation | 重置表单项的验证提示,支持传入 `name` 来重置单个或部分表单项 | _name?: string \| string[]_ | - | -| scrollToField `v2.8.3` | 滚动到对应表单项的位置,默认滚动到顶部,第二个参数传 false 可滚动至底部 | _name: string, alignToTop: boolean_ | - | +| scrollToField | 滚动到对应表单项的位置,默认滚动到顶部,第二个参数传 false 可滚动至底部 | _name: string, alignToTop: boolean_ | - | ### Slots diff --git a/src/grid/README.md b/src/grid/README.md index 41e3ef47c..2eb18f26e 100644 --- a/src/grid/README.md +++ b/src/grid/README.md @@ -105,7 +105,7 @@ app.use(GridItem); | 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` | -| direction `v2.8.2` | Content arrangement direction, can be set to `horizontal` | _string_ | `vertical` | +| direction | Content arrangement direction, can be set to `horizontal` | _string_ | `vertical` | ### GridItem Props @@ -113,9 +113,9 @@ app.use(GridItem); | --- | --- | --- | --- | | text | Text | _string_ | - | | icon | Icon name or URL | _string_ | - | -| icon-prefix `v2.5.3` | Icon className prefix | _string_ | `van-icon` | +| icon-prefix | Icon className prefix | _string_ | `van-icon` | | dot | Whether to show red dot | _boolean_ | `false` | -| badge `v2.5.6` | Content of the badge | _number \| string_ | - | +| badge | 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` | diff --git a/src/grid/README.zh-CN.md b/src/grid/README.zh-CN.md index bc554ab2b..933db1232 100644 --- a/src/grid/README.zh-CN.md +++ b/src/grid/README.zh-CN.md @@ -125,7 +125,7 @@ app.use(GridItem); | center | 是否将格子内容居中显示 | _boolean_ | `true` | | square | 是否将格子固定为正方形 | _boolean_ | `false` | | clickable | 是否开启格子点击反馈 | _boolean_ | `false` | -| direction `v2.8.2` | 格子内容排列的方向,可选值为 `horizontal` | _string_ | `vertical` | +| direction | 格子内容排列的方向,可选值为 `horizontal` | _string_ | `vertical` | ### GridItem Props @@ -133,9 +133,9 @@ app.use(GridItem); | --- | --- | --- | --- | | text | 文字 | _string_ | - | | icon | [图标名称](#/zh-CN/icon)或图片链接 | _string_ | - | -| icon-prefix `v2.5.3` | 图标类名前缀,同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | +| icon-prefix | 图标类名前缀,同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | | dot | 是否显示图标右上角小红点 | _boolean_ | `false` | -| badge `v2.5.6` | 图标右上角徽标的内容 | _number \| string_ | - | +| badge | 图标右上角徽标的内容 | _number \| string_ | - | | url | 点击后跳转的链接地址 | _string_ | - | | to | 点击后跳转的目标路由对象,同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | _string \| object_ | - | | replace | 是否在跳转时替换当前页面历史 | _boolean_ | `false` | diff --git a/src/icon/README.md b/src/icon/README.md index e0ef930d7..dc44aded4 100644 --- a/src/icon/README.md +++ b/src/icon/README.md @@ -85,15 +85,15 @@ import 'vant/lib/icon/local.css'; ### Props -| Attribute | Description | Type | Default | -| -------------- | ----------------------- | ------------------ | ---------- | -| name | Icon name or URL | _string_ | `''` | -| dot | Whether to show red dot | _boolean_ | `false` | -| badge `v2.5.6` | Content of the badge | _number \| string_ | `''` | -| color | Icon color | _string_ | `inherit` | -| size | Icon size | _number \| string_ | `inherit` | -| class-prefix | ClassName prefix | _string_ | `van-icon` | -| tag | HTML Tag | _string_ | `i` | +| Attribute | Description | Type | Default | +| ------------ | ----------------------- | ------------------ | ---------- | +| name | Icon name or URL | _string_ | `''` | +| dot | Whether to show red dot | _boolean_ | `false` | +| badge | Content of the badge | _number \| string_ | `''` | +| color | Icon color | _string_ | `inherit` | +| size | Icon size | _number \| string_ | `inherit` | +| class-prefix | ClassName prefix | _string_ | `van-icon` | +| tag | HTML Tag | _string_ | `i` | ### Events diff --git a/src/icon/README.zh-CN.md b/src/icon/README.zh-CN.md index 0da973c37..48916c11e 100644 --- a/src/icon/README.zh-CN.md +++ b/src/icon/README.zh-CN.md @@ -95,7 +95,7 @@ import 'vant/lib/icon/local.css'; | --- | --- | --- | --- | | name | 图标名称或图片链接 | _string_ | - | | dot | 是否显示图标右上角小红点 | _boolean_ | `false` | -| badge `v2.5.6` | 图标右上角徽标的内容 | _number \| string_ | - | +| badge | 图标右上角徽标的内容 | _number \| string_ | - | | color | 图标颜色 | _string_ | `inherit` | | size | 图标大小,如 `20px` `2em`,默认单位为`px` | _number \| string_ | `inherit` | | class-prefix | 类名前缀,用于使用自定义图标 | _string_ | `van-icon` | diff --git a/src/image-preview/README.md b/src/image-preview/README.md index 4056bfc7b..cc1de5508 100644 --- a/src/image-preview/README.md +++ b/src/image-preview/README.md @@ -136,9 +136,9 @@ export default { | className | Custom className | _any_ | - | | maxZoom | Max zoom | _number \| string_ | `3` | | minZoom | Min zoom | _number \| string_ | `1/3` | -| closeable `v2.5.0` | Whether to show close icon | _boolean_ | `false` | -| closeIcon `v2.5.0` | Close icon name | _string_ | `clear` | -| closeIconPosition `v2.5.0` | Close icon position,can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` | +| closeable | Whether to show close icon | _boolean_ | `false` | +| closeIcon | Close icon name | _string_ | `clear` | +| closeIconPosition | Close icon position,can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` | | teleport | Return the mount node for ImagePreview | _string \| Element_ | - | ### Props @@ -156,9 +156,9 @@ export default { | class-name | Custom className | _any_ | - | | max-zoom | Max zoom | _number \| string_ | `3` | | min-zoom | Min zoom | _number \| string_ | `1/3` | -| closeable `v2.5.0` | Whether to show close icon | _boolean_ | `false` | -| close-icon `v2.5.0` | Close icon name | _string_ | `clear` | -| close-icon-position `v2.5.0` | Close icon position,can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` | +| closeable | Whether to show close icon | _boolean_ | `false` | +| close-icon | Close icon name | _string_ | `clear` | +| close-icon-position | Close icon position,can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` | | teleport | Return the mount node for ImagePreview | _string \| Element_ | - | ### Events @@ -166,9 +166,9 @@ export default { | Event | Description | Parameters | | --- | --- | --- | | close | Emitted when closing ImagePreview | { index, url } | -| closed `v2.5.6` | Emitted when ImagePreview is closed | - | +| closed | Emitted when ImagePreview is closed | - | | change | Emitted when current image changed | index: index of current image | -| scale `v2.5.0` | Emitted when scaling current image | { index: index of current image, scale: scale of current image} | +| scale | Emitted when scaling current image | { index: index of current image, scale: scale of current image} | ### Methods diff --git a/src/image-preview/README.zh-CN.md b/src/image-preview/README.zh-CN.md index 7c6ffadf7..c565e4e9f 100644 --- a/src/image-preview/README.zh-CN.md +++ b/src/image-preview/README.zh-CN.md @@ -173,9 +173,9 @@ export default { | className | 自定义类名 | _any_ | - | | maxZoom | 手势缩放时,最大缩放比例 | _number \| string_ | `3` | | minZoom | 手势缩放时,最小缩放比例 | _number \| string_ | `1/3` | -| closeable `v2.5.0` | 是否显示关闭图标 | _boolean_ | `false` | -| closeIcon `v2.5.0` | 关闭图标名称或图片链接 | _string_ | `clear` | -| closeIconPosition `v2.5.0` | 关闭图标位置,可选值为`top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` | +| closeable | 是否显示关闭图标 | _boolean_ | `false` | +| closeIcon | 关闭图标名称或图片链接 | _string_ | `clear` | +| closeIconPosition | 关闭图标位置,可选值为`top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` | | teleport | 指定挂载的节点,[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| Element_ | - | ### Props @@ -195,9 +195,9 @@ export default { | class-name | 自定义类名 | _any_ | - | | max-zoom | 手势缩放时,最大缩放比例 | _number \| string_ | `3` | | min-zoom | 手势缩放时,最小缩放比例 | _number \| string_ | `1/3` | -| closeable `v2.5.0` | 是否显示关闭图标 | _boolean_ | `false` | -| close-icon `v2.5.0` | 关闭图标名称或图片链接 | _string_ | `clear` | -| close-icon-position `v2.5.0` | 关闭图标位置,可选值为`top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` | +| closeable | 是否显示关闭图标 | _boolean_ | `false` | +| close-icon | 关闭图标名称或图片链接 | _string_ | `clear` | +| close-icon-position | 关闭图标位置,可选值为`top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` | | teleport | 指定挂载的节点,[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| Element_ | - | ### Events @@ -207,9 +207,9 @@ export default { | 事件 | 说明 | 回调参数 | | --- | --- | --- | | close | 关闭时触发 | { index: 索引, url: 图片链接 } | -| closed `v2.5.6` | 关闭且且动画结束后触发 | - | +| closed | 关闭且且动画结束后触发 | - | | change | 切换当前图片时触发 | index: 当前图片的索引 | -| scale `v2.5.0` | 缩放当前图片时触发 | { index: 当前图片的索引, scale: 当前缩放的值 } | +| scale | 缩放当前图片时触发 | { index: 当前图片的索引, scale: 当前缩放的值 } | ### 方法 diff --git a/src/image/README.md b/src/image/README.md index 74431a2ca..8f58ae3b8 100644 --- a/src/image/README.md +++ b/src/image/README.md @@ -77,9 +77,9 @@ app.use(Lazyload); | lazy-load | Whether to enable lazy load,should register [Lazyload](#/en-US/lazyload) component | _boolean_ | `false` | | show-error | Whether to show error placeholder | _boolean_ | `true` | | show-loading | Whether to show loading placeholder | _boolean_ | `true` | -| error-icon `v2.4.2` | Error icon | _string_ | `photo-fail` | -| loading-icon `v2.4.2` | Loading icon | _string_ | `photo` | -| icon-prefix `v2.10.12` | Icon className prefix | _string_ | `van-icon` | +| error-icon | Error icon | _string_ | `photo-fail` | +| loading-icon | Loading icon | _string_ | `photo` | +| icon-prefix | Icon className prefix | _string_ | `van-icon` | ### fit optional value @@ -101,11 +101,11 @@ app.use(Lazyload); ### Slots -| Name | Description | -| ---------------- | ---------------------------------- | -| default `v2.9.0` | Custom the content below the image | -| loading | Custom loading placeholder | -| error | Custom error placeholder | +| Name | Description | +| ------- | ---------------------------------- | +| default | Custom the content below the image | +| loading | Custom loading placeholder | +| error | Custom error placeholder | ### Less Variables diff --git a/src/image/README.zh-CN.md b/src/image/README.zh-CN.md index ad4440c71..4cf0f3a60 100644 --- a/src/image/README.zh-CN.md +++ b/src/image/README.zh-CN.md @@ -109,9 +109,9 @@ app.use(Lazyload); | lazy-load | 是否开启图片懒加载,须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | _boolean_ | `false` | | show-error | 是否展示图片加载失败提示 | _boolean_ | `true` | | show-loading | 是否展示图片加载中提示 | _boolean_ | `true` | -| error-icon `v2.4.2` | 失败时提示的[图标名称](#/zh-CN/icon)或图片链接 | _string_ | `photo-fail` | -| loading-icon `v2.4.2` | 加载时提示的[图标名称](#/zh-CN/icon)或图片链接 | _string_ | `photo` | -| icon-prefix `v2.10.12` | 图标类名前缀,同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | +| error-icon | 失败时提示的[图标名称](#/zh-CN/icon)或图片链接 | _string_ | `photo-fail` | +| loading-icon | 加载时提示的[图标名称](#/zh-CN/icon)或图片链接 | _string_ | `photo` | +| icon-prefix | 图标类名前缀,同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | ### 图片填充模式 @@ -133,11 +133,11 @@ app.use(Lazyload); ### Slots -| 名称 | 说明 | -| ---------------- | -------------------------- | -| default `v2.9.0` | 自定义图片下方的内容 | -| loading | 自定义加载中的提示内容 | -| error | 自定义加载失败时的提示内容 | +| 名称 | 说明 | +| ------- | -------------------------- | +| default | 自定义图片下方的内容 | +| loading | 自定义加载中的提示内容 | +| error | 自定义加载失败时的提示内容 | ### 样式变量 diff --git a/src/index-bar/README.md b/src/index-bar/README.md index b26a5f932..30855d527 100644 --- a/src/index-bar/README.md +++ b/src/index-bar/README.md @@ -79,10 +79,10 @@ export default { ### IndexBar Events -| Event | Description | Arguments | -| --- | --- | --- | +| Event | Description | Arguments | +| ------ | --------------------------------- | ------------------------- | | select | Emitted when an index is selected | _index: number \| string_ | -| change `v2.10.10` | Emitted when active index changed | _index: number \| string_ | +| change | Emitted when active index changed | _index: number \| string_ | ### IndexAnchor Slots diff --git a/src/index-bar/README.zh-CN.md b/src/index-bar/README.zh-CN.md index 11982a717..970751e91 100644 --- a/src/index-bar/README.zh-CN.md +++ b/src/index-bar/README.zh-CN.md @@ -83,10 +83,10 @@ export default { ### IndexBar Events -| 事件名 | 说明 | 回调参数 | -| ----------------- | ---------------------------- | ------------------------- | -| select | 点击索引栏的字符时触发 | _index: number \| string_ | -| change `v2.10.10` | 当前高亮的索引字符变化时触发 | _index: number \| string_ | +| 事件名 | 说明 | 回调参数 | +| ------ | ---------------------------- | ------------------------- | +| select | 点击索引栏的字符时触发 | _index: number \| string_ | +| change | 当前高亮的索引字符变化时触发 | _index: number \| string_ | ### 方法 @@ -106,9 +106,9 @@ export default { 通过 ref 可以获取到 IndexBar 实例并调用实例方法,详见[组件实例方法](#/zh-CN/advanced-usage#zu-jian-shi-li-fang-fa)。 -| 方法名 | 说明 | 参数 | 返回值 | -| ------------------ | -------------- | ------------------------- | ------ | -| scrollTo `v2.12.2` | 滚动到指定锚点 | _index: number \| string_ | - | +| 方法名 | 说明 | 参数 | 返回值 | +| -------- | -------------- | ------------------------- | ------ | +| scrollTo | 滚动到指定锚点 | _index: number \| string_ | - | ### 样式变量 diff --git a/src/nav-bar/README.md b/src/nav-bar/README.md index 89f94c55d..d0d25c741 100644 --- a/src/nav-bar/README.md +++ b/src/nav-bar/README.md @@ -66,9 +66,9 @@ export default { | left-arrow | Whether to show left arrow | _boolean_ | `false` | | border | Whether to show bottom border | _boolean_ | `true` | | fixed | Whether to fixed top | _boolean_ | `false` | -| placeholder `v2.5.9` | Whether to generage a placeholder element when fixed | _boolean_ | `false` | +| placeholder | Whether to generage a placeholder element when fixed | _boolean_ | `false` | | z-index | Z-index | _number \| string_ | `1` | -| safe-area-inset-top `v2.10.13` | Whether to enable top safe area adaptation | _boolean_ | `false` | +| safe-area-inset-top | Whether to enable top safe area adaptation | _boolean_ | `false` | ### Slots diff --git a/src/nav-bar/README.zh-CN.md b/src/nav-bar/README.zh-CN.md index 0b33b60b7..6e0b3d90f 100644 --- a/src/nav-bar/README.zh-CN.md +++ b/src/nav-bar/README.zh-CN.md @@ -68,9 +68,9 @@ export default { | left-arrow | 是否显示左侧箭头 | _boolean_ | `false` | | border | 是否显示下边框 | _boolean_ | `true` | | fixed | 是否固定在顶部 | _boolean_ | `false` | -| placeholder `v2.5.9` | 固定在顶部时,是否在标签位置生成一个等高的占位元素 | _boolean_ | `false` | +| placeholder | 固定在顶部时,是否在标签位置生成一个等高的占位元素 | _boolean_ | `false` | | z-index | 导航栏 z-index | _number \| string_ | `1` | -| safe-area-inset-top `v2.10.13` | 是否开启[顶部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `false` | +| safe-area-inset-top | 是否开启[顶部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `false` | ### Slots diff --git a/src/notice-bar/README.md b/src/notice-bar/README.md index c23295c66..1779ce7db 100644 --- a/src/notice-bar/README.md +++ b/src/notice-bar/README.md @@ -95,11 +95,11 @@ app.use(NoticeBar); ### Events -| Event | Description | Arguments | -| --------------- | ---------------------------------- | -------------- | -| click | Emitted when NoticeBar is clicked | _event: Event_ | -| close | Emitted when NoticeBar is closed | _event: Event_ | -| replay `v2.6.2` | Emitted when NoticeBar is replayed | - | +| Event | Description | Arguments | +| ------ | ---------------------------------- | -------------- | +| click | Emitted when NoticeBar is clicked | _event: Event_ | +| close | Emitted when NoticeBar is closed | _event: Event_ | +| replay | Emitted when NoticeBar is replayed | - | ### Slots diff --git a/src/notice-bar/README.zh-CN.md b/src/notice-bar/README.zh-CN.md index 62ec8b317..7f49dc747 100644 --- a/src/notice-bar/README.zh-CN.md +++ b/src/notice-bar/README.zh-CN.md @@ -120,11 +120,11 @@ app.use(NoticeBar); ### Events -| 事件名 | 说明 | 回调参数 | -| --------------- | ---------------------------- | -------------- | -| click | 点击通知栏时触发 | _event: Event_ | -| close | 关闭通知栏时触发 | _event: Event_ | -| replay `v2.6.2` | 每当滚动栏重新开始滚动时触发 | - | +| 事件名 | 说明 | 回调参数 | +| ------ | ---------------------------- | -------------- | +| click | 点击通知栏时触发 | _event: Event_ | +| close | 关闭通知栏时触发 | _event: Event_ | +| replay | 每当滚动栏重新开始滚动时触发 | - | ### Slots diff --git a/src/number-keyboard/README.md b/src/number-keyboard/README.md index 7c61febf8..0a9e858e3 100644 --- a/src/number-keyboard/README.md +++ b/src/number-keyboard/README.md @@ -172,15 +172,15 @@ export default { | maxlength | Value maxlength | _number \| string_ | - | | transition | Whether to show transition animation | _boolean_ | `true` | | z-index | Keyboard z-index | _number \| string_ | `100` | -| extra-key `v2.8.2` | Content of bottom left key | _string \| string[]_ | `''` | +| extra-key | Content of bottom left key | _string \| string[]_ | `''` | | close-button-text | Close button text | _string_ | - | | delete-button-text | Delete button text | _string_ | Delete Icon | -| close-button-loading `v2.7.0` | Whether to show loading close button in custom theme | _boolean_ | `false` | -| show-delete-key `v2.5.9` | Whether to show delete button | _boolean_ | `true` | +| close-button-loading | Whether to show loading close button in custom theme | _boolean_ | `false` | +| show-delete-key | Whether to show delete button | _boolean_ | `true` | | hide-on-click-outside | Whether to hide keyboard when outside is clicked | _boolean_ | `true` | -| teleport `v2.10.0` | Return the mount node for NumberKeyboard | _string \| Element_ | - | +| teleport | Return the mount node for NumberKeyboard | _string \| Element_ | - | | safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` | -| random-key-order `v2.12.2` | Whether to shuffle the order of keys | _boolean_ | `false` | +| random-key-order | Whether to shuffle the order of keys | _boolean_ | `false` | ### Events diff --git a/src/number-keyboard/README.zh-CN.md b/src/number-keyboard/README.zh-CN.md index 60f42c56a..eb93b4604 100644 --- a/src/number-keyboard/README.zh-CN.md +++ b/src/number-keyboard/README.zh-CN.md @@ -131,9 +131,7 @@ export default { 通过 `random-key-order` 属性可以随机排序数字键盘,常用于安全等级较高的场景。 ```html -<van-cell @touchstart.stop="show = true"> - 弹出配置随机数字的键盘 -</van-cell> +<van-cell @touchstart.stop="show = true"> 弹出配置随机数字的键盘 </van-cell> <van-number-keyboard :show="show" random-key-order @@ -185,15 +183,15 @@ export default { | maxlength | 输入值最大长度 | _number \| string_ | - | | transition | 是否开启过场动画 | _boolean_ | `true` | | z-index | 键盘 z-index 层级 | _number \| string_ | `100` | -| extra-key `v2.8.2` | 底部额外按键的内容 | _string \| string[]_ | `''` | +| extra-key | 底部额外按键的内容 | _string \| string[]_ | `''` | | close-button-text | 关闭按钮文字,空则不展示 | _string_ | - | | delete-button-text | 删除按钮文字,空则展示删除图标 | _string_ | - | -| close-button-loading `v2.7.0` | 是否将关闭按钮设置为加载中状态,仅在 `theme="custom"` 时有效 | _boolean_ | `false` | -| show-delete-key `v2.5.9` | 是否展示删除图标 | _boolean_ | `true` | +| close-button-loading | 是否将关闭按钮设置为加载中状态,仅在 `theme="custom"` 时有效 | _boolean_ | `false` | +| show-delete-key | 是否展示删除图标 | _boolean_ | `true` | | hide-on-click-outside | 点击外部时是否收起键盘 | _boolean_ | `true` | -| teleport `v2.10.0` | 指定挂载的节点,[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| Element_ | - | +| teleport | 指定挂载的节点,[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| Element_ | - | | safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `true` | -| random-key-order `v2.12.2` | 是否将通过随机顺序展示按键 | _boolean_ | `false` | +| random-key-order | 是否将通过随机顺序展示按键 | _boolean_ | `false` | ### Events diff --git a/src/overlay/README.md b/src/overlay/README.md index c30c016dd..760e1a084 100644 --- a/src/overlay/README.md +++ b/src/overlay/README.md @@ -66,7 +66,7 @@ export default { | duration | Animation duration | _number \| string_ | `0.3` | | class-name | ClassName | _string_ | - | | custom-class | Custom style | _object_ | - | -| lock-scroll `v2.6.2` | Whether to lock background scroll | _boolean_ | `true` | +| lock-scroll | Whether to lock background scroll | _boolean_ | `true` | ### Events diff --git a/src/overlay/README.zh-CN.md b/src/overlay/README.zh-CN.md index 6f6f88598..1506a033a 100644 --- a/src/overlay/README.zh-CN.md +++ b/src/overlay/README.zh-CN.md @@ -72,7 +72,7 @@ export default { | duration | 动画时长,单位秒 | _number \| string_ | `0.3` | | class-name | 自定义类名 | _string_ | - | | custom-style | 自定义样式 | _object_ | - | -| lock-scroll `v2.6.2` | 是否锁定背景滚动,锁定时蒙层里的内容也将无法滚动 | _boolean_ | `true` | +| lock-scroll | 是否锁定背景滚动,锁定时蒙层里的内容也将无法滚动 | _boolean_ | `true` | ### Events diff --git a/src/pagination/README.md b/src/pagination/README.md index 83b92105f..feb23f6d3 100644 --- a/src/pagination/README.md +++ b/src/pagination/README.md @@ -86,9 +86,9 @@ export default { | Name | Description | SlotProps | | --- | --- | --- | -| page `v2.10.9` | Custom pagination item | _{ number: number, text: string, active: boolean }_ | -| prev-text `v2.10.9` | Custom prev text | `-` | -| next-text `v2.10.9` | Custom next text | `-` | +| page | Custom pagination item | _{ number: number, text: string, active: boolean }_ | +| prev-text | Custom prev text | `-` | +| next-text | Custom next text | `-` | ### Less Variables diff --git a/src/pagination/README.zh-CN.md b/src/pagination/README.zh-CN.md index 50f6072c9..0054131b7 100644 --- a/src/pagination/README.zh-CN.md +++ b/src/pagination/README.zh-CN.md @@ -94,9 +94,9 @@ export default { | 名称 | 描述 | 参数 | | --- | --- | --- | -| page `v2.10.9` | 自定义页码 | _{ number: number, text: string, active: boolean }_ | -| prev-text `v2.10.9` | 自定义上一页按钮文字 | `-` | -| next-text `v2.10.9` | 自定义下一页按钮文字 | `-` | +| page | 自定义页码 | _{ number: number, text: string, active: boolean }_ | +| prev-text | 自定义上一页按钮文字 | `-` | +| next-text | 自定义下一页按钮文字 | `-` | ### 样式变量 diff --git a/src/picker/README.md b/src/picker/README.md index 8c5e42fa7..b2c032c2e 100644 --- a/src/picker/README.md +++ b/src/picker/README.md @@ -332,7 +332,7 @@ export default { | show-toolbar | Whether to show toolbar | _boolean_ | `true` | | allow-html | Whether to allow HTML in option text | _boolean_ | `false` | | default-index | Default value index of single column picker | _number \| string_ | `0` | -| item-height `v2.8.6` | Option height, supports `px` `vw` `vh` `rem` unit, default `px` | _number \| string_ | `44` | +| item-height | Option height, supports `px` `vw` `vh` `rem` unit, default `px` | _number \| string_ | `44` | | visible-item-count | Count of visible columns | _number \| string_ | `6` | | swipe-duration | Duration of the momentum animation,unit `ms` | _number \| string_ | `1000` | @@ -348,24 +348,24 @@ Picker events will pass different parameters according to the columns are single ### Slots -| Name | Description | SlotProps | -| --- | --- | --- | -| default | Custom toolbar content | - | -| title | Custom title | - | -| confirm `v2.10.11` | Custom confirm button text | - | -| cancel `v2.10.11` | Custom cancel button text | - | -| option `v2.10.11` | Custom option content | _option: string \| object_ | -| columns-top | Custom content above columns | - | -| columns-bottom | Custom content below columns | - | +| Name | Description | SlotProps | +| -------------- | ---------------------------- | -------------------------- | +| default | Custom toolbar content | - | +| title | Custom title | - | +| confirm | Custom confirm button text | - | +| cancel | Custom cancel button text | - | +| option | Custom option content | _option: string \| object_ | +| columns-top | Custom content above columns | - | +| columns-bottom | Custom content below columns | - | ### Data Structure of Column -| Key | Description | Type | -| ----------------- | ------------------------- | ---------- | -| values | Value of column | _string[]_ | -| defaultIndex | Default value index | _number_ | -| className | ClassName for this column | _any_ | -| children `v2.4.5` | Cascade children | _Column_ | +| Key | Description | Type | +| ------------ | ------------------------- | ---------- | +| values | Value of column | _string[]_ | +| defaultIndex | Default value index | _number_ | +| className | ClassName for this column | _any_ | +| children | Cascade children | _Column_ | ### Methods @@ -383,7 +383,7 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Picker | setColumnIndex | Set current index of the column | columnIndex, optionIndex | - | | getColumnValues | Get columns data of the column | columnIndex | values | | setColumnValues | Set columns data of the column | columnIndex, values | - | -| confirm `v2.4.0` | Stop scrolling and emit confirm event | - | - | +| confirm | Stop scrolling and emit confirm event | - | - | ### Less Variables diff --git a/src/picker/README.zh-CN.md b/src/picker/README.zh-CN.md index bb424e006..813a82898 100644 --- a/src/picker/README.zh-CN.md +++ b/src/picker/README.zh-CN.md @@ -355,7 +355,7 @@ export default { | show-toolbar | 是否显示顶部栏 | _boolean_ | `true` | | allow-html | 是否允许选项内容中渲染 HTML | _boolean_ | `false` | | default-index | 单列选择时,默认选中项的索引 | _number \| string_ | `0` | -| item-height `v2.8.6` | 选项高度,支持 `px` `vw` `vh` `rem` 单位,默认 `px` | _number \| string_ | `44` | +| item-height | 选项高度,支持 `px` `vw` `vh` `rem` 单位,默认 `px` | _number \| string_ | `44` | | visible-item-count | 可见的选项个数 | _number \| string_ | `6` | | swipe-duration | 快速滑动时惯性滚动的时长,单位 `ms` | _number \| string_ | `1000` | @@ -371,26 +371,26 @@ export default { ### Slots -| 名称 | 说明 | 参数 | -| ------------------ | ---------------------- | -------------------------- | -| default | 自定义整个顶部栏的内容 | - | -| title | 自定义标题内容 | - | -| confirm `v2.10.11` | 自定义确认按钮内容 | - | -| cancel `v2.10.11` | 自定义取消按钮内容 | - | -| option `v2.10.11` | 自定义选项内容 | _option: string \| object_ | -| columns-top | 自定义选项上方内容 | - | -| columns-bottom | 自定义选项下方内容 | - | +| 名称 | 说明 | 参数 | +| -------------- | ---------------------- | -------------------------- | +| default | 自定义整个顶部栏的内容 | - | +| title | 自定义标题内容 | - | +| confirm | 自定义确认按钮内容 | - | +| cancel | 自定义取消按钮内容 | - | +| option | 自定义选项内容 | _option: string \| object_ | +| columns-top | 自定义选项上方内容 | - | +| columns-bottom | 自定义选项下方内容 | - | ### Column 数据结构 当传入多列数据时,`columns` 为一个对象数组,数组中的每一个对象配置每一列,每一列有以下 `key`: -| 键名 | 说明 | 类型 | -| ----------------- | -------------------------- | ---------- | -| values | 列中对应的备选值 | _string[]_ | -| defaultIndex | 初始选中项的索引,默认为 0 | _number_ | -| className | 为对应列添加额外的类名 | _any_ | -| children `v2.4.5` | 级联选项 | _Column_ | +| 键名 | 说明 | 类型 | +| ------------ | -------------------------- | ---------- | +| values | 列中对应的备选值 | _string[]_ | +| defaultIndex | 初始选中项的索引,默认为 0 | _number_ | +| className | 为对应列添加额外的类名 | _any_ | +| children | 级联选项 | _Column_ | ### 方法 @@ -408,7 +408,7 @@ export default { | setColumnIndex | 设置对应列选中项的索引 | columnIndex, optionIndex | - | | getColumnValues | 获取对应列中所有选项 | columnIndex | values | | setColumnValues | 设置对应列中所有选项 | columnIndex, values | - | -| confirm `v2.4.0` | 停止惯性滚动并触发 confirm 事件 | - | - | +| confirm | 停止惯性滚动并触发 confirm 事件 | - | - | ### 样式变量 diff --git a/src/popover/README.md b/src/popover/README.md index 5122f5cf4..0ca10cebb 100644 --- a/src/popover/README.md +++ b/src/popover/README.md @@ -211,7 +211,7 @@ export default { | actions | Actions | _Action[]_ | `[]` | | placement | Placement | _string_ | `bottom` | | theme | Theme,can be set to `dark` | _string_ | `light` | -| trigger `v2.11.1` | Trigger mode,can be set to `manual` | `click` | +| trigger | Trigger mode,can be set to `manual` | `click` | | offset | Distance to reference | _[number, number]_ | `[0, 8]` | | overlay | Whether to show overlay | _boolean_ | `false` | | close-on-click-action | Whether to close when clicking action | _boolean_ | `true` | diff --git a/src/popover/README.zh-CN.md b/src/popover/README.zh-CN.md index 500e03680..7c9f47c14 100644 --- a/src/popover/README.zh-CN.md +++ b/src/popover/README.zh-CN.md @@ -225,7 +225,7 @@ export default { | actions | 选项列表 | _Action[]_ | `[]` | | placement | 弹出位置 | _string_ | `bottom` | | theme | 主题风格,可选值为 `dark` | _string_ | `light` | -| trigger `v2.11.1` | 触发方式,可选值为 `manual` | `click` | +| trigger | 触发方式,可选值为 `manual` | `click` | | offset | 出现位置的偏移量 | _[number, number]_ | `[0, 8]` | | overlay | 是否显示遮罩层 | _boolean_ | `false` | | close-on-click-action | 是否在点击选项后关闭 | _boolean_ | `true` | diff --git a/src/popup/README.md b/src/popup/README.md index 2096dee0a..63b727f00 100644 --- a/src/popup/README.md +++ b/src/popup/README.md @@ -131,21 +131,21 @@ export default { | close-icon | Close icon name | _string_ | `cross` | | close-icon-position | Close Icon Position,can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` | | transition | Transition, equivalent to `name` prop of [transtion](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | - | -| transition-appear `v2.10.14` | Whether to apply transition on initial render | _boolean_ | `false` | +| transition-appear | Whether to apply transition on initial render | _boolean_ | `false` | | teleport | Return the mount node for Popup | _string \| Element_ | - | -| safe-area-inset-bottom `v2.2.1` | Whether to enable bottom safe area adaptation | _boolean_ | `false` | +| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `false` | ### Events -| Event | Description | Arguments | -| --- | --- | --- | -| click | Emitted when Popup is clicked | _event: Event_ | -| click-overlay | Emitted when overlay is clicked | - | -| click-close-icon `v2.11.0` | Emitted when close icon is clicked | _event: Event_ | -| open | Emitted when opening Popup | - | -| close | Emitted when closing Popup | - | -| opened | Emitted when Popup is opened | - | -| closed | Emitted when Popup is closed | - | +| Event | Description | Arguments | +| ---------------- | ---------------------------------- | -------------- | +| click | Emitted when Popup is clicked | _event: Event_ | +| click-overlay | Emitted when overlay is clicked | - | +| click-close-icon | Emitted when close icon is clicked | _event: Event_ | +| open | Emitted when opening Popup | - | +| close | Emitted when closing Popup | - | +| opened | Emitted when Popup is opened | - | +| closed | Emitted when Popup is closed | - | ### Less Variables diff --git a/src/popup/README.zh-CN.md b/src/popup/README.zh-CN.md index 52666b9a4..1fdb43ee7 100644 --- a/src/popup/README.zh-CN.md +++ b/src/popup/README.zh-CN.md @@ -141,21 +141,21 @@ export default { | close-icon | 关闭图标名称或图片链接 | _string_ | `cross` | | close-icon-position | 关闭图标位置,可选值为`top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` | | transition | 动画类名,等价于 [transtion](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的`name`属性 | _string_ | - | -| transition-appear `v2.10.14` | 是否在初始渲染时启用过渡动画 | _boolean_ | `false` | +| transition-appear | 是否在初始渲染时启用过渡动画 | _boolean_ | `false` | | teleport | 指定挂载的节点 | _string \| Element_ | - | | safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `false` | ### Events -| 事件名 | 说明 | 回调参数 | -| -------------------------- | -------------------------- | -------------- | -| click | 点击弹出层时触发 | _event: Event_ | -| click-overlay | 点击遮罩层时触发 | - | -| click-close-icon `v2.11.0` | 点击关闭图标时触发 | _event: Event_ | -| open | 打开弹出层时触发 | - | -| close | 关闭弹出层时触发 | - | -| opened | 打开弹出层且动画结束后触发 | - | -| closed | 关闭弹出层且动画结束后触发 | - | +| 事件名 | 说明 | 回调参数 | +| ---------------- | -------------------------- | -------------- | +| click | 点击弹出层时触发 | _event: Event_ | +| click-overlay | 点击遮罩层时触发 | - | +| click-close-icon | 点击关闭图标时触发 | _event: Event_ | +| open | 打开弹出层时触发 | - | +| close | 关闭弹出层时触发 | - | +| opened | 打开弹出层且动画结束后触发 | - | +| closed | 关闭弹出层且动画结束后触发 | - | ### 样式变量 diff --git a/src/pull-refresh/README.md b/src/pull-refresh/README.md index 310cb7bb5..825527e06 100644 --- a/src/pull-refresh/README.md +++ b/src/pull-refresh/README.md @@ -109,7 +109,7 @@ Use slots to custom tips. | success-text | Text to show when loading success | _string_ | - | | success-duration | Success text display duration(ms) | _number \| string_ | `500` | | animation-duration | Animation duration | _number \| string_ | `300` | -| head-height `v2.4.2` | Height of head | _number \| string_ | `50` | +| head-height | Height of head | _number \| string_ | `50` | | disabled | Whether to disable pull refresh | _boolean_ | `false` | ### Events diff --git a/src/pull-refresh/README.zh-CN.md b/src/pull-refresh/README.zh-CN.md index f12bd657f..c0430fee9 100644 --- a/src/pull-refresh/README.zh-CN.md +++ b/src/pull-refresh/README.zh-CN.md @@ -116,7 +116,7 @@ export default { | success-text | 刷新成功提示文案 | _string_ | - | | success-duration | 刷新成功提示展示时长(ms) | _number \| string_ | `500` | | animation-duration | 动画时长 | _number \| string_ | `300` | -| head-height `v2.4.2` | 顶部内容高度 | _number \| string_ | `50` | +| head-height | 顶部内容高度 | _number \| string_ | `50` | | disabled | 是否禁用下拉刷新 | _boolean_ | `false` | ### Events diff --git a/src/radio/README.md b/src/radio/README.md index 17413e457..8b889d25f 100644 --- a/src/radio/README.md +++ b/src/radio/README.md @@ -170,7 +170,7 @@ export default { | --- | --- | --- | --- | | v-model | Name of checked radio | _any_ | - | | disabled | Disable all radios | _boolean_ | `false` | -| direction `v2.5.0` | Direction, can be set to `horizontal` | _string_ | `vertical` | +| direction | Direction, can be set to `horizontal` | _string_ | `vertical` | | icon-size | Icon size of all radios | _number \| string_ | `20px` | | checked-color | Checked color of all radios | _string_ | `#1989fa` | - | diff --git a/src/radio/README.zh-CN.md b/src/radio/README.zh-CN.md index 18b3b7eed..89d546d38 100644 --- a/src/radio/README.zh-CN.md +++ b/src/radio/README.zh-CN.md @@ -188,7 +188,7 @@ export default { | --- | --- | --- | --- | | v-model | 当前选中项的标识符 | _any_ | - | | disabled | 是否禁用所有单选框 | _boolean_ | `false` | -| direction `v2.5.0` | 排列方向,可选值为`horizontal` | _string_ | `vertical` | +| direction | 排列方向,可选值为`horizontal` | _string_ | `vertical` | | icon-size | 所有单选框的图标大小,默认单位为`px` | _number \| string_ | `20px` | | checked-color | 所有单选框的选中状态颜色 | _string_ | `#1989fa` | diff --git a/src/rate/README.md b/src/rate/README.md index 30bb1d30c..b424d62c7 100644 --- a/src/rate/README.md +++ b/src/rate/README.md @@ -121,7 +121,7 @@ export default { | disabled-color | Disabled color | _string_ | `#c8c9cc` | | icon | Selected icon | _string_ | `star` | | void-icon | Void icon | _string_ | `star-o` | -| icon-prefix `v2.5.3` | Icon className prefix | _string_ | `van-icon` | +| icon-prefix | Icon className prefix | _string_ | `van-icon` | | allow-half | Whether to allow half star | _boolean_ | `false` | | readonly | Whether to be readonly | _boolean_ | `false` | | disabled | Whether to disable rate | _boolean_ | `false` | diff --git a/src/rate/README.zh-CN.md b/src/rate/README.zh-CN.md index 796808bce..1a0e99f04 100644 --- a/src/rate/README.zh-CN.md +++ b/src/rate/README.zh-CN.md @@ -125,7 +125,7 @@ export default { | disabled-color | 禁用时的颜色 | _string_ | `#c8c9cc` | | icon | 选中时的[图标名称](#/zh-CN/icon)或图片链接 | _string_ | `star` | | void-icon | 未选中时的[图标名称](#/zh-CN/icon)或图片链接 | _string_ | `star-o` | -| icon-prefix `v2.5.3` | 图标类名前缀,同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | +| icon-prefix | 图标类名前缀,同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | | allow-half | 是否允许半选 | _boolean_ | `false` | | readonly | 是否为只读状态 | _boolean_ | `false` | | disabled | 是否禁用评分 | _boolean_ | `false` | diff --git a/src/search/README.md b/src/search/README.md index bca28d860..7a4e1189c 100644 --- a/src/search/README.md +++ b/src/search/README.md @@ -122,7 +122,7 @@ Use `action` slot to custom right button, `cancel` event will no longer be Emitt | maxlength | Max length of value | _number \| string_ | - | | placeholder | Placeholder | _string_ | - | | clearable | Whether to be clearable | _boolean_ | `true` | -| clear-trigger `v2.9.1` | When to display the clear icon, `always` means to display the icon when value is not empty, `focus` means to display the icon when input is focused | _string_ | `focus` | +| clear-trigger | When to display the clear icon, `always` means to display the icon when value is not empty, `focus` means to display the icon when input is focused | _string_ | `focus` | | autofocus | Whether to auto focus, unsupported in iOS | _boolean_ | `false` | | show-action | Whether to show right action button | _boolean_ | `false` | | action-text | Text of action button | _boolean_ | `Cancel` | diff --git a/src/search/README.zh-CN.md b/src/search/README.zh-CN.md index f8181ce6e..115a9f9db 100644 --- a/src/search/README.zh-CN.md +++ b/src/search/README.zh-CN.md @@ -138,7 +138,7 @@ export default { | maxlength | 输入的最大字符数 | _number \| string_ | - | | placeholder | 占位提示文字 | _string_ | - | | clearable | 是否启用清除图标,点击清除图标后会清空输入框 | _boolean_ | `true` | -| clear-trigger `v2.9.1` | 显示清除图标的时机,`always` 表示输入框不为空时展示,<br>`focus` 表示输入框聚焦且不为空时展示 | _string_ | `focus` | +| clear-trigger | 显示清除图标的时机,`always` 表示输入框不为空时展示,<br>`focus` 表示输入框聚焦且不为空时展示 | _string_ | `focus` | | autofocus | 是否自动聚焦,iOS 系统不支持该属性 | _boolean_ | `false` | | show-action | 是否在搜索框右侧显示取消按钮 | _boolean_ | `false` | | action-text | 取消按钮文字 | _boolean_ | `取消` | diff --git a/src/share-sheet/README.md b/src/share-sheet/README.md index 4501caf9c..a4861988c 100644 --- a/src/share-sheet/README.md +++ b/src/share-sheet/README.md @@ -180,7 +180,7 @@ export default { | Key | Description | Type | | --- | --- | --- | | name | Option name | _string_ | -| description `v2.8.5` | Option description | _string_ | +| description | Option description | _string_ | | icon | Option icon,can be set to `wechat` `weibo` `qq` `link` `qrcode` `poster` `weapp-qrcode` or image URL | _string_ | | className | Option className is used to set the class props to the share item | _string_ | @@ -190,7 +190,7 @@ export default { | --- | --- | --- | | select | Emitted when an option is clicked | _option: Option, index: number_ | | cancel | Emitted when the cancel button is clicked | - | -| click-overlay `v2.9.1` | Emitted when overlay is clicked | - | +| click-overlay | Emitted when overlay is clicked | - | ### Slots diff --git a/src/share-sheet/README.zh-CN.md b/src/share-sheet/README.zh-CN.md index 714c3e89e..5e3b82a01 100644 --- a/src/share-sheet/README.zh-CN.md +++ b/src/share-sheet/README.zh-CN.md @@ -198,17 +198,17 @@ export default { | 键名 | 说明 | 类型 | | --- | --- | --- | | name | 分享渠道名称 | _string_ | -| description `v2.8.5` | 分享选项描述 | _string_ | +| description | 分享选项描述 | _string_ | | icon | 图标,可选值为 `wechat` `weibo` `qq` `link` `qrcode` `poster` `weapp-qrcode`,支持传入图片 URL | _string_ | | className | 分享选项类名 | _string_ | ### Events -| 事件名 | 说明 | 回调参数 | -| --- | --- | --- | -| select | 点击分享选项时触发 | _option: Option, index: number_ | -| cancel | 点击取消按钮时触发 | - | -| click-overlay `v2.9.1` | 点击遮罩层时触发 | - | +| 事件名 | 说明 | 回调参数 | +| ------------- | ------------------ | ------------------------------- | +| select | 点击分享选项时触发 | _option: Option, index: number_ | +| cancel | 点击取消按钮时触发 | - | +| click-overlay | 点击遮罩层时触发 | - | ### Slots diff --git a/src/sidebar/README.md b/src/sidebar/README.md index c176b1a3f..f0faf606d 100644 --- a/src/sidebar/README.md +++ b/src/sidebar/README.md @@ -103,7 +103,7 @@ export default { | --- | --- | --- | --- | | title | Content | _string_ | `''` | | dot | Whether to show red dot | _boolean_ | `false` | -| badge `v2.5.6` | Content of the badge | _number \| string_ | `''` | +| badge | Content of the badge | _number \| string_ | `''` | | disabled | Whether to be disabled | _boolean_ | `false` | | url | Link | _string_ | - | | to | Target route of the link, same as to of vue-router | _string \| object_ | - | @@ -117,9 +117,9 @@ export default { ### SidebarItem Slots -| Name | Description | -| --------------- | ----------------- | -| title `v2.10.8` | Custom item title | +| Name | Description | +| ----- | ----------------- | +| title | Custom item title | ### Less Variables diff --git a/src/sidebar/README.zh-CN.md b/src/sidebar/README.zh-CN.md index cedc07b1e..e36b37012 100644 --- a/src/sidebar/README.zh-CN.md +++ b/src/sidebar/README.zh-CN.md @@ -111,7 +111,7 @@ export default { | --- | --- | --- | --- | | title | 内容 | _string_ | `''` | | dot | 是否显示右上角小红点 | _boolean_ | `false` | -| badge `v2.5.6` | 图标右上角徽标的内容 | _number \| string_ | - | +| badge | 图标右上角徽标的内容 | _number \| string_ | - | | disabled | 是否禁用该项 | _boolean_ | `false` | | url | 点击后跳转的链接地址 | _string_ | - | | to | 点击后跳转的目标路由对象,同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | _string \| object_ | - | @@ -125,9 +125,9 @@ export default { ### SidebarItem Slots -| Name | Description | -| --------------- | ----------- | -| title `v2.10.8` | 自定义标题 | +| Name | Description | +| ----- | ----------- | +| title | 自定义标题 | ### 样式变量 diff --git a/src/skeleton/README.md b/src/skeleton/README.md index ee90f46f6..cacc893f2 100644 --- a/src/skeleton/README.md +++ b/src/skeleton/README.md @@ -62,7 +62,7 @@ export default { | avatar | Whether to show avatar placeholder | _boolean_ | `false` | | loading | Whether to show skeleton,pass `false` to show child component | _boolean_ | `true` | | animate | Whether to enable animation | _boolean_ | `true` | -| round `v2.8.5` | Whether to show round title and row | _boolean_ | `false` | +| round | Whether to show round title and row | _boolean_ | `false` | | title-width | Title width | _number \| string_ | `40%` | | avatar-size | Size of avatar placeholder | _number \| string_ | `32px` | | avatar-shape | Shape of avatar placeholder,can be set to `square` | _string_ | `round` | diff --git a/src/skeleton/README.zh-CN.md b/src/skeleton/README.zh-CN.md index 8e57da672..c35d19881 100644 --- a/src/skeleton/README.zh-CN.md +++ b/src/skeleton/README.zh-CN.md @@ -72,7 +72,7 @@ export default { | avatar | 是否显示头像占位图 | _boolean_ | `false` | | loading | 是否显示骨架屏,传 `false` 时会展示子组件内容 | _boolean_ | `true` | | animate | 是否开启动画 | _boolean_ | `true` | -| round `v2.8.5` | 是否将标题和段落显示为圆角风格 | _boolean_ | `false` | +| round | 是否将标题和段落显示为圆角风格 | _boolean_ | `false` | | title-width | 标题占位图宽度 | _number \| string_ | `40%` | | avatar-size | 头像占位图大小 | _number \| string_ | `32px` | | avatar-shape | 头像占位图形状,可选值为 `square` | _string_ | `round` | diff --git a/src/slider/README.md b/src/slider/README.md index 234d94b30..b56c305c5 100644 --- a/src/slider/README.md +++ b/src/slider/README.md @@ -155,7 +155,7 @@ export default { | min | Min value | _number \| string_ | `0` | | step | Step size | _number \| string_ | `1` | | bar-height | Height of bar | _number \| string_ | `2px` | -| button-size `v2.4.5` | Button size | _number \| string_ | `24px` | +| button-size | Button size | _number \| string_ | `24px` | | active-color | Active color of bar | _string_ | `#1989fa` | | inactive-color | Inactive color of bar | _string_ | `#e5e5e5` | | range | Whether to enable dual thumb mode | _boolean_ | `false` | diff --git a/src/slider/README.zh-CN.md b/src/slider/README.zh-CN.md index a8ba89029..b7cc42b81 100644 --- a/src/slider/README.zh-CN.md +++ b/src/slider/README.zh-CN.md @@ -161,7 +161,7 @@ export default { | min | 最小值 | _number \| string_ | `0` | | step | 步长 | _number \| string_ | `1` | | bar-height | 进度条高度,默认单位为`px` | _number \| string_ | `2px` | -| button-size `v2.4.5` | 滑块按钮大小,默认单位为`px` | _number \| string_ | `24px` | +| button-size | 滑块按钮大小,默认单位为`px` | _number \| string_ | `24px` | | active-color | 进度条激活态颜色 | _string_ | `#1989fa` | | inactive-color | 进度条非激活态颜色 | _string_ | `#e5e5e5` | | range | 是否开启双滑块模式 | _boolean_ | `false` | diff --git a/src/stepper/README.md b/src/stepper/README.md index 8378ddf43..cb8092725 100644 --- a/src/stepper/README.md +++ b/src/stepper/README.md @@ -126,8 +126,8 @@ export default { | input-width | Input width | _number \| string_ | `32px` | | button-size | Button size | _number \| string_ | `28px` | | decimal-length | Decimal length | _number \| string_ | - | -| theme `v2.8.2` | Theme, can be set to `round` | _string_ | - | -| placeholder `v2.8.6` | Input placeholder | _string_ | - | +| theme | Theme, can be set to `round` | _string_ | - | +| placeholder | Input placeholder | _string_ | - | | integer | Whether to allow only integers | _boolean_ | `false` | | disabled | Whether to disable value change | _boolean_ | `false` | | disable-plus | Whether to disable plus button | _boolean_ | `false` | @@ -137,8 +137,8 @@ export default { | show-plus | Whether to show plus button | _boolean_ | `true` | | show-minus | Whether to show minus button | _boolean_ | `true` | | show-input | Whether to show input | _boolean_ | `true` | -| long-press `v2.4.3` | Whether to allow long press | _boolean_ | `true` | -| allow-empty `v2.9.1` | Whether to allow the input to be empty | _boolean_ | `false` | +| long-press | Whether to allow long press | _boolean_ | `true` | +| allow-empty | Whether to allow the input to be empty | _boolean_ | `false` | ### Events diff --git a/src/stepper/README.zh-CN.md b/src/stepper/README.zh-CN.md index 2a15bbd55..b7b1839eb 100644 --- a/src/stepper/README.zh-CN.md +++ b/src/stepper/README.zh-CN.md @@ -150,8 +150,8 @@ export default { | input-width | 输入框宽度,默认单位为 `px` | _number \| string_ | `32px` | | button-size | 按钮大小以及输入框高度,默认单位为 `px` | _number \| string_ | `28px` | | decimal-length | 固定显示的小数位数 | _number \| string_ | - | -| theme `v2.8.2` | 样式风格,可选值为 `round` | _string_ | - | -| placeholder `v2.8.6` | 输入框占位提示文字 | _string_ | - | +| theme | 样式风格,可选值为 `round` | _string_ | - | +| placeholder | 输入框占位提示文字 | _string_ | - | | integer | 是否只允许输入整数 | _boolean_ | `false` | | disabled | 是否禁用步进器 | _boolean_ | `false` | | disable-plus | 是否禁用增加按钮 | _boolean_ | `false` | @@ -161,8 +161,8 @@ export default { | show-plus | 是否显示增加按钮 | _boolean_ | `true` | | show-minus | 是否显示减少按钮 | _boolean_ | `true` | | show-input | 是否显示输入框 | _boolean_ | `true` | -| long-press `v2.4.3` | 是否开启长按手势 | _boolean_ | `true` | -| allow-empty `v2.9.1` | 是否允许输入的值为空 | _boolean_ | `false` | +| long-press | 是否开启长按手势 | _boolean_ | `true` | +| allow-empty | 是否允许输入的值为空 | _boolean_ | `false` | ### Events diff --git a/src/steps/README.md b/src/steps/README.md index 56b97b1c3..85c425dd6 100644 --- a/src/steps/README.md +++ b/src/steps/README.md @@ -74,7 +74,7 @@ export default { | active | Active step | _number \| string_ | `0` | | direction | Can be set to `vertical` | _string_ | `horizontal` | | active-color | Active step color | _string_ | `#07c160` | -| inactive-color `v2.9.1` | Inactive step color | _string_ | `#969799` | +| inactive-color | Inactive step color | _string_ | `#969799` | | active-icon | Active icon name | _string_ | `checked` | | inactive-icon | Inactive icon name | _string_ | - | @@ -89,7 +89,7 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| click-step `v2.5.9` | Emitted when a step's title or icon is clicked | _index: number_ | +| click-step | Emitted when a step's title or icon is clicked | _index: number_ | ### Less Variables diff --git a/src/steps/README.zh-CN.md b/src/steps/README.zh-CN.md index 344c9ec73..c6ccfab49 100644 --- a/src/steps/README.zh-CN.md +++ b/src/steps/README.zh-CN.md @@ -84,7 +84,7 @@ export default { | active | 当前步骤 | _number \| string_ | `0` | | direction | 显示方向,可选值为 `vertical` | _string_ | `horizontal` | | active-color | 激活状态颜色 | _string_ | `#07c160` | -| inactive-color `v2.9.1` | 未激活状态颜色 | _string_ | `#969799` | +| inactive-color | 未激活状态颜色 | _string_ | `#969799` | | active-icon | 激活状态底部图标,可选值见 [Icon 组件](#/zh-CN/icon) | _string_ | `checked` | | inactive-icon | 未激活状态底部图标,可选值见 [Icon 组件](#/zh-CN/icon) | _string_ | - | @@ -97,9 +97,9 @@ export default { ### Steps Events -| 事件名 | 说明 | 回调参数 | -| ------------------- | -------------------------- | --------------- | -| click-step `v2.5.9` | 点击步骤的标题或图标时触发 | _index: number_ | +| 事件名 | 说明 | 回调参数 | +| ---------- | -------------------------- | --------------- | +| click-step | 点击步骤的标题或图标时触发 | _index: number_ | ### 样式变量 diff --git a/src/sticky/README.md b/src/sticky/README.md index 268e1f375..ecf138340 100644 --- a/src/sticky/README.md +++ b/src/sticky/README.md @@ -53,7 +53,7 @@ export default { | Attribute | Description | Type | Default | | --- | --- | --- | --- | -| offset-top `v2.8.7` | Offset top, supports `px` `vw` `vh` `rem` unit, default `px` | _number \| string_ | `0` | +| offset-top | Offset top, supports `px` `vw` `vh` `rem` unit, default `px` | _number \| string_ | `0` | | z-index | z-index when sticky | _number \| string_ | `99` | | container | Container DOM | _Element_ | - | diff --git a/src/sticky/README.zh-CN.md b/src/sticky/README.zh-CN.md index 9678abe16..031bb30bc 100644 --- a/src/sticky/README.zh-CN.md +++ b/src/sticky/README.zh-CN.md @@ -63,7 +63,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| offset-top `v2.8.7` | 吸顶时与顶部的距离,支持 `px` `vw` `vh` `rem` 单位,默认 `px` | _number \| string_ | `0` | +| offset-top | 吸顶时与顶部的距离,支持 `px` `vw` `vh` `rem` 单位,默认 `px` | _number \| string_ | `0` | | z-index | 吸顶时的 z-index | _number \| string_ | `99` | | container | 容器对应的 HTML 节点 | _Element_ | - | diff --git a/src/submit-bar/README.md b/src/submit-bar/README.md index c04ef8cb1..525d3827c 100644 --- a/src/submit-bar/README.md +++ b/src/submit-bar/README.md @@ -98,10 +98,10 @@ export default { | decimal-length | Price dicemal length | _number \| string_ | `2` | | label | Price left label | _string_ | `Total:` | | suffix-label | Price right label | _string_ | - | -| text-align `v2.3.0` | Price label text align can be set to `left` | _string_ | `right` | +| text-align | Price label text align can be set to `left` | _string_ | `right` | | button-text | Button text | _string_ | - | | button-type | Button type | _string_ | `danger` | -| button-color `v2.9.1` | Button color | _string_ | - | +| button-color | Button color | _string_ | - | | tip | Tip | _string_ | - | | tip-icon | Icon | _string_ | - | | currency | Currency symbol | _string_ | `¥` | @@ -117,12 +117,12 @@ export default { ### Slots -| Name | Description | -| ----------------- | ------------------- | -| default | Custom left content | -| button `v2.10.12` | Custom button | -| top | Custom top content | -| tip | Custom tips | +| Name | Description | +| ------- | ------------------- | +| default | Custom left content | +| button | Custom button | +| top | Custom top content | +| tip | Custom tips | ### Less Variables diff --git a/src/submit-bar/README.zh-CN.md b/src/submit-bar/README.zh-CN.md index a345a14e2..945a52d17 100644 --- a/src/submit-bar/README.zh-CN.md +++ b/src/submit-bar/README.zh-CN.md @@ -105,10 +105,10 @@ export default { | decimal-length | 价格小数点位数 | _number \| string_ | `2` | | label | 价格左侧文案 | _string_ | `合计:` | | suffix-label | 价格右侧文案 | _string_ | - | -| text-align `v2.3.0` | 价格文案对齐方向,可选值为 `left` | _string_ | `right` | +| text-align | 价格文案对齐方向,可选值为 `left` | _string_ | `right` | | button-text | 按钮文字 | _string_ | - | | button-type | 按钮类型 | _string_ | `danger` | -| button-color `v2.9.1` | 自定义按钮颜色 | _string_ | - | +| button-color | 自定义按钮颜色 | _string_ | - | | tip | 在订单栏上方的提示文案 | _string_ | - | | tip-icon | 提示文案左侧的[图标名称](#/zh-CN/icon)或图片链接 | _string_ | - | | currency | 货币符号 | _string_ | `¥` | @@ -124,12 +124,12 @@ export default { ### Slots -| 名称 | 说明 | -| ----------------- | -------------------- | -| default | 自定义订单栏左侧内容 | -| button `v2.10.12` | 自定义按钮 | -| top | 自定义订单栏上方内容 | -| tip | 提示文案中的额外内容 | +| 名称 | 说明 | +| ------- | -------------------- | +| default | 自定义订单栏左侧内容 | +| button | 自定义按钮 | +| top | 自定义订单栏上方内容 | +| tip | 提示文案中的额外内容 | ### 样式变量 diff --git a/src/swipe-cell/README.md b/src/swipe-cell/README.md index 75b9a76b8..e8466f9b4 100644 --- a/src/swipe-cell/README.md +++ b/src/swipe-cell/README.md @@ -104,7 +104,7 @@ export default { | name | Identifier of SwipeCell | _number \| string_ | - | | left-width | Width of the left swipe area | _number \| string_ | `auto` | | right-width | Width of the right swipe area | _number \| string_ | `auto` | -| before-close `v2.3.0` | Callback function before close | _(args) => boolean \| Promise_ | - | +| before-close | Callback function before close | _(args) => boolean \| Promise_ | - | | disabled | Whether to disabled swipe | _boolean_ | `false` | | stop-propagation | Whether to stop touchmove event propagation | _boolean_ | `false` | diff --git a/src/swipe/README.md b/src/swipe/README.md index 825cee28f..8cbe7dd84 100644 --- a/src/swipe/README.md +++ b/src/swipe/README.md @@ -166,7 +166,7 @@ export default { | vertical | Whether to be vertical Scrolling | _boolean_ | `false` | | touchable | Whether to allow swipe by touch gesture | _boolean_ | `true` | | stop-propagation | Whether to stop touchmove event propagation | _boolean_ | `false` | -| lazy-render `v2.5.8` | Whether to enable lazy render | _boolean_ | `false` | +| lazy-render | Whether to enable lazy render | _boolean_ | `false` | | indicator-color | Indicator color | _string_ | `#1989fa` | ### Swipe Events @@ -187,8 +187,8 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Swipe | Name | Description | Attribute | Return value | | --- | --- | --- | --- | -| prev `v2.4.2` | Swipe to prev item | - | - | -| next `v2.4.2` | Swipe to next item | - | - | +| prev | Swipe to prev item | - | - | +| next | Swipe to next item | - | - | | swipeTo | Swipe to target index | index: target index, options: Options | - | | resize | Resize Swipe when container element resized or visibility changed | - | - | diff --git a/src/swipe/README.zh-CN.md b/src/swipe/README.zh-CN.md index 655414281..365c61478 100644 --- a/src/swipe/README.zh-CN.md +++ b/src/swipe/README.zh-CN.md @@ -164,20 +164,20 @@ export default { ### Swipe Props -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| autoplay | 自动轮播间隔,单位为 ms | _number \| string_ | - | -| duration | 动画时长,单位为 ms | _number \| string_ | `500` | -| initial-swipe | 初始位置索引值 | _number \| string_ | `0` | -| width | 滑块宽度,单位为`px` | _number \| string_ | `auto` | -| height | 滑块高度,单位为`px` | _number \| string_ | `auto` | -| loop | 是否开启循环播放 | _boolean_ | `true` | -| show-indicators | 是否显示指示器 | _boolean_ | `true` | -| vertical | 是否为纵向滚动 | _boolean_ | `false` | -| touchable | 是否可以通过手势滑动 | _boolean_ | `true` | -| stop-propagation | 是否阻止滑动事件冒泡 | _boolean_ | `true` | -| lazy-render `v2.5.8` | 是否延迟渲染未展示的轮播 | _boolean_ | `false` | -| indicator-color | 指示器颜色 | _string_ | `#1989fa` | +| 参数 | 说明 | 类型 | 默认值 | +| ---------------- | ------------------------ | ------------------ | --------- | +| autoplay | 自动轮播间隔,单位为 ms | _number \| string_ | - | +| duration | 动画时长,单位为 ms | _number \| string_ | `500` | +| initial-swipe | 初始位置索引值 | _number \| string_ | `0` | +| width | 滑块宽度,单位为`px` | _number \| string_ | `auto` | +| height | 滑块高度,单位为`px` | _number \| string_ | `auto` | +| loop | 是否开启循环播放 | _boolean_ | `true` | +| show-indicators | 是否显示指示器 | _boolean_ | `true` | +| vertical | 是否为纵向滚动 | _boolean_ | `false` | +| touchable | 是否可以通过手势滑动 | _boolean_ | `true` | +| stop-propagation | 是否阻止滑动事件冒泡 | _boolean_ | `true` | +| lazy-render | 是否延迟渲染未展示的轮播 | _boolean_ | `false` | +| indicator-color | 指示器颜色 | _string_ | `#1989fa` | ### Swipe Events @@ -197,8 +197,8 @@ export default { | 方法名 | 说明 | 参数 | 返回值 | | --- | --- | --- | --- | -| prev `v2.4.2` | 切换到上一轮播 | - | - | -| next `v2.4.2` | 切换到下一轮播 | - | - | +| prev | 切换到上一轮播 | - | - | +| next | 切换到下一轮播 | - | - | | swipeTo | 切换到指定位置 | index: number, options: Options | - | | resize | 外层元素大小或组件显示状态变化时,可以调用此方法来触发重绘 | - | - | diff --git a/src/tab/README.md b/src/tab/README.md index be8281dcf..8dc4c63ad 100644 --- a/src/tab/README.md +++ b/src/tab/README.md @@ -247,12 +247,12 @@ export default { | sticky | Whether to use sticky mode | _boolean_ | `false` | | swipeable | Whether to switch tabs with swipe gestrue in the content | _boolean_ | `false` | | lazy-render | Whether to enable tab content lazy render | _boolean_ | `true` | -| scrollspy `v2.3.0` | Whether to use scrollspy mode | _boolean_ | `false` | -| offset-top `v2.8.7` | Sticky offset top , supports `px` `vw` `vh` `rem` unit, default `px` | _number \| string_ | `0` | +| scrollspy | Whether to use scrollspy mode | _boolean_ | `false` | +| offset-top | Sticky offset top , supports `px` `vw` `vh` `rem` unit, default `px` | _number \| string_ | `0` | | swipe-threshold | Set swipe tabs threshold | _number \| string_ | `5` | - | | title-active-color | Title active color | _string_ | - | | title-inactive-color | Title inactive color | _string_ | - | -| before-change `v2.9.3` | Callback function before changing tabs,return `false` to prevent change,support return Promise | _(name) => boolean \| Promise_ | - | +| before-change | Callback function before changing tabs,return `false` to prevent change,support return Promise | _(name) => boolean \| Promise_ | - | ### Tab Props @@ -260,8 +260,8 @@ export default { | --- | --- | --- | --- | | title | Title | _string_ | - | | disabled | Whether to disable tab | _boolean_ | `false` | -| dot `v2.3.0` | Whether to show red dot on the title | _boolean_ | `false` | -| badge `v2.5.6` | Content of the badge on the title | _number \| string_ | - | +| dot | Whether to show red dot on the title | _boolean_ | `false` | +| badge | Content of the badge on the title | _number \| string_ | - | | name | Identifier | _number \| string_ | Index of tab | | url | Link | _string_ | - | | to | Target route of the link, same as to of vue-router | _string \| object_ | - | @@ -276,7 +276,7 @@ export default { | click | Emitted when a tab is clicked | name,title | | change | Emitted when active tab changed | name,title | | disabled | Emitted when a disabled tab is clicked | name,title | -| rendered `v2.3.0` | Emitted when content first rendered in lazy-render mode | name,title | +| rendered | Emitted when content first rendered in lazy-render mode | name,title | | scroll | Emitted when tab scrolling in sticky mode | object: { scrollTop, isFixed } | ### Tabs Methods @@ -286,7 +286,7 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Tabs i | Name | Description | Attribute | Return value | | --- | --- | --- | --- | | resize | Resize Tabs when container element resized or visibility changed | - | - | -| scrollTo `v2.9.3` | Go to specified tab in scrollspy mode | name | - | +| scrollTo | Go to specified tab in scrollspy mode | name | - | ### Tabs Slots diff --git a/src/tab/README.zh-CN.md b/src/tab/README.zh-CN.md index 60c41d265..dc9c0851f 100644 --- a/src/tab/README.zh-CN.md +++ b/src/tab/README.zh-CN.md @@ -254,12 +254,12 @@ export default { | sticky | 是否使用粘性定位布局 | _boolean_ | `false` | | swipeable | 是否开启手势滑动切换 | _boolean_ | `false` | | lazy-render | 是否开启延迟渲染(首次切换到标签时才触发内容渲染) | _boolean_ | `true` | -| scrollspy `v2.3.0` | 是否开启滚动导航 | _boolean_ | `false` | -| offset-top `v2.8.7` | 粘性定位布局下与顶部的最小距离,支持 `px` `vw` `vh` `rem` 单位,默认 `px` | _number \| string_ | `0` | +| scrollspy | 是否开启滚动导航 | _boolean_ | `false` | +| offset-top | 粘性定位布局下与顶部的最小距离,支持 `px` `vw` `vh` `rem` 单位,默认 `px` | _number \| string_ | `0` | | swipe-threshold | 滚动阈值,标签数量超过阈值且总宽度超过标签栏宽度时开始横向滚动 | _number \| string_ | `5` | | title-active-color | 标题选中态颜色 | _string_ | - | | title-inactive-color | 标题默认态颜色 | _string_ | - | -| before-change `v2.9.3` | 切换标签前的回调函数,返回 `false` 可阻止切换,支持返回 Promise | _(name) => boolean \| Promise_ | - | +| before-change | 切换标签前的回调函数,返回 `false` 可阻止切换,支持返回 Promise | _(name) => boolean \| Promise_ | - | ### Tab Props @@ -267,8 +267,8 @@ export default { | --- | --- | --- | --- | | title | 标题 | _string_ | - | | disabled | 是否禁用标签 | _boolean_ | `false` | -| dot `v2.3.0` | 是否在标题右上角显示小红点 | _boolean_ | `false` | -| badge `v2.5.6` | 图标右上角徽标的内容 | _number \| string_ | - | +| dot | 是否在标题右上角显示小红点 | _boolean_ | `false` | +| badge | 图标右上角徽标的内容 | _number \| string_ | - | | name | 标签名称,作为匹配的标识符 | _number \| string_ | 标签的索引值 | | url | 点击后跳转的链接地址 | _string_ | - | | to | 点击后跳转的目标路由对象,同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | _string \| object_ | - | @@ -283,7 +283,7 @@ export default { | click | 点击标签时触发 | name:标识符,title:标题 | | change | 当前激活的标签改变时触发 | name:标识符,title:标题 | | disabled | 点击被禁用的标签时触发 | name:标识符,title:标题 | -| rendered `v2.3.0` | 标签内容首次渲染时触发(仅在开启延迟渲染后触发) | name:标识符,title:标题 | +| rendered | 标签内容首次渲染时触发(仅在开启延迟渲染后触发) | name:标识符,title:标题 | | scroll | 滚动时触发,仅在 sticky 模式下生效 | { scrollTop: 距离顶部位置, isFixed: 是否吸顶 } | ### Tabs 方法 @@ -293,7 +293,7 @@ export default { | 方法名 | 说明 | 参数 | 返回值 | | --- | --- | --- | --- | | resize | 外层元素大小或组件显示状态变化时,可以调用此方法来触发重绘 | - | - | -| scrollTo `v2.9.3` | 滚动到指定的标签页,在滚动导航模式下可用 | name: 标识符 | - | +| scrollTo | 滚动到指定的标签页,在滚动导航模式下可用 | name: 标识符 | - | ### Tabs Slots diff --git a/src/tabbar/README.md b/src/tabbar/README.md index 8fd2b286b..62de9c1b6 100644 --- a/src/tabbar/README.md +++ b/src/tabbar/README.md @@ -168,9 +168,9 @@ export default { | 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` | -| placeholder `v2.6.0` | Whether to generage a placeholder element when fixed | _boolean_ | `false` | +| placeholder | Whether to generage a placeholder element when fixed | _boolean_ | `false` | | safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `false` | -| before-change `v2.10.4` | Callback function before changing tabs,return `false` to prevent change,support return Promise | _(name) => boolean \| Promise_ | - | +| before-change | Callback function before changing tabs,return `false` to prevent change,support return Promise | _(name) => boolean \| Promise_ | - | ### Tabbar Events @@ -184,9 +184,9 @@ export default { | --- | --- | --- | --- | | name | Identifier | _number \| string_ | Item index | | icon | Icon name | _string_ | - | -| icon-prefix `v2.5.3` | Icon className prefix | _string_ | `van-icon` | +| icon-prefix | Icon className prefix | _string_ | `van-icon` | | dot | Whether to show red dot | _boolean_ | - | -| badge `v2.5.6` | Content of the badge | _number \| string_ | `''` | +| badge | 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` | diff --git a/src/tabbar/README.zh-CN.md b/src/tabbar/README.zh-CN.md index e2ee0b5fa..6f0c25b1a 100644 --- a/src/tabbar/README.zh-CN.md +++ b/src/tabbar/README.zh-CN.md @@ -176,9 +176,9 @@ export default { | active-color | 选中标签的颜色 | _string_ | `#1989fa` | | inactive-color | 未选中标签的颜色 | _string_ | `#7d7e80` | | route | 是否开启路由模式 | _boolean_ | `false` | -| placeholder `v2.6.0` | 固定在底部时,是否在标签位置生成一个等高的占位元素 | _boolean_ | `false` | +| placeholder | 固定在底部时,是否在标签位置生成一个等高的占位元素 | _boolean_ | `false` | | safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei),设置 fixed 时默认开启 | _boolean_ | `false` | -| before-change `v2.10.4` | 切换标签前的回调函数,返回 `false` 可阻止切换,支持返回 Promise | _(name) => boolean \| Promise_ | - | +| before-change | 切换标签前的回调函数,返回 `false` 可阻止切换,支持返回 Promise | _(name) => boolean \| Promise_ | - | ### Tabbar Events @@ -192,9 +192,9 @@ export default { | --- | --- | --- | --- | | name | 标签名称,作为匹配的标识符 | _number \| string_ | 当前标签的索引值 | | icon | [图标名称](#/zh-CN/icon)或图片链接 | _string_ | - | -| icon-prefix `v2.5.3` | 图标类名前缀,同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | +| icon-prefix | 图标类名前缀,同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | | dot | 是否显示图标右上角小红点 | _boolean_ | `false` | -| badge `v2.5.6` | 图标右上角徽标的内容 | _number \| string_ | - | +| badge | 图标右上角徽标的内容 | _number \| string_ | - | | url | 点击后跳转的链接地址 | _string_ | - | | to | 点击后跳转的目标路由对象,同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | _string \| object_ | - | | replace | 是否在跳转时替换当前页面历史 | _boolean_ | `false` | diff --git a/src/tree-select/README.md b/src/tree-select/README.md index 5b909faa0..f950324dd 100644 --- a/src/tree-select/README.md +++ b/src/tree-select/README.md @@ -173,7 +173,7 @@ export default { | main-active-index | The index of selected parent node | _number \| string_ | `0` | | active-id | Id of selected item | _number \| string \|<br>(number \| string)[]_ | `0` | | max | Maximum number of selected items | _number \| string_ | `Infinity` | -| selected-icon `v2.9.0` | Selected icon | _string_ | `success` | +| selected-icon | Selected icon | _string_ | `success` | ### Events diff --git a/src/tree-select/README.zh-CN.md b/src/tree-select/README.zh-CN.md index 06c544423..8a2cf4ac9 100644 --- a/src/tree-select/README.zh-CN.md +++ b/src/tree-select/README.zh-CN.md @@ -181,7 +181,7 @@ export default { | main-active-index | 左侧选中项的索引 | _number \| string_ | `0` | | active-id | 右侧选中项的 id,支持传入数组 | _number \| string \|<br>(number \| string)[]_ | `0` | | max | 右侧项最大选中个数 | _number \| string_ | `Infinity` | -| selected-icon `v2.9.0` | 自定义右侧栏选中状态的图标 | _string_ | `success` | +| selected-icon | 自定义右侧栏选中状态的图标 | _string_ | `success` | ### Events diff --git a/src/uploader/README.md b/src/uploader/README.md index a2251876d..72b711274 100644 --- a/src/uploader/README.md +++ b/src/uploader/README.md @@ -270,12 +270,12 @@ export default { | preview-size | Size of preview image | _number \| string_ | `80px` | | preview-image | Whether to show image preview | _boolean_ | `true` | | preview-full-image | Whethe to show full screen image preview when image is clicked | _boolean_ | `true` | -| preview-options `v2.9.3` | Options of full screen image preview,see [ImagePreview](#/en-US/image-preview) | _object_ | - | +| preview-options | Options of full screen image preview,see [ImagePreview](#/en-US/image-preview) | _object_ | - | | multiple | Whether to enable multiple selection pictures | _boolean_ | `false` | | disabled | Whether to disabled the upload | _boolean_ | `false` | | deletable | Whether to show delete icon | _boolean_ | `true` | -| show-upload `v2.5.6` | Whether to show upload area | _boolean_ | `true` | -| lazy-load `v2.6.2` | Whether to enable lazy load,should register [Lazyload](#/en-US/lazyload) component | _boolean_ | `false` | +| show-upload | Whether to show upload area | _boolean_ | `true` | +| lazy-load | Whether to enable lazy load,should register [Lazyload](#/en-US/lazyload) component | _boolean_ | `false` | | capture | Capture,can be set to `camera` | _string_ | - | | after-read | Hook after reading the file | _Function_ | - | | before-read | Hook before reading the file, return false to stop reading the file, can return Promise | _Function_ | - | @@ -285,7 +285,7 @@ export default { | result-type | Type of file read result, can be set to `file` `text` | _string_ | `dataUrl` | | upload-text | Upload text | _string_ | - | | image-fit | Preview image fit mode | _string_ | `cover` | -| upload-icon `v2.5.4` | Upload icon | _string_ | `photograph` | +| upload-icon | Upload icon | _string_ | `photograph` | ### Events @@ -301,7 +301,7 @@ export default { | Name | Description | SlotProps | | --- | --- | --- | | default | Custom icon | - | -| preview-cover `v2.9.1` | Custom content that covers the image preview | `item: FileListItem` | +| preview-cover | Custom content that covers the image preview | `item: FileListItem` | ### Parematers of before-read、after-read、before-delete @@ -325,7 +325,7 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Upload | Name | Description | Attribute | Return value | | --- | --- | --- | --- | | closeImagePreview | Close full screen image preview | - | - | -| chooseFile `v2.5.6` | Trigger choosing files, works with the user action context only because of browser security | - | - | +| chooseFile | Trigger choosing files, works with the user action context only because of browser security | - | - | ### Less Variables diff --git a/src/uploader/README.zh-CN.md b/src/uploader/README.zh-CN.md index e9a037006..0a23fca07 100644 --- a/src/uploader/README.zh-CN.md +++ b/src/uploader/README.zh-CN.md @@ -295,12 +295,12 @@ export default { | preview-size | 预览图和上传区域的尺寸,默认单位为 `px` | _number \| string_ | `80px` | | preview-image | 是否在上传完成后展示预览图 | _boolean_ | `true` | | preview-full-image | 是否在点击预览图后展示全屏图片预览 | _boolean_ | `true` | -| preview-options `v2.9.3` | 全屏图片预览的配置项,可选值见 [ImagePreview](#/zh-CN/image-preview) | _object_ | - | +| preview-options | 全屏图片预览的配置项,可选值见 [ImagePreview](#/zh-CN/image-preview) | _object_ | - | | multiple | 是否开启图片多选,部分安卓机型不支持 | _boolean_ | `false` | | disabled | 是否禁用文件上传 | _boolean_ | `false` | | deletable | 是否展示删除按钮 | _boolean_ | `true` | -| show-upload `v2.5.6` | 是否展示上传区域 | _boolean_ | `true` | -| lazy-load `v2.6.2` | 是否开启图片懒加载,须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | _boolean_ | `false` | +| show-upload | 是否展示上传区域 | _boolean_ | `true` | +| lazy-load | 是否开启图片懒加载,须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | _boolean_ | `false` | | capture | 图片选取模式,可选值为 `camera` (直接调起摄像头) | _string_ | - | | after-read | 文件读取完成后的回调函数 | _Function_ | - | | before-read | 文件读取前的回调函数,返回 `false` 可终止文件读取,<br>支持返回 `Promise` | _Function_ | - | @@ -310,7 +310,7 @@ export default { | result-type | 文件读取结果类型,可选值为 `file` `text` | _string_ | `dataUrl` | | upload-text | 上传区域文字提示 | _string_ | - | | image-fit | 预览图裁剪模式,可选值见 [Image](#/zh-CN/image) 组件 | _string_ | `cover` | -| upload-icon `v2.5.4` | 上传区域[图标名称](#/zh-CN/icon)或图片链接 | _string_ | `photograph` | +| upload-icon | 上传区域[图标名称](#/zh-CN/icon)或图片链接 | _string_ | `photograph` | ### Events @@ -323,10 +323,10 @@ export default { ### Slots -| 名称 | 说明 | 参数 | -| --- | --- | --- | -| default | 自定义上传区域 | - | -| preview-cover `v2.9.1` | 自定义覆盖在预览区域上方的内容 | _item: FileListItem_ | +| 名称 | 说明 | 参数 | +| ------------- | ------------------------------ | -------------------- | +| default | 自定义上传区域 | - | +| preview-cover | 自定义覆盖在预览区域上方的内容 | _item: FileListItem_ | ### 回调参数 @@ -354,7 +354,7 @@ before-read、after-read、before-delete 执行时会传递以下回调参数: | 方法名 | 说明 | 参数 | 返回值 | | --- | --- | --- | --- | | closeImagePreview | 关闭全屏的图片预览 | - | - | -| chooseFile `v2.5.6` | 主动调起文件选择,由于浏览器安全限制,只有在用户触发操作的上下文中调用才有效 | - | - | +| chooseFile | 主动调起文件选择,由于浏览器安全限制,只有在用户触发操作的上下文中调用才有效 | - | - | ### 样式变量