From e16239e42695ca64a15edad3775b7c161efe2eac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=99=88=E5=98=89=E6=B6=B5?= Date: Fri, 10 Jan 2020 21:06:05 +0800 Subject: [PATCH] docs: update version tag --- src/action-sheet/README.md | 32 +++++----- src/action-sheet/README.zh-CN.md | 32 +++++----- src/address-edit/README.md | 38 ++++++------ src/address-edit/README.zh-CN.md | 36 ++++++------ src/address-list/README.md | 18 +++--- src/address-list/README.zh-CN.md | 18 +++--- src/area/README.md | 28 ++++----- src/area/README.zh-CN.md | 28 ++++----- src/button/README.md | 42 +++++++------- src/button/README.zh-CN.md | 44 +++++++------- src/calendar/README.md | 40 ++++++------- src/calendar/README.zh-CN.md | 40 ++++++------- src/card/README.md | 26 ++++----- src/card/README.zh-CN.md | 26 ++++----- src/cell/README.md | 48 +++++++-------- src/cell/README.zh-CN.md | 48 +++++++-------- src/checkbox/README.md | 36 ++++++------ src/checkbox/README.zh-CN.md | 36 ++++++------ src/circle/README.md | 26 ++++----- src/circle/README.zh-CN.md | 26 ++++----- src/col/README.md | 24 ++++---- src/col/README.zh-CN.md | 24 ++++---- src/collapse/README.md | 38 ++++++------ src/collapse/README.zh-CN.md | 38 ++++++------ src/contact-card/README.md | 42 +++++++------- src/contact-card/README.zh-CN.md | 42 +++++++------- src/count-down/README.md | 12 ++-- src/count-down/README.zh-CN.md | 12 ++-- src/coupon-list/README.md | 52 ++++++++--------- src/coupon-list/README.zh-CN.md | 56 +++++++++--------- src/datetime-picker/README.md | 44 +++++++------- src/datetime-picker/README.zh-CN.md | 44 +++++++------- src/dialog/README.md | 90 ++++++++++++++--------------- src/dialog/README.zh-CN.md | 90 ++++++++++++++--------------- src/divider/README.md | 10 ++-- src/divider/README.zh-CN.md | 10 ++-- src/dropdown-menu/README.md | 34 +++++------ src/dropdown-menu/README.zh-CN.md | 34 +++++------ src/field/README.md | 58 +++++++++---------- src/field/README.zh-CN.md | 58 +++++++++---------- src/goods-action/README.md | 46 +++++++-------- src/goods-action/README.zh-CN.md | 44 +++++++------- src/grid/README.md | 36 ++++++------ src/grid/README.zh-CN.md | 36 ++++++------ src/icon/README.md | 18 +++--- src/icon/README.zh-CN.md | 18 +++--- src/image-preview/README.md | 60 +++++++++---------- src/image-preview/README.zh-CN.md | 60 +++++++++---------- src/image/README.md | 28 ++++----- src/image/README.zh-CN.md | 28 ++++----- src/index-bar/README.md | 20 +++---- src/index-bar/README.zh-CN.md | 20 +++---- src/lazyload/README.md | 20 +++---- src/lazyload/README.zh-CN.md | 20 +++---- src/list/README.md | 22 +++---- src/list/README.zh-CN.md | 22 +++---- src/loading/README.md | 14 ++--- src/loading/README.zh-CN.md | 14 ++--- src/nav-bar/README.md | 18 +++--- src/nav-bar/README.zh-CN.md | 18 +++--- src/notice-bar/README.md | 22 +++---- src/notice-bar/README.zh-CN.md | 22 +++---- src/notify/README.md | 22 +++---- src/notify/README.zh-CN.md | 22 +++---- src/number-keyboard/README.md | 30 +++++----- src/number-keyboard/README.zh-CN.md | 30 +++++----- src/overlay/README.md | 26 ++++----- src/overlay/README.zh-CN.md | 26 ++++----- src/pagination/README.md | 22 +++---- src/pagination/README.zh-CN.md | 22 +++---- src/panel/README.md | 12 ++-- src/panel/README.zh-CN.md | 12 ++-- src/password-input/README.md | 18 +++--- src/password-input/README.zh-CN.md | 18 +++--- src/picker/README.md | 56 +++++++++--------- src/picker/README.zh-CN.md | 56 +++++++++--------- src/popup/README.md | 38 ++++++------ src/popup/README.zh-CN.md | 38 ++++++------ src/progress/README.md | 22 +++---- src/progress/README.zh-CN.md | 22 +++---- src/pull-refresh/README.md | 22 +++---- src/pull-refresh/README.zh-CN.md | 22 +++---- src/radio/README.md | 30 +++++----- src/radio/README.zh-CN.md | 30 +++++----- src/rate/README.md | 30 +++++----- src/rate/README.zh-CN.md | 30 +++++----- src/search/README.md | 34 +++++------ src/search/README.zh-CN.md | 34 +++++------ src/sidebar/README.md | 24 ++++---- src/sidebar/README.zh-CN.md | 24 ++++---- src/skeleton/README.md | 22 +++---- src/skeleton/README.zh-CN.md | 22 +++---- src/sku/README.md | 52 ++++++++--------- src/sku/README.zh-CN.md | 64 ++++++++++---------- src/slider/README.md | 22 +++---- src/slider/README.zh-CN.md | 22 +++---- src/stepper/README.md | 38 ++++++------ src/stepper/README.zh-CN.md | 38 ++++++------ src/steps/README.md | 16 ++--- src/steps/README.zh-CN.md | 14 ++--- src/sticky/README.md | 10 ++-- src/sticky/README.zh-CN.md | 10 ++-- src/submit-bar/README.md | 30 +++++----- src/submit-bar/README.zh-CN.md | 30 +++++----- src/swipe-cell/README.md | 16 ++--- src/swipe-cell/README.zh-CN.md | 16 ++--- src/swipe/README.md | 58 +++++++++---------- src/swipe/README.zh-CN.md | 58 +++++++++---------- src/switch-cell/README.md | 26 ++++----- src/switch-cell/README.zh-CN.md | 26 ++++----- src/switch/README.md | 28 ++++----- src/switch/README.zh-CN.md | 28 ++++----- src/tab/README.md | 76 ++++++++++++------------ src/tab/README.zh-CN.md | 76 ++++++++++++------------ src/tabbar/README.md | 38 ++++++------ src/tabbar/README.zh-CN.md | 38 ++++++------ src/tag/README.md | 20 +++---- src/tag/README.zh-CN.md | 20 +++---- src/toast/README.md | 36 ++++++------ src/toast/README.zh-CN.md | 36 ++++++------ src/tree-select/README.md | 14 ++--- src/tree-select/README.zh-CN.md | 14 ++--- src/uploader/README.md | 38 ++++++------ src/uploader/README.zh-CN.md | 38 ++++++------ 124 files changed, 1974 insertions(+), 1974 deletions(-) diff --git a/src/action-sheet/README.md b/src/action-sheet/README.md index c989af957..42abdb169 100644 --- a/src/action-sheet/README.md +++ b/src/action-sheet/README.md @@ -112,22 +112,22 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| actions | Options | *Action[]* | `[]` | - | -| title | Title | *string* | - | - | -| cancel-text | Text of cancel button | *string* | - | - | -| description | Description above the options | *string* | - | 2.2.8 | -| overlay | Whether to show overlay | *boolean* | `true` | - | -| round | Whether to show round corner | *boolean* | `true` | 2.0.9 | -| close-icon | Close icon name | *string* | `close` | 2.2.13 | -| close-on-click-action | Whether to close when click action | *boolean* | `false` | - | -| close-on-click-overlay | Whether to close when click overlay | *boolean* | `true` | - | -| lazy-render | Whether to lazy render util appeared | *boolean* | `true` | - | -| lock-scroll | Whether to lock background scroll | *boolean* | `true` | - | -| duration | Transition duration, unit second | *number* | `0.3` | 2.0.3 | -| get-container | Return the mount node for action-sheet | *string \| () => Element* | - | - | -| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `true` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| actions | Options | *Action[]* | `[]` | +| title | Title | *string* | - | +| cancel-text | Text of cancel button | *string* | - | +| description `v2.2.8` | Description above the options | *string* | - | +| overlay | Whether to show overlay | *boolean* | `true` | +| round `v2.0.9` | Whether to show round corner | *boolean* | `true` | +| close-icon `v2.2.13` | Close icon name | *string* | `close` | +| close-on-click-action | Whether to close when click action | *boolean* | `false` | +| close-on-click-overlay | Whether to close when click overlay | *boolean* | `true` | +| lazy-render | Whether to lazy render util appeared | *boolean* | `true` | +| lock-scroll | Whether to lock background scroll | *boolean* | `true` | +| duration `v2.0.3` | Transition duration, unit second | *number* | `0.3` | +| get-container | Return the mount node for action-sheet | *string \| () => Element* | - | +| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `true` | ### Events diff --git a/src/action-sheet/README.zh-CN.md b/src/action-sheet/README.zh-CN.md index 4867f53a1..a56e22c55 100644 --- a/src/action-sheet/README.zh-CN.md +++ b/src/action-sheet/README.zh-CN.md @@ -122,22 +122,22 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| actions | 菜单选项 | *Action[]* | `[]` | - | -| title | 顶部标题 | *string* | - | - | -| cancel-text | 取消按钮文字 | *string* | - | - | -| description | 选项上方的描述信息 | *string* | - | 2.2.8 | -| overlay | 是否显示遮罩层 | *boolean* | `true` | - | -| round | 是否显示圆角 | *boolean* | `true` | 2.0.9 | -| close-icon | 关闭图标名称或图片链接 | *string* | `close` | 2.2.13 | -| close-on-click-action | 是否在点击选项后关闭 | *boolean* | `false` | - | -| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `true` | - | -| lazy-render | 是否在显示弹层时才渲染节点 | *boolean* | `true` | - | -| lock-scroll | 是否锁定背景滚动 | *boolean* | `true` | - | -| duration | 动画时长，单位秒 | *number* | `0.3` | 2.0.3 | -| get-container | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | - | - | -| safe-area-inset-bottom | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `true` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| actions | 菜单选项 | *Action[]* | `[]` | +| title | 顶部标题 | *string* | - | +| cancel-text | 取消按钮文字 | *string* | - | +| description `v2.2.8` | 选项上方的描述信息 | *string* | - | +| overlay | 是否显示遮罩层 | *boolean* | `true` | +| round `v2.0.9` | 是否显示圆角 | *boolean* | `true` | +| close-icon `v2.2.13` | 关闭图标名称或图片链接 | *string* | `close` | +| close-on-click-action | 是否在点击选项后关闭 | *boolean* | `false` | +| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `true` | +| lazy-render | 是否在显示弹层时才渲染节点 | *boolean* | `true` | +| lock-scroll | 是否锁定背景滚动 | *boolean* | `true` | +| duration `v2.0.3` | 动画时长，单位秒 | *number* | `0.3` | +| get-container | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | - | +| safe-area-inset-bottom | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `true` | ### Events diff --git a/src/address-edit/README.md b/src/address-edit/README.md index 19917dbba..95d23f88f 100644 --- a/src/address-edit/README.md +++ b/src/address-edit/README.md @@ -62,25 +62,25 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| area-list | Area List | *object* | - | - | -| area-columns-placeholder | placeholder of area columns | *string[]* | `[]` | 2.2.5 | -| address-info | Address Info | *AddressInfo* | `{}` | - | -| search-result | Address search result | *SearchResult[]* | `[]` | - | -| show-postal | Whether to show postal field | *boolean* | `false` | - | -| show-delete | Whether to show delete button | *boolean* | `false` | - | -| show-set-default | Whether to show default address switch | *boolean* | `false` | - | -| show-search-result | Whether to show address search result | *boolean* | `false` | - | -| save-button-text | Save button text | *string* | `Save` | - | -| delete-button-text | Delete button text | *string* | `Delete` | - | -| detail-rows | Detail input rows | *number* | `1` | - | -| detail-maxlength | Detail maxlength | *number* | `200` | 2.0.4 | -| is-saving | Whether to show save button loading status | *boolean* | `false` | - | -| is-deleting | Whether to show delete button loading status | *boolean* | `false` | - | -| tel-validator | The method to validate tel | *(tel: string) => boolean* | - | - | -| postal-validator | The method to validate postal | *(tel: string) => boolean* | - | 2.1.2 | -| validator | Custom validator | *(key, value) => string* | - | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| area-list | Area List | *object* | - | +| area-columns-placeholder `v2.2.5` | placeholder of area columns | *string[]* | `[]` | +| address-info | Address Info | *AddressInfo* | `{}` | +| search-result | Address search result | *SearchResult[]* | `[]` | +| show-postal | Whether to show postal field | *boolean* | `false` | +| show-delete | Whether to show delete button | *boolean* | `false` | +| show-set-default | Whether to show default address switch | *boolean* | `false` | +| show-search-result | Whether to show address search result | *boolean* | `false` | +| save-button-text | Save button text | *string* | `Save` | +| delete-button-text | Delete button text | *string* | `Delete` | +| detail-rows | Detail input rows | *number* | `1` | +| detail-maxlength `v2.0.4` | Detail maxlength | *number* | `200` | +| is-saving | Whether to show save button loading status | *boolean* | `false` | +| is-deleting | Whether to show delete button loading status | *boolean* | `false` | +| tel-validator | The method to validate tel | *(tel: string) => boolean* | - | +| postal-validator `v2.1.2` | The method to validate postal | *(tel: string) => boolean* | - | +| validator | Custom validator | *(key, value) => string* | - | ### Events diff --git a/src/address-edit/README.zh-CN.md b/src/address-edit/README.zh-CN.md index f78444d89..33aad1913 100644 --- a/src/address-edit/README.zh-CN.md +++ b/src/address-edit/README.zh-CN.md @@ -62,25 +62,25 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| area-list | 地区列表 | *object* | - | - | -| area-columns-placeholder | 地区选择列占位提示文字 | *string[]* | `[]` | 2.2.5 | -| address-info | 收货人信息初始值 | *AddressInfo* | `{}` | - | -| search-result | 详细地址搜索结果 | *SearchResult[]* | `[]` | - | -| show-postal | 是否显示邮政编码 | *boolean* | `false` | - | -| show-delete | 是否显示删除按钮 | *boolean* | `false` | - | -| show-set-default | 是否显示默认地址栏 | *boolean* | `false` | - | -| show-search-result | 是否显示搜索结果 | *boolean* | `false` | - | -| save-button-text | 保存按钮文字 | *string* | `保存` | - | -| delete-button-text | 删除按钮文字 | *string* | `删除` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| area-list | 地区列表 | *object* | - | +| area-columns-placeholder `v2.2.5` | 地区选择列占位提示文字 | *string[]* | `[]` | +| address-info | 收货人信息初始值 | *AddressInfo* | `{}` | +| search-result | 详细地址搜索结果 | *SearchResult[]* | `[]` | +| show-postal | 是否显示邮政编码 | *boolean* | `false` | +| show-delete | 是否显示删除按钮 | *boolean* | `false` | +| show-set-default | 是否显示默认地址栏 | *boolean* | `false` | +| show-search-result | 是否显示搜索结果 | *boolean* | `false` | +| save-button-text | 保存按钮文字 | *string* | `保存` | +| delete-button-text | 删除按钮文字 | *string* | `删除` | | detail-rows | 详细地址输入框行数 | *number* | `1` | -| detail-maxlength | 详细地址最大长度 | *number* | `200` | 2.0.4 | -| is-saving | 是否显示保存按钮加载动画 | *boolean* | `false` | - | -| is-deleting | 是否显示删除按钮加载动画 | *boolean* | `false` | - | -| tel-validator | 手机号格式校验函数 | *string => boolean* | - | - | -| postal-validator | 邮政编码格式校验函数 | *string => boolean* | - | 2.1.2 | -| validator | 自定义校验函数 | *(key, value) => string* | - | - | +| detail-maxlength `v2.0.4` | 详细地址最大长度 | *number* | `200` | +| is-saving | 是否显示保存按钮加载动画 | *boolean* | `false` | +| is-deleting | 是否显示删除按钮加载动画 | *boolean* | `false` | +| tel-validator | 手机号格式校验函数 | *string => boolean* | - | +| postal-validator `v2.1.2` | 邮政编码格式校验函数 | *string => boolean* | - | +| validator | 自定义校验函数 | *(key, value) => string* | - | ### Events diff --git a/src/address-list/README.md b/src/address-list/README.md index bd02894f7..386680fa5 100644 --- a/src/address-list/README.md +++ b/src/address-list/README.md @@ -70,15 +70,15 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Id of chosen address | *string* | - | - | -| list | Address list | *Address[]* | `[]` | - | -| disabled-list | Disabled address list | *Address[]* | `[]` | - | -| 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 | Default tag text | *string* | - | 2.3.0 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Id of chosen address | *string* | - | +| list | Address list | *Address[]* | `[]` | +| disabled-list | Disabled address list | *Address[]* | `[]` | +| 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* | - | ### Events diff --git a/src/address-list/README.zh-CN.md b/src/address-list/README.zh-CN.md index efebc631e..0465d9586 100644 --- a/src/address-list/README.zh-CN.md +++ b/src/address-list/README.zh-CN.md @@ -71,15 +71,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 | 默认地址标签文字 | *string* | - | 2.3.0 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| 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* | - | ### Events diff --git a/src/area/README.md b/src/area/README.md index 9ba790bd7..0200a354c 100644 --- a/src/area/README.md +++ b/src/area/README.md @@ -56,20 +56,20 @@ Set `columns-num` with 2, you'll have a 2 level picker. ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| value | the `code` of selected area | *string* | - | - | -| title | Toolbar title | *string* | - | - | -| area-list | Area data | *object* | - | - | -| columns-num | level of picker | *string \| number* | `3` | - | -| columns-placeholder | placeholder of columns | *string[]* | `[]` | 2.2.5 | -| item-height | Option height | *number* | `44` | - | -| loading | Whether to show loading prompt | *boolean* | `false` | - | -| visible-item-count | Count of visible columns | *number* | `5` | - | -| confirm-button-text | Text of confirm button | *string* | `Confirm` | - | -| cancel-button-text | Text of cancel button | *string* | `Cancel` | - | -| is-oversea-code | The method to validate oversea code | *() => boolean* | - | 2.1.4 | -| swipe-duration | Duration of the momentum animation，unit `ms` | *number* | `1000` | `2.2.13` | +| Attribute | Description | Type | Default | +|------|------|------|------| +| value | the `code` of selected area | *string* | - | +| title | Toolbar title | *string* | - | +| area-list | Area data | *object* | - | +| columns-num | level of picker | *string \| number* | `3` | +| columns-placeholder `v2.2.5` | placeholder of columns | *string[]* | `[]` | +| item-height | Option height | *number* | `44` | +| loading | Whether to show loading prompt | *boolean* | `false` | +| visible-item-count | Count of visible columns | *number* | `5` | +| confirm-button-text | Text of confirm button | *string* | `Confirm` | +| cancel-button-text | Text of cancel button | *string* | `Cancel` | +| is-oversea-code `v2.1.4` | The method to validate oversea code | *() => boolean* | - | +| swipe-duration `v2.2.13` | Duration of the momentum animation，unit `ms` | *number* | `1000` | ### Events diff --git a/src/area/README.zh-CN.md b/src/area/README.zh-CN.md index e16850c1d..e2ef3e728 100644 --- a/src/area/README.zh-CN.md +++ b/src/area/README.zh-CN.md @@ -55,20 +55,20 @@ Vue.use(Area); ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| value | 当前选中的省市区`code` | *string* | - | - | -| title | 顶部栏标题 | *string* | - | - | -| area-list | 省市区数据，格式见下方 | *object* | - | - | -| columns-num | 显示列数，3-省市区，2-省市，1-省 | *string \| number* | `3` | - | -| columns-placeholder | 列占位提示文字 | *string[]* | `[]` | 2.2.5 | -| loading | 是否显示加载状态 | *boolean* | `false` | - | -| item-height | 选项高度 | *number* | `44` | - | -| visible-item-count | 可见的选项个数 | *number* | `5` | - | -| confirm-button-text | 确认按钮文字 | *string* | `确认` | - | -| cancel-button-text | 取消按钮文字 | *string* | `取消` | - | -| is-oversea-code | 根据`code`校验海外地址，海外地址会划分至单独的分类 | *() => boolean* | - | 2.1.4 | -| swipe-duration | 快速滑动时惯性滚动的时长，单位`ms` | *number* | `1000` | `2.2.13` | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| value | 当前选中的省市区`code` | *string* | - | +| title | 顶部栏标题 | *string* | - | +| area-list | 省市区数据，格式见下方 | *object* | - | +| columns-num | 显示列数，3-省市区，2-省市，1-省 | *string \| number* | `3` | +| columns-placeholder `v2.2.5` | 列占位提示文字 | *string[]* | `[]` | +| loading | 是否显示加载状态 | *boolean* | `false` | +| item-height | 选项高度 | *number* | `44` | +| visible-item-count | 可见的选项个数 | *number* | `5` | +| confirm-button-text | 确认按钮文字 | *string* | `确认` | +| cancel-button-text | 取消按钮文字 | *string* | `取消` | +| is-oversea-code `v2.1.4` | 根据`code`校验海外地址，海外地址会划分至单独的分类 | *() => boolean* | - | +| swipe-duration `v2.2.13` | 快速滑动时惯性滚动的时长，单位`ms` | *number* | `1000` | ### Events diff --git a/src/button/README.md b/src/button/README.md index 7ae4ee1fe..1e1715459 100644 --- a/src/button/README.md +++ b/src/button/README.md @@ -98,27 +98,27 @@ Vue.use(Button); ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| type | Can be set to `primary` `info` `warning` `danger` | *string* | `default` | - | -| size | Can be set to `large` `small` `mini` | *string* | `normal` | - | -| text | Text | *string* | - | - | -| color | Color, support linear-gradient | *string* | - | 2.1.8 | -| icon | Left Icon | *string* | - | - | -| tag | HTML Tag | *string* | `button` | - | -| native-type | Native Type Attribute | *string* | `''` | - | -| plain | Whether to be plain button | *boolean* | `false` | - | -| block | Whether to set display block | *boolean* | `false` | - | -| round | Whether to be round button | *boolean* | `false` | - | -| square | Whether to be square button | *boolean* | `false` | - | -| disabled | Whether to disable button | *boolean* | `false` | - | -| loading | Whether show loading status | *boolean* | `false` | - | -| loading-text | Loading text | *string* | - | - | -| loading-type | Loading type, can be set to `spinner` | *string* | `circular` | - | -| loading-size | Loading icon size | *string* | `20px` | - | -| 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` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| type | Can be set to `primary` `info` `warning` `danger` | *string* | `default` | +| size | Can be set to `large` `small` `mini` | *string* | `normal` | +| text | Text | *string* | - | +| color `v2.1.8` | Color, support linear-gradient | *string* | - | +| icon | Left Icon | *string* | - | +| tag | HTML Tag | *string* | `button` | +| native-type | Native Type Attribute | *string* | `''` | +| plain | Whether to be plain button | *boolean* | `false` | +| block | Whether to set display block | *boolean* | `false` | +| round | Whether to be round button | *boolean* | `false` | +| square | Whether to be square button | *boolean* | `false` | +| disabled | Whether to disable button | *boolean* | `false` | +| loading | Whether show loading status | *boolean* | `false` | +| loading-text | Loading text | *string* | - | +| loading-type | Loading type, can be set to `spinner` | *string* | `circular` | +| loading-size | Loading icon size | *string* | `20px` | +| 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` | ### Events diff --git a/src/button/README.zh-CN.md b/src/button/README.zh-CN.md index 83e03e82a..ca3c95675 100644 --- a/src/button/README.zh-CN.md +++ b/src/button/README.zh-CN.md @@ -122,28 +122,28 @@ Vue.use(Button); ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| type | 类型，可选值为 `primary` `info` `warning` `danger` | *string* | `default` | - | -| size | 尺寸，可选值为 `large` `small` `mini` | *string* | `normal` | - | -| text | 按钮文字 | *string* | - | - | -| color | 按钮颜色，支持传入`linear-gradient`渐变色 | *string* | - | 2.1.8 | -| icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | - | -| tag | HTML 标签 | *string* | `button` | - | -| native-type | 原生 button 标签 type 属性 | *string* | - | - | -| block | 是否为块级元素 | *boolean* | `false` | - | -| plain | 是否为朴素按钮 | *boolean* | `false` | - | -| square | 是否为方形按钮 | *boolean* | `false` | - | -| round | 是否为圆形按钮 | *boolean* | `false` | - | -| disabled | 是否禁用按钮 | *boolean* | `false` | - | -| hairline | 是否使用 0.5px 边框 | *boolean* | `false` | - | -| loading | 是否显示为加载状态 | *boolean* | `false` | - | -| loading-text | 加载状态提示文字 | *string* | - | - | -| loading-type | 加载图标类型，可选值为`spinner` | *string* | `circular` | - | -| loading-size | 加载图标大小 | *string* | `20px` | - | -| url | 点击后跳转的链接地址 | *string* | - | - | -| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | - | -| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| type | 类型，可选值为 `primary` `info` `warning` `danger` | *string* | `default` | +| size | 尺寸，可选值为 `large` `small` `mini` | *string* | `normal` | +| text | 按钮文字 | *string* | - | +| color `v2.1.8` | 按钮颜色，支持传入`linear-gradient`渐变色 | *string* | - | +| icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | +| tag | HTML 标签 | *string* | `button` | +| native-type | 原生 button 标签 type 属性 | *string* | - | +| block | 是否为块级元素 | *boolean* | `false` | +| plain | 是否为朴素按钮 | *boolean* | `false` | +| square | 是否为方形按钮 | *boolean* | `false` | +| round | 是否为圆形按钮 | *boolean* | `false` | +| disabled | 是否禁用按钮 | *boolean* | `false` | +| hairline | 是否使用 0.5px 边框 | *boolean* | `false` | +| loading | 是否显示为加载状态 | *boolean* | `false` | +| loading-text | 加载状态提示文字 | *string* | - | +| loading-type | 加载图标类型，可选值为`spinner` | *string* | `circular` | +| loading-size | 加载图标大小 | *string* | `20px` | +| url | 点击后跳转的链接地址 | *string* | - | +| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | +| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` | ### Events diff --git a/src/calendar/README.md b/src/calendar/README.md index 781cd3c2b..419c10f0b 100644 --- a/src/calendar/README.md +++ b/src/calendar/README.md @@ -201,26 +201,26 @@ Set `poppable` to `false`, the calendar will be displayed directly on the page i ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Whether to show calendar | *boolean* | `false` | - | -| type | Type，can be set to `single` `range` | *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 | - | -| max-date | Max date | *Date* | Six months after the today | - | -| default-date | Default selected date | *Date \| Date[]* | Today | - | -| row-height | Row height | *number* | `64` | - | -| formatter | Day formatter | *(day: Day) => Day* | - | - | -| position | Popup position, can be set to `top` `right` `left` | *string* | `bottom` | - | -| poppable | Whether to show the calendar inside a popup | *boolean* | `true` | - | -| round | Whether to show round corner | *boolean* | `true` | - | -| show-mark | Whether to show background month mark | *boolean* | `true` | - | -| show-confirm | Whether to show confirm button | *boolean* | `true` | - | -| close-on-click-overlay | Whether to close when click overlay | *boolean* | `true` | - | -| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `true` | - | -| confirm-text | Confirm button text | *string* | `Confirm` | - | -| confirm-disabled-text | Confirm button text when disabled | *string* | `Confirm` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Whether to show calendar | *boolean* | `false` | +| type | Type，can be set to `single` `range` | *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 | +| max-date | Max date | *Date* | Six months after the today | +| default-date | Default selected date | *Date \| Date[]* | Today | +| row-height | Row height | *number* | `64` | +| formatter | Day formatter | *(day: Day) => Day* | - | +| position | Popup position, can be set to `top` `right` `left` | *string* | `bottom` | +| poppable | Whether to show the calendar inside a popup | *boolean* | `true` | +| round | Whether to show round corner | *boolean* | `true` | +| show-mark | Whether to show background month mark | *boolean* | `true` | +| show-confirm | Whether to show confirm button | *boolean* | `true` | +| close-on-click-overlay | Whether to close when click overlay | *boolean* | `true` | +| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `true` | +| confirm-text | Confirm button text | *string* | `Confirm` | +| confirm-disabled-text | Confirm button text when disabled | *string* | `Confirm` | ### Data Structure of Day diff --git a/src/calendar/README.zh-CN.md b/src/calendar/README.zh-CN.md index 4bbcc38e4..04e6acfd5 100644 --- a/src/calendar/README.zh-CN.md +++ b/src/calendar/README.zh-CN.md @@ -201,26 +201,26 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 是否显示日历弹窗 | *boolean* | `false` | - | -| type | 选择类型，`single`表示选择单个日期，
`range`表示选择日期区间 | *string* | `single` | - | -| title | 日历标题 | *string* | `日期选择` | - | -| color | 颜色，对底部按钮和选中日期生效 | *string* | `#ee0a24` | - | -| min-date | 最小日期 | *Date* | 当前日期 | - | -| max-date | 最大日期 | *Date* | 当前日期的六个月后 | - | -| default-date | 默认选中的日期 | *Date \| Date[]* | 今天 | - | -| row-height | 日期行高 | *number* | `64` | - | -| formatter | 日期格式化函数 | *(day: Day) => Day* | - | - | -| position | 弹出位置，可选值为 `top` `right` `left` | *string* | `bottom` | - | -| poppable | 是否以弹层的形式展示日历 | *boolean* | `true` | - | -| round | 是否显示圆角弹窗 | *boolean* | `true` | - | -| show-mark | 是否显示月份背景水印 | *boolean* | `true` | - | -| show-confirm | 是否展示确认按钮 | *boolean* | `true` | - | -| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `true` | - | -| safe-area-inset-bottom | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `true` | - | -| confirm-text | 确认按钮的文字 | *string* | `确定` | - | -| confirm-disabled-text | 确认按钮处于禁用状态时的文字 | *string* | `确定` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 是否显示日历弹窗 | *boolean* | `false` | +| type | 选择类型，`single`表示选择单个日期，
`range`表示选择日期区间 | *string* | `single` | +| title | 日历标题 | *string* | `日期选择` | +| color | 颜色，对底部按钮和选中日期生效 | *string* | `#ee0a24` | +| min-date | 最小日期 | *Date* | 当前日期 | +| max-date | 最大日期 | *Date* | 当前日期的六个月后 | +| default-date | 默认选中的日期 | *Date \| Date[]* | 今天 | +| row-height | 日期行高 | *number* | `64` | +| formatter | 日期格式化函数 | *(day: Day) => Day* | - | +| position | 弹出位置，可选值为 `top` `right` `left` | *string* | `bottom` | +| poppable | 是否以弹层的形式展示日历 | *boolean* | `true` | +| round | 是否显示圆角弹窗 | *boolean* | `true` | +| show-mark | 是否显示月份背景水印 | *boolean* | `true` | +| show-confirm | 是否展示确认按钮 | *boolean* | `true` | +| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `true` | +| safe-area-inset-bottom | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `true` | +| confirm-text | 确认按钮的文字 | *string* | `确定` | +| confirm-disabled-text | 确认按钮处于禁用状态时的文字 | *string* | `确定` | ### Day 数据结构 diff --git a/src/card/README.md b/src/card/README.md index 7c5efc0de..0c2c2be39 100644 --- a/src/card/README.md +++ b/src/card/README.md @@ -64,19 +64,19 @@ Use slot to custom content. ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| thumb | Left thumb image URL | *string* | - | - | -| title | Title | *string* | - | - | -| desc | Description | *string* | - | - | -| tag | Tag | *string* | - | - | -| num | number | *string \| number* | - | - | -| price | Price | *string \| number* | - | - | -| origin-price | Origin price | *string \| number* | - | - | -| centered | Whether content vertical centered | *boolean* | `false` | - | -| currency | Currency symbol | *string* | `¥` | - | -| thumb-link | Thumb link URL | *string* | - | - | -| lazy-load | Whether to enable thumb lazy load，should register [Lazyload](#/en-US/lazyload) component | *boolean* | `false` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| thumb | Left thumb image URL | *string* | - | +| title | Title | *string* | - | +| desc | Description | *string* | - | +| tag | Tag | *string* | - | +| num | number | *string \| number* | - | +| price | Price | *string \| number* | - | +| origin-price | Origin price | *string \| number* | - | +| centered | Whether content vertical centered | *boolean* | `false` | +| currency | Currency symbol | *string* | `¥` | +| thumb-link | Thumb link URL | *string* | - | +| lazy-load | Whether to enable thumb lazy load，should register [Lazyload](#/en-US/lazyload) component | *boolean* | `false` | ### Events diff --git a/src/card/README.zh-CN.md b/src/card/README.zh-CN.md index b87dd2529..ec53860d5 100644 --- a/src/card/README.zh-CN.md +++ b/src/card/README.zh-CN.md @@ -66,19 +66,19 @@ Vue.use(Card); ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| thumb | 左侧图片 URL | *string* | - | - | -| title | 标题 | *string* | - | - | -| desc | 描述 | *string* | - | - | -| tag | 图片角标 | *string* | - | - | -| num | 商品数量 | *string \| number* | - | - | -| price | 商品价格 | *string \| number* | - | - | -| origin-price | 商品划线原价 | *string \| number* | - | - | -| centered | 内容是否垂直居中 | *boolean* | `false` | - | -| currency | 货币符号 | *string* | `¥` | - | -| thumb-link | 点击左侧图片后跳转的链接地址 | *string* | - | - | -| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| thumb | 左侧图片 URL | *string* | - | +| title | 标题 | *string* | - | +| desc | 描述 | *string* | - | +| tag | 图片角标 | *string* | - | +| num | 商品数量 | *string \| number* | - | +| price | 商品价格 | *string \| number* | - | +| origin-price | 商品划线原价 | *string \| number* | - | +| centered | 内容是否垂直居中 | *boolean* | `false` | +| currency | 货币符号 | *string* | `¥` | +| thumb-link | 点击左侧图片后跳转的链接地址 | *string* | - | +| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | *boolean* | `false` | ### Events diff --git a/src/cell/README.md b/src/cell/README.md index 08e622db6..15b7d9772 100644 --- a/src/cell/README.md +++ b/src/cell/README.md @@ -104,33 +104,33 @@ Vue.use(Cell).use(CellGroup); ### CellGroup Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| title | Group title | *string* | - | - | -| border | Whether to show outer border | *boolean* | `true` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| title | Group title | *string* | - | +| border | Whether to show outer border | *boolean* | `true` | ### Cell Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| icon | Left Icon | *string* | - | - | -| title | Title | *string \| number* | - | - | -| value | Right text | *string \| number* | - | - | -| label | Description below the title | *string* | - | - | -| size | Size，can be set to `large` | *string* | - | - | -| border | Whether to show inner border | *boolean* | `true` | - | -| center | Whether to center content vertically | *boolean* | `true` | - | -| 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` | - | -| clickable | Whether to show click feedback when clicked | *boolean* | `false` | - | -| is-link | Whether to show link icon | *boolean* | `false` | - | -| required | Whether to show required mark | *boolean* | `false` | - | -| arrow-direction | Can be set to `left` `up` `down` | *string* | - | - | -| title-style | Title style | *any* | - | - | -| title-class | Title className | *any* | - | - | -| value-class | Value className | *any* | - | - | -| label-class | Label className | *any* | - | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| icon | Left Icon | *string* | - | +| title | Title | *string \| number* | - | +| value | Right text | *string \| number* | - | +| label | Description below the title | *string* | - | +| size | Size，can be set to `large` | *string* | - | +| border | Whether to show inner border | *boolean* | `true` | +| center | Whether to center content vertically | *boolean* | `true` | +| 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` | +| clickable | Whether to show click feedback when clicked | *boolean* | `false` | +| is-link | Whether to show link icon | *boolean* | `false` | +| required | Whether to show required mark | *boolean* | `false` | +| arrow-direction | Can be set to `left` `up` `down` | *string* | - | +| title-style | Title style | *any* | - | +| title-class | Title className | *any* | - | +| value-class | Value className | *any* | - | +| label-class | Label className | *any* | - | ### Cell Events diff --git a/src/cell/README.zh-CN.md b/src/cell/README.zh-CN.md index 548929180..c2b27b3fa 100644 --- a/src/cell/README.zh-CN.md +++ b/src/cell/README.zh-CN.md @@ -115,33 +115,33 @@ Vue.use(Cell).use(CellGroup); ### CellGroup Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| title | 分组标题 | *string* | `-` | - | -| border | 是否显示外边框 | *boolean* | `true` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| title | 分组标题 | *string* | `-` | +| border | 是否显示外边框 | *boolean* | `true` | ### Cell Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | - | -| title | 左侧标题 | *string \| number* | - | - | -| value | 右侧内容 | *string \| number* | - | - | -| label | 标题下方的描述信息 | *string* | - | - | -| size | 单元格大小，可选值为 `large` | *string* | - | - | -| url | 点击后跳转的链接地址 | *string* | - | - | -| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | - | -| border | 是否显示内边框 | *boolean* | `true` | - | -| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` | - | -| clickable | 是否开启点击反馈 | *boolean* | `false` | - | -| is-link | 是否展示右侧箭头并开启点击反馈 | *boolean* | `false` | - | -| required | 是否显示表单必填星号 | *boolean* | `false` | - | -| center | 是否使内容垂直居中 | *boolean* | `false` | - | -| arrow-direction | 箭头方向，可选值为 `left` `up` `down` | *string* | - | -| -| title-style | 左侧标题额外样式 | *any* | - | - | -| title-class | 左侧标题额外类名 | *any* | - | - | -| value-class | 右侧内容额外类名 | *any* | - | - | -| label-class | 描述信息额外类名 | *any* | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | +| title | 左侧标题 | *string \| number* | - | +| value | 右侧内容 | *string \| number* | - | +| label | 标题下方的描述信息 | *string* | - | +| size | 单元格大小，可选值为 `large` | *string* | - | +| url | 点击后跳转的链接地址 | *string* | - | +| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | +| border | 是否显示内边框 | *boolean* | `true` | +| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` | +| clickable | 是否开启点击反馈 | *boolean* | `false` | +| is-link | 是否展示右侧箭头并开启点击反馈 | *boolean* | `false` | +| required | 是否显示表单必填星号 | *boolean* | `false` | +| center | 是否使内容垂直居中 | *boolean* | `false` | +| arrow-direction | 箭头方向，可选值为 `left` `up` `down` | *string* | - | +| title-style | 左侧标题额外样式 | *any* | - | +| title-class | 左侧标题额外类名 | *any* | - | +| value-class | 右侧内容额外类名 | *any* | - | +| label-class | 描述信息额外类名 | *any* | - | ### Cell Events diff --git a/src/checkbox/README.md b/src/checkbox/README.md index 45a9556b1..ac496c3b5 100644 --- a/src/checkbox/README.md +++ b/src/checkbox/README.md @@ -184,27 +184,27 @@ export default { ### Checkbox Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| name | Checkbox name | *any* | - | - | -| shape | Can be set to `square` | *string* | `round` | - | -| v-model | Check status | *boolean* | `false` | - | -| disabled | Disable checkbox | *boolean* | `false` | - | -| label-disabled | Whether to disable label click | *boolean* | `false` | - | -| label-position | Can be set to `left` | *string* | `right` | - | -| icon-size | Icon size | *string \| number* | `20px` | - | -| checked-color | Checked color | *string* | `#1989fa` | - | - | -| bind-group | Whether to bind with CheckboxGroup | *boolean* | `true` | 2.2.4 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| name | Checkbox name | *any* | - | +| shape | Can be set to `square` | *string* | `round` | +| v-model | Check status | *boolean* | `false` | +| disabled | Disable checkbox | *boolean* | `false` | +| label-disabled | Whether to disable label click | *boolean* | `false` | +| label-position | Can be set to `left` | *string* | `right` | +| icon-size | Icon size | *string \| number* | `20px` | +| checked-color | Checked color | *string* | `#1989fa` | - | +| bind-group `v2.2.4` | Whether to bind with CheckboxGroup | *boolean* | `true` | ### CheckboxGroup Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Names of all checked checkboxes | *any[]* | - | - | -| max | Maximum amount of checked options | *number* | `0`(Unlimited) | - | -| disabled | Disable all checkboxes | *boolean* | `false` | - | -| icon-size | Icon size of all checkboxes | *string \| number* | `20px` | 2.2.3 | -| checked-color | Checked color of all checkboxes | *string* | `#1989fa` | - | 2.2.3 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Names of all checked checkboxes | *any[]* | - | +| max | Maximum amount of checked options | *number* | `0`(Unlimited) | +| disabled | Disable all checkboxes | *boolean* | `false` | +| icon-size `v2.2.3` | Icon size of all checkboxes | *string \| number* | `20px` | +| checked-color `v2.2.3` | Checked color of all checkboxes | *string* | `#1989fa` | - | ### Checkbox Events diff --git a/src/checkbox/README.zh-CN.md b/src/checkbox/README.zh-CN.md index 31a9cdff0..92c82da85 100644 --- a/src/checkbox/README.zh-CN.md +++ b/src/checkbox/README.zh-CN.md @@ -200,27 +200,27 @@ export default { ### Checkbox Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| name | 标识符 | *any* | - | - | -| shape | 形状，可选值为 `square` | *string* | `round` | - | -| v-model | 是否为选中状态 | *boolean* | `false` | - | -| disabled | 是否禁用复选框 | *boolean* | `false` | - | -| label-disabled | 是否禁用复选框文本点击 | *boolean* | `false` | - | -| label-position | 文本位置，可选值为 `left` | *string* | `right` | - | -| icon-size | 图标大小，默认单位为`px` | *string \| number* | `20px` | - | -| checked-color | 选中状态颜色 | *string* | `#1989fa` | - | -| bind-group | 是否与复选框组绑定 | *boolean* | `true` | 2.2.4 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| name | 标识符 | *any* | - | +| shape | 形状，可选值为 `square` | *string* | `round` | +| v-model | 是否为选中状态 | *boolean* | `false` | +| disabled | 是否禁用复选框 | *boolean* | `false` | +| label-disabled | 是否禁用复选框文本点击 | *boolean* | `false` | +| label-position | 文本位置，可选值为 `left` | *string* | `right` | +| icon-size | 图标大小，默认单位为`px` | *string \| number* | `20px` | +| checked-color | 选中状态颜色 | *string* | `#1989fa` | +| bind-group `v2.2.4` | 是否与复选框组绑定 | *boolean* | `true` | ### CheckboxGroup Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 所有选中项的标识符 | *any[]* | - | - | -| disabled | 是否禁用所有复选框 | *boolean* | `false` | - | -| max | 最大可选数，0 为无限制 | *number* | `0` | - | -| icon-size | 所有复选框的图标大小，默认单位为`px` | *string \| number* | `20px` | 2.2.3 | -| checked-color | 所有复选框的选中状态颜色 | *string* | `#1989fa` | 2.2.3 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 所有选中项的标识符 | *any[]* | - | +| disabled | 是否禁用所有复选框 | *boolean* | `false` | +| max | 最大可选数，0 为无限制 | *number* | `0` | +| icon-size `v2.2.3` | 所有复选框的图标大小，默认单位为`px` | *string \| number* | `20px` | +| checked-color `v2.2.3` | 所有复选框的选中状态颜色 | *string* | `#1989fa` | ### Checkbox Events diff --git a/src/circle/README.md b/src/circle/README.md index 3b721baa8..48fd96229 100644 --- a/src/circle/README.md +++ b/src/circle/README.md @@ -110,19 +110,19 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Current rate | *number* | - | - | -| rate | Target rate | *number* | `100` | - | -| size | Circle size | *string \| number* | `100px` | - | -| color | Progress color, passing object to render gradient | *string \| object* | `#1989fa` | 2.1.4 | -| layer-color | Layer color | *string* | `#fff` | - | -| fill | Fill color | *string* | `none` | - | -| speed | Animate speed（rate/s）| *number* | `0` | - | -| text | Text | *string* | - | - | -| stroke-width | Stroke width | *number* | `40` | - | -| stroke-linecap | Stroke linecap，can be set to `sqaure` `butt` | *string* | `round` | 2.2.15 | -| clockwise | Whether to be clockwise | *boolean* | `true` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Current rate | *number* | - | +| rate | Target rate | *number* | `100` | +| size | Circle size | *string \| number* | `100px` | +| color `v2.1.4` | Progress color, passing object to render gradient | *string \| object* | `#1989fa` | +| layer-color | Layer color | *string* | `#fff` | +| fill | Fill color | *string* | `none` | +| speed | Animate speed（rate/s）| *number* | `0` | +| text | Text | *string* | - | +| stroke-width | Stroke width | *number* | `40` | +| stroke-linecap `v2.2.15` | Stroke linecap，can be set to `sqaure` `butt` | *string* | `round` | +| clockwise | Whether to be clockwise | *boolean* | `true` | ### Slots diff --git a/src/circle/README.zh-CN.md b/src/circle/README.zh-CN.md index 351e66d94..6b878d9d9 100644 --- a/src/circle/README.zh-CN.md +++ b/src/circle/README.zh-CN.md @@ -122,19 +122,19 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 当前进度 | *number* | - | - | -| rate | 目标进度 | *number* | `100` | - | -| size | 圆环直径，默认单位为 `px` | *string \| number* | `100px` | - | -| color | 进度条颜色，传入对象格式可以定义渐变色 | *string \| object* | `#1989fa` | 2.1.4 | -| layer-color | 轨道颜色 | *string* | `#fff` | - | -| fill | 填充颜色 | *string* | `none` | - | -| speed | 动画速度（单位为 rate/s）| *number* | `0` | - | -| text | 文字 | *string* | - | - | -| stroke-width | 进度条宽度 | *number* | `40` | - | -| stroke-linecap | 进度条端点的形状，可选值为`sqaure` `butt` | *string* | `round` | 2.2.15 | -| clockwise | 是否顺时针增加 | *boolean* | `true` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 当前进度 | *number* | - | +| rate | 目标进度 | *number* | `100` | +| size | 圆环直径，默认单位为 `px` | *string \| number* | `100px` | +| color `v2.1.4` | 进度条颜色，传入对象格式可以定义渐变色 | *string \| object* | `#1989fa` | +| layer-color | 轨道颜色 | *string* | `#fff` | +| fill | 填充颜色 | *string* | `none` | +| speed | 动画速度（单位为 rate/s）| *number* | `0` | +| text | 文字 | *string* | - | +| stroke-width | 进度条宽度 | *number* | `40` | +| stroke-linecap `v2.2.15` | 进度条端点的形状，可选值为`sqaure` `butt` | *string* | `round` | +| clockwise | 是否顺时针增加 | *boolean* | `true` | ### Slots diff --git a/src/col/README.md b/src/col/README.md index b476526d0..de0ba9a19 100644 --- a/src/col/README.md +++ b/src/col/README.md @@ -91,21 +91,21 @@ Setting `type` to `flex` to enable flex layout ### Row Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| type | Layout type, can be set to `flex` | *string* | - | - | -| gutter | Grid spacing（px） | *string \| number* | - | - | -| tag | Custom element tag | *string* | `div` | - | -| justify | Flex main axis，can be set to end/center/space-around/space-between | *string* | `start` | - | -| align | Flex cross axis, be set to center/bottom | *string* | `top` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| type | Layout type, can be set to `flex` | *string* | - | +| gutter | Grid spacing（px） | *string \| number* | - | +| tag | Custom element tag | *string* | `div` | +| justify | Flex main axis，can be set to end/center/space-around/space-between | *string* | `start` | +| align | Flex cross axis, be set to center/bottom | *string* | `top` | ### Col Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| span | number of column the grid spans | *string \| number* | - | - | -| offset | number of spacing on the left side of the grid | *string \| number* | - | - | -| tag | Custom element tag | *string* | `div` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| span | number of column the grid spans | *string \| number* | - | +| offset | number of spacing on the left side of the grid | *string \| number* | - | +| tag | Custom element tag | *string* | `div` | ### Row Events diff --git a/src/col/README.zh-CN.md b/src/col/README.zh-CN.md index 039ebf245..6456de8bc 100644 --- a/src/col/README.zh-CN.md +++ b/src/col/README.zh-CN.md @@ -94,21 +94,21 @@ Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置 ### Row Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| type | 布局方式，可选值为`flex` | *string* | - | - | -| gutter | 列元素之间的间距（单位为px） | *string \| number* | - | - | -| tag | 自定义元素标签 | *string* | `div` | - | -| justify | Flex 主轴对齐方式，可选值为 `end` `center`
`space-around` `space-between` | *string* | `start` | - | -| align | Flex 交叉轴对齐方式，可选值为 `center` `bottom` | *string* | `top` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| type | 布局方式，可选值为`flex` | *string* | - | +| gutter | 列元素之间的间距（单位为px） | *string \| number* | - | +| tag | 自定义元素标签 | *string* | `div` | +| justify | Flex 主轴对齐方式，可选值为 `end` `center`
`space-around` `space-between` | *string* | `start` | +| align | Flex 交叉轴对齐方式，可选值为 `center` `bottom` | *string* | `top` | ### Col Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| span | 列元素宽度 | *string \| number* | - | - | -| offset | 列元素偏移距离 | *string \| number* | - | - | -| tag | 自定义元素标签 | *string* | `div` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| span | 列元素宽度 | *string \| number* | - | +| offset | 列元素偏移距离 | *string \| number* | - | +| tag | 自定义元素标签 | *string* | `div` | ### Row Events diff --git a/src/collapse/README.md b/src/collapse/README.md index 2659a9c2b..303baf615 100644 --- a/src/collapse/README.md +++ b/src/collapse/README.md @@ -87,11 +87,11 @@ export default { ### Collapse Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Names of current active panels | accordion mode： *string \| number*
non-accordion mode：*(string \| number)[]* | - | - | -| accordion | Whether to be accordion mode | *boolean* | `false` | - | -| border | Whether to show outer border | *boolean* | `true` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Names of current active panels | accordion mode： *string \| number*
non-accordion mode：*(string \| number)[]* | - | +| accordion | Whether to be accordion mode | *boolean* | `false` | +| border | Whether to show outer border | *boolean* | `true` | ### Collapse Events @@ -101,20 +101,20 @@ export default { ### CollapseItem Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| name | Name | *string \| number* | `index` | - | -| icon | Left Icon | *string* | - | - | -| size | Title size，can be set to `large` | *string* | - | - | -| title | Title | *string \| number* | - | - | -| value | Right text | *string \| number* | - | - | -| label | Description below the title | *string* | - | - | -| border | Whether to show inner border | *boolean* | `true` | - | -| disabled | Whether to disabled collapse | *boolean* | `false` | - | -| is-link | Whether to show link icon | *boolean* | `true` | - | -| title-class | Title className | *string* | - | - | -| value-class | Value className | *string* | - | - | -| label-class | Label className | *string* | - | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| name | Name | *string \| number* | `index` | +| icon | Left Icon | *string* | - | +| size | Title size，can be set to `large` | *string* | - | +| title | Title | *string \| number* | - | +| value | Right text | *string \| number* | - | +| label | Description below the title | *string* | - | +| border | Whether to show inner border | *boolean* | `true` | +| disabled | Whether to disabled collapse | *boolean* | `false` | +| is-link | Whether to show link icon | *boolean* | `true` | +| title-class | Title className | *string* | - | +| value-class | Value className | *string* | - | +| label-class | Label className | *string* | - | ### CollapseItem Slots diff --git a/src/collapse/README.zh-CN.md b/src/collapse/README.zh-CN.md index 6afb8edbe..7686f8731 100644 --- a/src/collapse/README.zh-CN.md +++ b/src/collapse/README.zh-CN.md @@ -88,11 +88,11 @@ export default { ### Collapse Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 当前展开面板的 name | 手风琴模式：*string \| number*
非手风琴模式：*(string \| number)[]* | - | - | -| accordion | 是否开启手风琴模式 | *boolean* | `false` | - | -| border | 是否显示外边框 | *boolean* | `true` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 当前展开面板的 name | 手风琴模式：*string \| number*
非手风琴模式：*(string \| number)[]* | - | +| accordion | 是否开启手风琴模式 | *boolean* | `false` | +| border | 是否显示外边框 | *boolean* | `true` | ### Collapse Events @@ -102,20 +102,20 @@ export default { ### CollapseItem Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| name | 唯一标识符，默认为索引值 | *string \| number* | `index` | - | -| icon | 标题栏左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | - | -| size | 标题栏大小，可选值为 `large` | *string* | - | - | -| title | 标题栏左侧内容 | *string \| number* | - | - | -| value | 标题栏右侧内容 | *string \| number* | - | - | -| label | 标题栏描述信息 | *string \| number* | - | - | -| border | 是否显示内边框 | *boolean* | `true` | - | -| is-link | 是否展示标题栏右侧箭头并开启点击反馈 | *boolean* | `true` | - | -| disabled | 是否禁用面板 | *boolean* | `false` | - | -| title-class | 左侧标题额外类名 | *string* | - | - | -| value-class | 右侧内容额外类名 | *string* | - | - | -| label-class | 描述信息额外类名 | *string* | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| name | 唯一标识符，默认为索引值 | *string \| number* | `index` | +| icon | 标题栏左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | +| size | 标题栏大小，可选值为 `large` | *string* | - | +| title | 标题栏左侧内容 | *string \| number* | - | +| value | 标题栏右侧内容 | *string \| number* | - | +| label | 标题栏描述信息 | *string \| number* | - | +| border | 是否显示内边框 | *boolean* | `true` | +| is-link | 是否展示标题栏右侧箭头并开启点击反馈 | *boolean* | `true` | +| disabled | 是否禁用面板 | *boolean* | `false` | +| title-class | 左侧标题额外类名 | *string* | - | +| value-class | 右侧内容额外类名 | *string* | - | +| label-class | 描述信息额外类名 | *string* | - | ### CollapseItem Slots diff --git a/src/contact-card/README.md b/src/contact-card/README.md index d082319ac..c1164f1d8 100644 --- a/src/contact-card/README.md +++ b/src/contact-card/README.md @@ -135,12 +135,12 @@ export default { ### ContactCard Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| type | Can be set to `add` `edit` | *string* | `add` | - | -| name | Name | *string* | - | - | -| tel | Phone | *string* | - | - | -| add-text | Add card text | *string* | `Add contact info` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| type | Can be set to `add` `edit` | *string* | `add` | +| name | Name | *string* | - | +| tel | Phone | *string* | - | +| add-text | Add card text | *string* | `Add contact info` | ### ContactCard Events @@ -150,12 +150,12 @@ export default { ### ContactList Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Id of chosen contact | *string \| number* | - | - | -| list | Contact list | *Contact[]* | `[]` | - | -| add-text | Add button text | *string* | `Add new contact` | - | -| default-tag-text | Default tag text | *string* | - | 2.3.0 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Id of chosen contact | *string \| number* | - | +| list | Contact list | *Contact[]* | `[]` | +| add-text | Add button text | *string* | `Add new contact` | +| default-tag-text `v2.3.0` | Default tag text | *string* | - | ### ContactList Events @@ -168,15 +168,15 @@ export default { ### ContactEdit Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| contact-info | Contact Info | *object* | `[]` | - | -| is-edit | Whether is editing | *boolean* | `false` | - | -| 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 | Whether to show default contact switch | *boolean* | `false` | 2.3.0 | -| set-default-label | default contact switch label | *string* | - | 2.3.0 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| contact-info | Contact Info | *object* | `[]` | +| is-edit | Whether is editing | *boolean* | `false` | +| 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* | - | ### ContactEdit Events diff --git a/src/contact-card/README.zh-CN.md b/src/contact-card/README.zh-CN.md index d77059e1e..14187d9cb 100644 --- a/src/contact-card/README.zh-CN.md +++ b/src/contact-card/README.zh-CN.md @@ -139,12 +139,12 @@ export default { ### ContactCard Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| type | 类型，可选值为 `add` `edit` | *string* | `add` | - | -| name | 联系人姓名 | *string* | - | - | -| tel | 联系人手机号 | *string* | - | - | -| add-text | 添加时的文案提示 | *string* | `添加订单联系人信息` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| type | 类型，可选值为 `add` `edit` | *string* | `add` | +| name | 联系人姓名 | *string* | - | +| tel | 联系人手机号 | *string* | - | +| add-text | 添加时的文案提示 | *string* | `添加订单联系人信息` | ### ContactCard Events @@ -154,12 +154,12 @@ export default { ### ContactList Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 当前选中联系人的 id | *string \| number* | - | - | -| list | 联系人列表 | *Contact[]* | `[]` | - | -| add-text | 新建按钮文案 | *string* | `新建联系人` | - | -| default-tag-text | 默认联系人标签文案 | *string* | - | 2.3.0 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 当前选中联系人的 id | *string \| number* | - | +| list | 联系人列表 | *Contact[]* | `[]` | +| add-text | 新建按钮文案 | *string* | `新建联系人` | +| default-tag-text `v2.3.0` | 默认联系人标签文案 | *string* | - | ### ContactList Events @@ -171,15 +171,15 @@ export default { ### ContactEdit Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| contact-info | 联系人信息 | *object* | `[]` | - | -| is-edit | 是否为编辑联系人 | *boolean* | `false` | - | -| is-saving | 是否显示保存按钮加载动画 | *boolean* | `false` | - | -| is-deleting | 是否显示删除按钮加载动画 | *boolean* | `false` | - | -| tel-validator | 手机号格式校验函数 | *(tel: string) => boolean* | - | - | -| show-set-default | 是否显示默认联系人栏 | *boolean* | `false` | 2.3.0 | -| set-default-label | 默认联系人栏文案 | *string* | - | 2.3.0 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| contact-info | 联系人信息 | *object* | `[]` | +| is-edit | 是否为编辑联系人 | *boolean* | `false` | +| 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* | - | ### ContactEdit Events diff --git a/src/count-down/README.md b/src/count-down/README.md index 3027a4748..0e4ce6bd7 100644 --- a/src/count-down/README.md +++ b/src/count-down/README.md @@ -111,12 +111,12 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| time | Total time | *number* | - | - | -| format | Time format | *string* | `HH:mm:ss` | - | -| auto-start | Whether to auto start count down | *boolean* | `true` | - | -| millisecond | Whether to enable millisecond render | *boolean* | `false` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| time | Total time | *number* | - | +| format | Time format | *string* | `HH:mm:ss` | +| auto-start | Whether to auto start count down | *boolean* | `true` | +| millisecond | Whether to enable millisecond render | *boolean* | `false` | ### Available formats diff --git a/src/count-down/README.zh-CN.md b/src/count-down/README.zh-CN.md index 715f86cf3..21f83cfd7 100644 --- a/src/count-down/README.zh-CN.md +++ b/src/count-down/README.zh-CN.md @@ -121,12 +121,12 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| time | 倒计时时长，单位毫秒 | *number* | - | - | -| format | 时间格式 | *string* | `HH:mm:ss` | - | -| auto-start | 是否自动开始倒计时 | *boolean* | `true` | - | -| millisecond | 是否开启毫秒级渲染 | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| time | 倒计时时长，单位毫秒 | *number* | - | +| format | 时间格式 | *string* | `HH:mm:ss` | +| auto-start | 是否自动开始倒计时 | *boolean* | `true` | +| millisecond | 是否开启毫秒级渲染 | *boolean* | `false` | ### format 格式 diff --git a/src/coupon-list/README.md b/src/coupon-list/README.md index d99f49639..6b3ca8bc7 100644 --- a/src/coupon-list/README.md +++ b/src/coupon-list/README.md @@ -76,35 +76,35 @@ export default { ### CouponCell Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| title | Cell title | *string* | `Coupon` | - | -| chosen-coupon | Index of chosen coupon | *number* | `-1` | - | -| coupons | Coupon list | *Coupon[]* | `[]` | - | -| editable | Cell editable | *boolean* | `true` | - | -| border | Whether to show innner border | *boolean* | `true` | - | -| currency | Currency symbol | *string* | `¥` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| title | Cell title | *string* | `Coupon` | +| chosen-coupon | Index of chosen coupon | *number* | `-1` | +| coupons | Coupon list | *Coupon[]* | `[]` | +| editable | Cell editable | *boolean* | `true` | +| border | Whether to show innner border | *boolean* | `true` | +| currency | Currency symbol | *string* | `¥` | ### CouponList Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Current exchange code | *string* | - | - | -| chosen-coupon | Index of chosen coupon | *number* | `-1` | - | -| coupons | Coupon list | *Coupon[]* | `[]` | - | -| disabled-coupons | Disabled coupon list | *Coupon[]* | `[]` | - | -| enabled-title | Title of coupon list | *string* | `Available` | - | - | -| disabled-title | Title of disabled coupon list | *string* | `Unavailable` | - | - | -| exchange-button-text | Exchange button text | *string* | `Exchange` | - | -| exchange-button-loading | Whether to show loading in exchange button | *boolean* | `false` | - | -| exchange-button-disabled | Whether to disable exchange button | *boolean* | `false` | - | -| exchange-min-length | Min length to enable exchange button | *number* | `1` | - | -| displayed-coupon-index | Index of displayed coupon | *number* | - | - | -| close-button-text | Close button text | *string* | `Close` | - | -| 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 | Whether to show coupon count in tab title | *boolean* | `true` | 2.3.0 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Current exchange code | *string* | - | +| chosen-coupon | Index of chosen coupon | *number* | `-1` | +| coupons | Coupon list | *Coupon[]* | `[]` | +| disabled-coupons | Disabled coupon list | *Coupon[]* | `[]` | +| enabled-title | Title of coupon list | *string* | `Available` | - | +| disabled-title | Title of disabled coupon list | *string* | `Unavailable` | - | +| exchange-button-text | Exchange button text | *string* | `Exchange` | +| exchange-button-loading | Whether to show loading in exchange button | *boolean* | `false` | +| exchange-button-disabled | Whether to disable exchange button | *boolean* | `false` | +| exchange-min-length | Min length to enable exchange button | *number* | `1` | +| displayed-coupon-index | Index of displayed coupon | *number* | - | +| close-button-text | Close button text | *string* | `Close` | +| 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` | ### CouponList Events diff --git a/src/coupon-list/README.zh-CN.md b/src/coupon-list/README.zh-CN.md index eabd1c189..3bd39f990 100644 --- a/src/coupon-list/README.zh-CN.md +++ b/src/coupon-list/README.zh-CN.md @@ -76,37 +76,37 @@ export default { ### CouponCell Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| title | 单元格标题 | *string* | `优惠券` | - | -| chosen-coupon | 当前选中优惠券的索引 | *number* | `-1` | - | -| coupons | 可用优惠券列表 | *Coupon[]* | `[]` | - | -| editable | 能否切换优惠券 | *boolean* | `true` | - | -| border | 是否显示内边框 | *boolean* | `true` | - | -| currency | 货币符号 | *string* | `¥` | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| title | 单元格标题 | *string* | `优惠券` | +| chosen-coupon | 当前选中优惠券的索引 | *number* | `-1` | +| coupons | 可用优惠券列表 | *Coupon[]* | `[]` | +| editable | 能否切换优惠券 | *boolean* | `true` | +| border | 是否显示内边框 | *boolean* | `true` | +| currency | 货币符号 | *string* | `¥` | - | ### CouponList Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 当前输入的兑换码 | *string* | - | - | -| chosen-coupon | 当前选中优惠券的索引 | *number* | `-1` | - | -| coupons | 可用优惠券列表 | *Coupon[]* | `[]` | - | -| disabled-coupons | 不可用优惠券列表 | *Coupon[]* | `[]` | - | -| enabled-title | 可用优惠券列表标题 | *string* | `可使用优惠券` | - | -| disabled-title | 不可用优惠券列表标题 | *string* | `不可使用优惠券` | - | -| exchange-button-text | 兑换按钮文字 | *string* | `兑换` | - | -| exchange-button-loading | 是否显示兑换按钮加载动画 | *boolean* | `false` | - | -| exchange-button-disabled | 是否禁用兑换按钮 | *boolean* | `false` | - | -| exchange-min-length | 兑换码最小长度 | *number* | `1` | - | -| displayed-coupon-index | 滚动至特定优惠券位置 | *number* | - | - | -| show-close-button | 是否显示列表底部按钮 | *boolean* | `true` | - | -| close-button-text | 列表底部按钮文字 | *string* | `不使用优惠` | - | -| input-placeholder | 输入框文字提示 | *string* | `请输入优惠码` | - | -| show-exchange-bar | 是否展示兑换栏 | *boolean* | `true` | - | -| currency | 货币符号 | *string* | `¥` | - | -| empty-image | 列表为空时的占位图 | *string* | `https://img.yzcdn.cn/vant/coupon-empty.png` | 2.1.0 | -| show-count | 是否展示可用 / 不可用数量 | *boolean* | `true` | 2.3.0 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 当前输入的兑换码 | *string* | - | +| chosen-coupon | 当前选中优惠券的索引 | *number* | `-1` | +| coupons | 可用优惠券列表 | *Coupon[]* | `[]` | +| disabled-coupons | 不可用优惠券列表 | *Coupon[]* | `[]` | +| enabled-title | 可用优惠券列表标题 | *string* | `可使用优惠券` | +| disabled-title | 不可用优惠券列表标题 | *string* | `不可使用优惠券` | +| exchange-button-text | 兑换按钮文字 | *string* | `兑换` | +| exchange-button-loading | 是否显示兑换按钮加载动画 | *boolean* | `false` | +| exchange-button-disabled | 是否禁用兑换按钮 | *boolean* | `false` | +| exchange-min-length | 兑换码最小长度 | *number* | `1` | +| displayed-coupon-index | 滚动至特定优惠券位置 | *number* | - | +| show-close-button | 是否显示列表底部按钮 | *boolean* | `true` | +| close-button-text | 列表底部按钮文字 | *string* | `不使用优惠` | +| input-placeholder | 输入框文字提示 | *string* | `请输入优惠码` | +| show-exchange-bar | 是否展示兑换栏 | *boolean* | `true` | +| currency | 货币符号 | *string* | `¥` | +| empty-image `v2.1.0` | 列表为空时的占位图 | *string* | `https://img.yzcdn.cn/vant/coupon-empty.png` | +| show-count `v2.3.0` | 是否展示可用 / 不可用数量 | *boolean* | `true` | ### CouponList Events diff --git a/src/datetime-picker/README.md b/src/datetime-picker/README.md index e9eb87a59..6ba24aeb2 100644 --- a/src/datetime-picker/README.md +++ b/src/datetime-picker/README.md @@ -151,25 +151,25 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| type | Can be set to `date` `time`
`year-month` | *string* | `datetime` | - | -| min-date | Min date | *Date* | Ten years ago on January 1 | - | -| max-date | Max date | *Date* | Ten years later on December 31 | - | -| min-hour | Min hour for `time` type | *number* | `0` | - | -| max-hour | Max hour for `time` type | *number* | `23` | - | -| min-minute | Max minute for `time` type | *number* | `0` | - | -| max-minute | Max minute for `time` type | *number* | `59` | - | -| filter | Option filter | *(type, values) => values* | - | - | -| formatter | Option text formatter | *(type, value) => value* | - | - | -| title | Toolbar title | *string* | `''` | - | -| show-toolbar | Whether to show toolbar | *boolean* | `true` | - | -| loading | Whether to show loading prompt | *boolean* | `false` | - | -| item-height | Option height | *number* | `44` | - | -| confirm-button-text | Text of confirm button | *string* | `Confirm` | - | -| cancel-button-text | Text of cancel button | *string* | `Cancel` | - | -| visible-item-count | Count of visible columns | *number* | `5` | - | -| swipe-duration | Duration of the momentum animation，unit `ms` | *number* | `1000` | 2.2.13 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| type | Can be set to `date` `time`
`year-month` | *string* | `datetime` | +| min-date | Min date | *Date* | Ten years ago on January 1 | +| max-date | Max date | *Date* | Ten years later on December 31 | +| min-hour | Min hour for `time` type | *number* | `0` | +| max-hour | Max hour for `time` type | *number* | `23` | +| min-minute | Max minute for `time` type | *number* | `0` | +| max-minute | Max minute for `time` type | *number* | `59` | +| filter | Option filter | *(type, values) => values* | - | +| formatter | Option text formatter | *(type, value) => value* | - | +| title | Toolbar title | *string* | `''` | +| show-toolbar | Whether to show toolbar | *boolean* | `true` | +| loading | Whether to show loading prompt | *boolean* | `false` | +| item-height | Option height | *number* | `44` | +| confirm-button-text | Text of confirm button | *string* | `Confirm` | +| cancel-button-text | Text of cancel button | *string* | `Cancel` | +| visible-item-count | Count of visible columns | *number* | `5` | +| swipe-duration `v2.2.13` | Duration of the momentum animation，unit `ms` | *number* | `1000` | ### Events @@ -183,6 +183,6 @@ export default { Use [ref](https://vuejs.org/v2/api/#ref) to get DatetimePicker instance and call instance methods -| Name | Description | Attribute | Return value | Version | -|------|------|------|------|------| -| getPicker | get Picker instance | - | - | 2.4.0 | +| Name | Description | Attribute | Return value | +|------|------|------|------| +| getPicker `v2.4.0` | get Picker instance | - | - | diff --git a/src/datetime-picker/README.zh-CN.md b/src/datetime-picker/README.zh-CN.md index d230b5563..4ce6823b4 100644 --- a/src/datetime-picker/README.zh-CN.md +++ b/src/datetime-picker/README.zh-CN.md @@ -155,25 +155,25 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| type | 类型，可选值为 `date`
`time` `year-month` | *string* | `datetime` | - | -| min-date | 可选的最小时间，精确到分钟 | *Date* | 十年前 | - | -| max-date | 可选的最大时间，精确到分钟 | *Date* | 十年后 | - | -| min-hour | 可选的最小小时，针对 time 类型 | *number* | `0` | - | -| max-hour | 可选的最大小时，针对 time 类型 | *number* | `23` | - | -| min-minute | 可选的最小分钟，针对 time 类型 | *number* | `0` | - | -| max-minute | 可选的最大分钟，针对 time 类型 | *number* | `59` | - | -| filter | 选项过滤函数 | *(type, values) => values* | - | - | -| formatter | 选项格式化函数 | *(type, value) => value* | - | - | -| title | 顶部栏标题 | *string* | `''` | - | -| show-toolbar | 是否显示顶部栏 | *boolean* | `true` | - | -| loading | 是否显示加载状态 | *boolean* | `false` | - | -| item-height | 选项高度 | *number* | `44` | - | -| confirm-button-text | 确认按钮文字 | *string* | `确认` | - | -| cancel-button-text | 取消按钮文字 | *string* | `取消` | - | -| visible-item-count | 可见的选项个数 | *number* | `5` | - | -| swipe-duration | 快速滑动时惯性滚动的时长，单位`ms` | *number* | `1000` | 2.2.13 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| type | 类型，可选值为 `date`
`time` `year-month` | *string* | `datetime` | +| min-date | 可选的最小时间，精确到分钟 | *Date* | 十年前 | +| max-date | 可选的最大时间，精确到分钟 | *Date* | 十年后 | +| min-hour | 可选的最小小时，针对 time 类型 | *number* | `0` | +| max-hour | 可选的最大小时，针对 time 类型 | *number* | `23` | +| min-minute | 可选的最小分钟，针对 time 类型 | *number* | `0` | +| max-minute | 可选的最大分钟，针对 time 类型 | *number* | `59` | +| filter | 选项过滤函数 | *(type, values) => values* | - | +| formatter | 选项格式化函数 | *(type, value) => value* | - | +| title | 顶部栏标题 | *string* | `''` | +| show-toolbar | 是否显示顶部栏 | *boolean* | `true` | +| loading | 是否显示加载状态 | *boolean* | `false` | +| item-height | 选项高度 | *number* | `44` | +| confirm-button-text | 确认按钮文字 | *string* | `确认` | +| cancel-button-text | 取消按钮文字 | *string* | `取消` | +| visible-item-count | 可见的选项个数 | *number* | `5` | +| swipe-duration `v2.2.13` | 快速滑动时惯性滚动的时长，单位`ms` | *number* | `1000` | ### Events @@ -187,9 +187,9 @@ export default { 通过 [ref](https://cn.vuejs.org/v2/api/#ref) 可以获取到 DatetimePicker 实例并调用实例方法 -| 方法名 | 说明 | 参数 | 返回值 | 版本 | -|------|------|------|------|------| -| getPicker | 获取 Picker 实例，用于调用 Picker 的[实例方法](#/zh-CN/picker#fang-fa) | - | - | 2.4.0 | +| 方法名 | 说明 | 参数 | 返回值 | +|------|------|------|------| +| getPicker `v2.4.0` | 获取 Picker 实例，用于调用 Picker 的[实例方法](#/zh-CN/picker#fang-fa) | - | - | ## 常见问题 diff --git a/src/dialog/README.md b/src/dialog/README.md index 6a0caaae1..7f1fe7ea7 100644 --- a/src/dialog/README.md +++ b/src/dialog/README.md @@ -116,54 +116,54 @@ export default { ### Options -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| title | Title | *string* | - | - | -| width | Width | *string \| number* | `320px` | 2.2.7 | -| message | Message | *string* | - | - | -| messageAlign | Message text align，can be set to `left` `right` | *string* | `center` | - | -| className | Custom className | *any* | - | - | -| showConfirmButton | Whether to show confirm button | *boolean* | `true` | - | -| showCancelButton | Whether to show cancel button | *boolean* | `false` | - | -| cancelButtonText | Cancel button text | *string* | `Cancel` | - | -| cancelButtonColor | Cancel button color | *string* | `#000` | - | -| confirmButtonText | Confirm button text | *string* | `Confirm` | - | -| confirmButtonColor | Confirm button color | *string* | `#1989fa` | - | -| overlay | Whether to show overlay | *boolean* | `true` | - | -| overlayClass | Custom overlay class | *string* | - | 2.2.7 | -| overlayStyle | Custom overlay style | *object* | - | 2.2.7 | -| closeOnPopstate | Whether to close when popstate | *boolean* | `false` | 2.0.5 | -| closeOnClickOverlay | Whether to close when click overlay | *boolean* | `false` | - | -| lockScroll | Whether to lock body scroll | *boolean* | `true` | - | -| beforeClose | Callback before close,
call done() to close dialog,
call done(false) to cancel loading | (action: string, done: Function) => void | - | - | -| transition | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | *string* | - | 2.2.6 | -| getContainer | Return the mount node for Dialog | *string \| () => Element* | `body` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| title | Title | *string* | - | +| width `v2.2.7` | Width | *string \| number* | `320px` | +| message | Message | *string* | - | +| messageAlign | Message text align，can be set to `left` `right` | *string* | `center` | +| className | Custom className | *any* | - | +| showConfirmButton | Whether to show confirm button | *boolean* | `true` | +| showCancelButton | Whether to show cancel button | *boolean* | `false` | +| cancelButtonText | Cancel button text | *string* | `Cancel` | +| cancelButtonColor | Cancel button color | *string* | `#000` | +| confirmButtonText | Confirm button text | *string* | `Confirm` | +| confirmButtonColor | Confirm button color | *string* | `#1989fa` | +| overlay | Whether to show overlay | *boolean* | `true` | +| overlayClass `v2.2.7` | Custom overlay class | *string* | - | +| overlayStyle `v2.2.7` | Custom overlay style | *object* | - | +| closeOnPopstate `v2.0.5` | Whether to close when popstate | *boolean* | `false` | +| closeOnClickOverlay | Whether to close when click overlay | *boolean* | `false` | +| lockScroll | Whether to lock body scroll | *boolean* | `true` | +| beforeClose | Callback before close,
call done() to close dialog,
call done(false) to cancel loading | (action: string, done: Function) => void | - | +| transition `v2.2.6` | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | *string* | - | +| getContainer | Return the mount node for Dialog | *string \| () => Element* | `body` | ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Whether to show dialog | *boolean* | - | - | -| title | Title | *string* | - | - | -| width | Width | *string \| number* | `320px` | 2.2.7 | -| message | Message | *string* | - | - | -| message-align | Message align，can be set to `left` `right` | *string* | `center` | - | -| show-confirm-button | Whether to show confirm button | *boolean* | `true` | - | -| show-cancel-button | Whether to show cancel button | *boolean* | `false` | - | -| cancel-button-text | Cancel button text | *string* | `Cancel` | - | -| cancel-button-color | Cancel button color | *string* | `#000` | - | -| confirm-button-text | Confirm button text | *string* | `Confirm` | - | -| confirm-button-color | Confirm button color | *string* | `#1989fa` | - | -| overlay | Whether to show overlay | *boolean* | `true` | - | -| overlay-class | Custom overlay class | *string* | - | 2.2.7 | -| overlay-style | Custom overlay style | *object* | - | 2.2.7 | -| close-on-popstate | Whether to close when popstate | *boolean* | `false` | 2.0.5 | -| close-on-click-overlay | Whether to close when click overlay | *boolean* | `false` | - | -| lazy-render | Whether to lazy render util appeared | *boolean* | `true` | - | -| lock-scroll | Whether to lock background scroll | *boolean* | `true` | - | -| before-close | Callback before close,
call done() to close dialog,
call done(false) to cancel loading | (action: string, done: Function) => void | - | - | -| transition | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | *string* | - | 2.2.6 | -| get-container | Return the mount node for Dialog | *string \| () => Element* | - | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Whether to show dialog | *boolean* | - | +| title | Title | *string* | - | +| width `v2.2.7` | Width | *string \| number* | `320px` | +| message | Message | *string* | - | +| message-align | Message align，can be set to `left` `right` | *string* | `center` | +| show-confirm-button | Whether to show confirm button | *boolean* | `true` | +| show-cancel-button | Whether to show cancel button | *boolean* | `false` | +| cancel-button-text | Cancel button text | *string* | `Cancel` | +| cancel-button-color | Cancel button color | *string* | `#000` | +| confirm-button-text | Confirm button text | *string* | `Confirm` | +| confirm-button-color | Confirm button color | *string* | `#1989fa` | +| overlay | Whether to show overlay | *boolean* | `true` | +| overlay-class `v2.2.7` | Custom overlay class | *string* | - | +| overlay-style `v2.2.7` | Custom overlay style | *object* | - | +| close-on-popstate `v2.0.5` | Whether to close when popstate | *boolean* | `false` | +| close-on-click-overlay | Whether to close when click overlay | *boolean* | `false` | +| lazy-render | Whether to lazy render util appeared | *boolean* | `true` | +| lock-scroll | Whether to lock background scroll | *boolean* | `true` | +| before-close | Callback before close,
call done() to close dialog,
call done(false) to cancel loading | (action: string, done: Function) => void | - | +| transition `v2.2.6` | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | *string* | - | +| get-container | Return the mount node for Dialog | *string \| () => Element* | - | ### Events diff --git a/src/dialog/README.zh-CN.md b/src/dialog/README.zh-CN.md index 506916114..38ebc2763 100644 --- a/src/dialog/README.zh-CN.md +++ b/src/dialog/README.zh-CN.md @@ -145,56 +145,56 @@ export default { 通过函数调用 `Dialog` 时，支持传入以下选项： -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| title | 标题 | *string* | - | - | -| width | 弹窗宽度，默认单位为`px` | *string \| number* | `320px` | 2.2.7 | -| message | 文本内容，支持通过`\n`换行 | *string* | - | - | -| messageAlign | 内容对齐方式，可选值为`left` `right` | *string* | `center` | - | -| className | 自定义类名 | *any* | - | - | -| showConfirmButton | 是否展示确认按钮 | *boolean* | `true` | - | -| showCancelButton | 是否展示取消按钮 | *boolean* | `false` | - | -| confirmButtonText | 确认按钮文案 | *string* | `确认` | - | -| confirmButtonColor | 确认按钮颜色 | *string* | `#1989fa` | - | -| cancelButtonText | 取消按钮文案 | *string* | `取消` | - | -| cancelButtonColor | 取消按钮颜色 | *string* | `#000` | - | -| overlay | 是否展示遮罩层 | *boolean* | `true` | - | -| overlayClass | 自定义遮罩层类名 | *string* | - | 2.2.7 | -| overlayStyle | 自定义遮罩层样式 | *object* | - | 2.2.7 | -| closeOnPopstate | 是否在页面回退时自动关闭 | *boolean* | `false` | 2.0.5 | -| closeOnClickOverlay | 是否在点击遮罩层后关闭弹窗 | *boolean* | `false` | - | -| lockScroll | 是否锁定背景滚动 | *boolean* | `true` | - | -| beforeClose | 关闭前的回调函数，
调用 done() 后关闭弹窗，
调用 done(false) 阻止弹窗关闭 | *(action, done) => void* | - | - | -| transition | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | *string* | - | 2.2.6 | -| getContainer | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | `body` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| title | 标题 | *string* | - | +| width `v2.2.7` | 弹窗宽度，默认单位为`px` | *string \| number* | `320px` | +| message | 文本内容，支持通过`\n`换行 | *string* | - | +| messageAlign | 内容对齐方式，可选值为`left` `right` | *string* | `center` | +| className | 自定义类名 | *any* | - | +| showConfirmButton | 是否展示确认按钮 | *boolean* | `true` | +| showCancelButton | 是否展示取消按钮 | *boolean* | `false` | +| confirmButtonText | 确认按钮文案 | *string* | `确认` | +| confirmButtonColor | 确认按钮颜色 | *string* | `#1989fa` | +| cancelButtonText | 取消按钮文案 | *string* | `取消` | +| cancelButtonColor | 取消按钮颜色 | *string* | `#000` | +| overlay | 是否展示遮罩层 | *boolean* | `true` | +| overlayClass `v2.2.7` | 自定义遮罩层类名 | *string* | - | +| overlayStyle `v2.2.7` | 自定义遮罩层样式 | *object* | - | +| closeOnPopstate `v2.0.5` | 是否在页面回退时自动关闭 | *boolean* | `false` | +| closeOnClickOverlay | 是否在点击遮罩层后关闭弹窗 | *boolean* | `false` | +| lockScroll | 是否锁定背景滚动 | *boolean* | `true` | +| beforeClose | 关闭前的回调函数，
调用 done() 后关闭弹窗，
调用 done(false) 阻止弹窗关闭 | *(action, done) => void* | - | +| transition `v2.2.6` | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | *string* | - | +| getContainer | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | `body` | ### Props 通过组件调用 `Dialog` 时，支持以下 Props： -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 是否显示弹窗 | *boolean* | - | - | -| title | 标题 | *string* | - | - | -| width | 弹窗宽度，默认单位为`px` | *string \| number* | `320px` | 2.2.7 | -| message | 文本内容，支持通过`\n`换行 | *string* | - | - | -| message-align | 内容对齐方式，可选值为`left` `right` | *string* | `center` | - | -| show-confirm-button | 是否展示确认按钮 | *boolean* | `true` | - | -| show-cancel-button | 是否展示取消按钮 | *boolean* | `false` | - | -| confirm-button-text | 确认按钮文案 | *string* | `确认` | - | -| confirm-button-color | 确认按钮颜色 | *string* | `#1989fa` | - | -| cancel-button-text | 取消按钮文案 | *string* | `取消` | - | -| cancel-button-color | 取消按钮颜色 | *string* | `#000` | - | -| overlay | 是否展示遮罩层 | *boolean* | `true` | - | -| overlay-class | 自定义遮罩层类名 | *string* | - | 2.2.7 | -| overlay-style | 自定义遮罩层样式 | *object* | - | 2.2.7 | -| close-on-popstate | 是否在页面回退时自动关闭 | *boolean* | `false` | 2.0.5 | -| close-on-click-overlay | 是否在点击遮罩层后关闭弹窗 | *boolean* | `false` | - | -| lazy-render | 是否在显示弹层时才渲染节点 | *boolean* | `true` | - | -| lock-scroll | 是否锁定背景滚动 | *boolean* | `true` | - | -| before-close | 关闭前的回调函数，
调用 done() 后关闭弹窗，
调用 done(false) 阻止弹窗关闭 | *(action, done) => void* | - | - | -| transition | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | *string* | - | 2.2.6 | -| get-container | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 是否显示弹窗 | *boolean* | - | +| title | 标题 | *string* | - | +| width `v2.2.7` | 弹窗宽度，默认单位为`px` | *string \| number* | `320px` | +| message | 文本内容，支持通过`\n`换行 | *string* | - | +| message-align | 内容对齐方式，可选值为`left` `right` | *string* | `center` | +| show-confirm-button | 是否展示确认按钮 | *boolean* | `true` | +| show-cancel-button | 是否展示取消按钮 | *boolean* | `false` | +| confirm-button-text | 确认按钮文案 | *string* | `确认` | +| confirm-button-color | 确认按钮颜色 | *string* | `#1989fa` | +| cancel-button-text | 取消按钮文案 | *string* | `取消` | +| cancel-button-color | 取消按钮颜色 | *string* | `#000` | +| overlay | 是否展示遮罩层 | *boolean* | `true` | +| overlay-class `v2.2.7` | 自定义遮罩层类名 | *string* | - | +| overlay-style `v2.2.7` | 自定义遮罩层样式 | *object* | - | +| close-on-popstate `v2.0.5` | 是否在页面回退时自动关闭 | *boolean* | `false` | +| close-on-click-overlay | 是否在点击遮罩层后关闭弹窗 | *boolean* | `false` | +| lazy-render | 是否在显示弹层时才渲染节点 | *boolean* | `true` | +| lock-scroll | 是否锁定背景滚动 | *boolean* | `true` | +| before-close | 关闭前的回调函数，
调用 done() 后关闭弹窗，
调用 done(false) 阻止弹窗关闭 | *(action, done) => void* | - | +| transition `v2.2.6` | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | *string* | - | +| get-container | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | - | ### Events diff --git a/src/divider/README.md b/src/divider/README.md index e935d69cf..9b4280dfe 100644 --- a/src/divider/README.md +++ b/src/divider/README.md @@ -48,11 +48,11 @@ Vue.use(Divider); ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| dashed | Whether to use dashed border | *boolean* | `false` | - | -| hairline | Whether to use hairline | *boolean* | `true` | - | -| content-position | Content position，can be set to `left` `right` | *string* | `center` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| dashed | Whether to use dashed border | *boolean* | `false` | +| hairline | Whether to use hairline | *boolean* | `true` | +| content-position | Content position，can be set to `left` `right` | *string* | `center` | ### Slots diff --git a/src/divider/README.zh-CN.md b/src/divider/README.zh-CN.md index 74e3737d9..26d87493a 100644 --- a/src/divider/README.zh-CN.md +++ b/src/divider/README.zh-CN.md @@ -58,11 +58,11 @@ Vue.use(Divider); ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| dashed | 是否使用虚线 | *boolean* | `false` | - | -| hairline | 是否使用 0.5px 线 | *boolean* | `true` | - | -| content-position | 内容位置，可选值为`left` `right` | *string* | `center` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| dashed | 是否使用虚线 | *boolean* | `false` | +| hairline | 是否使用 0.5px 线 | *boolean* | `true` | +| content-position | 内容位置，可选值为`left` `right` | *string* | `center` | ### Slots diff --git a/src/dropdown-menu/README.md b/src/dropdown-menu/README.md index 520e9bc27..98d487ba1 100644 --- a/src/dropdown-menu/README.md +++ b/src/dropdown-menu/README.md @@ -110,26 +110,26 @@ Use `active-color` prop to custom active color of the title and options ### DropdownMenu Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| active-color | Active color of title and option | *string* | `#1989fa` | - | -| z-index | z-index of menu item | *number* | `10` | - | -| duration | Transition duration, unit second | *number* | `0.2` | - | -| direction | Expand direction, can be set to `up` | *string* | `down` | 2.0.1 | -| overlay | Whether to show overlay | *boolean* | `true` | - | -| close-on-click-overlay | Whether to close when click overlay | *boolean* | `true` | - | -| close-on-click-outside | Whether to close when click outside | *boolean* | `true` | 2.0.7 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| active-color | Active color of title and option | *string* | `#1989fa` | +| z-index | z-index of menu item | *number* | `10` | +| duration | Transition duration, unit second | *number* | `0.2` | +| direction `v2.0.1` | Expand direction, can be set to `up` | *string* | `down` | +| overlay | Whether to show overlay | *boolean* | `true` | +| close-on-click-overlay | Whether to close when click overlay | *boolean* | `true` | +| close-on-click-outside `v2.0.7` | Whether to close when click outside | *boolean* | `true` | ### DropdownItem Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| value | Value of current option，can use `v-model` | *string \| number* | - | - | -| title | Item title | *string* | Text of selected option | - | -| options | Options | *Option[]* | `[]` | - | -| disabled | Whether to disable dropdown item | *boolean* | `false` | - | -| title-class | Title class | *string* | - | - | -| get-container | Return the mount node for menu | *string \| () => Element* | - | 2.2.4 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| value | Value of current option，can use `v-model` | *string \| number* | - | +| title | Item title | *string* | Text of selected option | +| options | Options | *Option[]* | `[]` | +| disabled | Whether to disable dropdown item | *boolean* | `false` | +| title-class | Title class | *string* | - | +| get-container `v2.2.4` | Return the mount node for menu | *string \| () => Element* | - | ### DropdownItem Events diff --git a/src/dropdown-menu/README.zh-CN.md b/src/dropdown-menu/README.zh-CN.md index c6d282711..778c469e9 100644 --- a/src/dropdown-menu/README.zh-CN.md +++ b/src/dropdown-menu/README.zh-CN.md @@ -114,26 +114,26 @@ export default { ### DropdownMenu Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| active-color | 菜单标题和选项的选中态颜色 | *string* | `#1989fa` | - | -| z-index | 菜单栏 z-index 层级 | *number* | `10` | - | -| duration | 动画时长，单位秒 | *number* | `0.2` | - | -| direction | 菜单展开方向，可选值为`up` | *string* | `down` | 2.0.1 | -| overlay | 是否显示遮罩层 | *boolean* | `true` | - | -| close-on-click-overlay | 是否在点击遮罩层后关闭菜单 | *boolean* | `true` | - | -| close-on-click-outside | 是否在点击外部元素后关闭菜单 | *boolean* | `true` | 2.0.7 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| active-color | 菜单标题和选项的选中态颜色 | *string* | `#1989fa` | +| z-index | 菜单栏 z-index 层级 | *number* | `10` | +| duration | 动画时长，单位秒 | *number* | `0.2` | +| direction `v2.0.1` | 菜单展开方向，可选值为`up` | *string* | `down` | +| overlay | 是否显示遮罩层 | *boolean* | `true` | +| close-on-click-overlay | 是否在点击遮罩层后关闭菜单 | *boolean* | `true` | +| close-on-click-outside `v2.0.7` | 是否在点击外部元素后关闭菜单 | *boolean* | `true` | ### DropdownItem Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| value | 当前选中项对应的 value，可以通过`v-model`双向绑定 | *string \| number* | - | - | -| title | 菜单项标题 | *string* | 当前选中项文字 | - | -| options | 选项数组 | *Option[]* | `[]` | - | -| disabled | 是否禁用菜单 | *boolean* | `false` | - | -| title-class | 标题额外类名 | *string* | - | - | -| get-container | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | - | 2.2.4 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| value | 当前选中项对应的 value，可以通过`v-model`双向绑定 | *string \| number* | - | +| title | 菜单项标题 | *string* | 当前选中项文字 | +| options | 选项数组 | *Option[]* | `[]` | +| disabled | 是否禁用菜单 | *boolean* | `false` | +| title-class | 标题额外类名 | *string* | - | +| get-container `v2.2.4` | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | - | ### DropdownItem Events diff --git a/src/field/README.md b/src/field/README.md index d9d404dfc..8b9f109fd 100644 --- a/src/field/README.md +++ b/src/field/README.md @@ -199,35 +199,35 @@ Textarea Field can be auto resize when has `autosize` prop ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| value | Field value | *string \| number* | - | - | -| label | Field label | *string* | - | - | -| type | Input type, can be set to `tel` `digit`
`number` `textarea` `password` | *string* | `text` | - | -| size | Size，can be set to `large` | *string* | - | - | -| maxlength | Max length of value | *string \| number* | - | - | -| placeholder | Placeholder | *string* | - | - | -| border | Whether to show inner border | *boolean* | `true` | - | -| disabled | Whether to disable field | *boolean* | `false` | - | -| readonly | Whether to be readonly | *boolean* | `false` | - | -| required | Whether to show required mark | *boolean* | `false` | - | -| clearable | Whether to be clearable | *boolean* | `false` | - | -| 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` | 2.2.8 | -| error | Whether to show error info | *boolean* | `false` | - | -| formatter | Input value formatter | *Function* | - | 2.4.2 | -| arrow-direction | Can be set to `left` `up` `down` | *string* | - | 2.0.4 | -| error-message | Error message | *string* | `''` | - | -| label-class | Label className | *any* | - | - | -| label-width | Label width | *string \| number* | `90px` | - | -| label-align | Label text align, can be set to `center` `right` | *string* | `left` | - | -| input-align | Input text align, can be set to `center` `right` | *string* | `left` | - | -| error-message-align | Error message text align, can be set to `center` `right` | *string* | `left` | - | -| autosize | Textarea auto resize，can accpet an object,
e.g. { maxHeight: 100, minHeight: 50 } | *boolean \| object* | `false` | - | -| left-icon | Left side icon name | *string* | - | - | -| right-icon | Right side icon name | *string* | - | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| value | Field value | *string \| number* | - | +| label | Field label | *string* | - | +| type | Input type, can be set to `tel` `digit`
`number` `textarea` `password` | *string* | `text` | +| size | Size，can be set to `large` | *string* | - | +| maxlength | Max length of value | *string \| number* | - | +| placeholder | Placeholder | *string* | - | +| border | Whether to show inner border | *boolean* | `true` | +| disabled | Whether to disable field | *boolean* | `false` | +| readonly | Whether to be readonly | *boolean* | `false` | +| required | Whether to show required mark | *boolean* | `false` | +| clearable | Whether to be clearable | *boolean* | `false` | +| 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 `v2.2.8` | Whether to show word limit, need to set the `maxlength` prop | *boolean* | `false` | +| error | Whether to show error info | *boolean* | `false` | +| formatter `v2.4.2` | Input value formatter | *Function* | - | +| arrow-direction `v2.0.4` | Can be set to `left` `up` `down` | *string* | - | +| error-message | Error message | *string* | `''` | +| label-class | Label className | *any* | - | +| label-width | Label width | *string \| number* | `90px` | +| label-align | Label text align, can be set to `center` `right` | *string* | `left` | +| input-align | Input text align, can be set to `center` `right` | *string* | `left` | +| error-message-align | Error message text align, can be set to `center` `right` | *string* | `left` | +| autosize | Textarea auto resize，can accpet an object,
e.g. { maxHeight: 100, minHeight: 50 } | *boolean \| object* | `false` | +| left-icon | Left side icon name | *string* | - | +| right-icon | Right side icon name | *string* | - | ### Events diff --git a/src/field/README.zh-CN.md b/src/field/README.zh-CN.md index 7daae8cda..99e83f4b6 100644 --- a/src/field/README.zh-CN.md +++ b/src/field/README.zh-CN.md @@ -218,35 +218,35 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| label | 输入框左侧文本 | *string* | - | - | -| value | 当前输入的值 | *string \| number* | - | - | -| type | 输入框类型, 可选值为 `tel` `digit`
`number` `textarea` `password` 等 | *string* | `text` | - | -| size | 大小，可选值为 `large` | *string* | - | - | -| maxlength | 输入的最大字符数 | *string \| number* | - | - | -| placeholder | 占位提示文字 | *string* | - | - | -| border | 是否显示内边框 | *boolean* | `true` | - | -| disabled | 是否禁用输入框 | *boolean* | `false` | - | -| readonly | 是否只读 | *boolean* | `false` | - | -| required | 是否显示表单必填星号 | *boolean* | `false` | - | -| clearable | 是否启用清除控件 | *boolean* | `false` | - | -| clickable | 是否开启点击反馈 | *boolean* | `false` | - | -| is-link | 是否展示右侧箭头并开启点击反馈 | *boolean* | `false` | - | -| autofocus | 是否自动聚焦，iOS 系统不支持该属性 | *boolean* | `false` | - | -| show-word-limit | 是否显示字数统计，需要设置`maxlength`属性 | *boolean* | `false` | 2.2.8 | -| error | 是否将输入内容标红 | *boolean* | `false` | - | -| formatter | 输入内容格式化函数 | *Function* | - | 2.4.2 | -| arrow-direction | 箭头方向，可选值为 `left` `up` `down` | *string* | - | 2.0.4 | -| error-message | 底部错误提示文案，为空时不展示 | *string* | `''` | - -| label-class | 左侧文本额外类名 | *any* | - | - | -| label-width | 左侧文本宽度，默认单位为`px` | *string \| number* | `90px` | - | -| label-align | 左侧文本对齐方式，可选值为 `center` `right` | *string* | `left` | - | -| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` | - | -| error-message-align | 错误提示文案对齐方式，可选值为 `center` `right` | *string* | `left` | - | -| autosize | 是否自适应内容高度，只对 textarea 有效，
可传入对象,如 { maxHeight: 100, minHeight: 50 }，
单位为`px` | *boolean \| object* | `false` | - | -| left-icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | - | -| right-icon | 右侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| label | 输入框左侧文本 | *string* | - | +| value | 当前输入的值 | *string \| number* | - | +| type | 输入框类型, 可选值为 `tel` `digit`
`number` `textarea` `password` 等 | *string* | `text` | +| size | 大小，可选值为 `large` | *string* | - | +| maxlength | 输入的最大字符数 | *string \| number* | - | +| placeholder | 占位提示文字 | *string* | - | +| border | 是否显示内边框 | *boolean* | `true` | +| disabled | 是否禁用输入框 | *boolean* | `false` | +| readonly | 是否只读 | *boolean* | `false` | +| required | 是否显示表单必填星号 | *boolean* | `false` | +| clearable | 是否启用清除控件 | *boolean* | `false` | +| clickable | 是否开启点击反馈 | *boolean* | `false` | +| is-link | 是否展示右侧箭头并开启点击反馈 | *boolean* | `false` | +| autofocus | 是否自动聚焦，iOS 系统不支持该属性 | *boolean* | `false` | +| show-word-limit `v2.2.8` | 是否显示字数统计，需要设置`maxlength`属性 | *boolean* | `false` | +| error | 是否将输入内容标红 | *boolean* | `false` | +| formatter `v2.4.2` | 输入内容格式化函数 | *Function* | - | +| arrow-direction `v2.0.4` | 箭头方向，可选值为 `left` `up` `down` | *string* | - | +| error-message | 底部错误提示文案，为空时不展示 | *string* | `''` | +| label-class | 左侧文本额外类名 | *any* | - | +| label-width | 左侧文本宽度，默认单位为`px` | *string \| number* | `90px` | +| label-align | 左侧文本对齐方式，可选值为 `center` `right` | *string* | `left` | +| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` | +| error-message-align | 错误提示文案对齐方式，可选值为 `center` `right` | *string* | `left` | +| autosize | 是否自适应内容高度，只对 textarea 有效，
可传入对象,如 { maxHeight: 100, minHeight: 50 }，
单位为`px` | *boolean \| object* | `false` | +| left-icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | +| right-icon | 右侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | ### Events diff --git a/src/goods-action/README.md b/src/goods-action/README.md index 0b681e6c8..3913991db 100644 --- a/src/goods-action/README.md +++ b/src/goods-action/README.md @@ -71,35 +71,35 @@ Use `info` prop to show badge in icon ### GoodsAction Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `false` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `false` | ### GoodsActionIcon Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| text | Button text | *string* | - | - | -| icon | Icon | *string* | - | - | -| icon-class | Icon class name | *any* | `''` | - | -| info | Content of the badge | *string \| number* | - | - | -| 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` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| text | Button text | *string* | - | +| icon | Icon | *string* | - | +| icon-class | Icon class name | *any* | `''` | +| info | Content of the badge | *string \| number* | - | +| 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` | ### GoodsActionButton Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| text | Button text | *string* | - | - | -| type | Button type, Can be set to `primary` `info` `warning` `danger` | *string* | `default` | - | -| color | Button color, support linear-gradient | *string* | - | 2.1.8 | -| primary | Is primary button (red color) | *boolean* | `false` | - | -| disabled | Whether to disable button | *boolean* | `false` | - | -| loading | Whether show loading status | *boolean* | `false` | - | -| 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` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| text | Button text | *string* | - | +| type | Button type, Can be set to `primary` `info` `warning` `danger` | *string* | `default` | +| color `v2.1.8` | Button color, support linear-gradient | *string* | - | +| primary | Is primary button (red color) | *boolean* | `false` | +| disabled | Whether to disable button | *boolean* | `false` | +| loading | Whether show loading status | *boolean* | `false` | +| 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` | ### GoodsActionIcon Slots diff --git a/src/goods-action/README.zh-CN.md b/src/goods-action/README.zh-CN.md index c1e4ceb14..e13ca1098 100644 --- a/src/goods-action/README.zh-CN.md +++ b/src/goods-action/README.zh-CN.md @@ -73,34 +73,34 @@ export default { ### GoodsAction Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| safe-area-inset-bottom | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| safe-area-inset-bottom | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` | ### GoodsActionIcon Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| text | 按钮文字 | *string* | - | - | -| icon | 图标 | *string* | - | - | -| icon-class | 图标额外类名 | *any* | - | - | -| info | 图标右上角徽标的内容 | *string \| number* | - | - | -| url | 点击后跳转的链接地址 | *string* | - | - | -| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | - | -| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| text | 按钮文字 | *string* | - | +| icon | 图标 | *string* | - | +| icon-class | 图标额外类名 | *any* | - | +| info | 图标右上角徽标的内容 | *string \| number* | - | +| url | 点击后跳转的链接地址 | *string* | - | +| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | +| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` | ### GoodsActionButton Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| text | 按钮文字 | *string* | - | - | -| type | 按钮类型，可选值为 `primary` `info` `warning` `danger` | *string* | `default` | - | -| color | 按钮颜色，支持传入`linear-gradient`渐变色 | *string* | - | 2.1.8 | -| disabled | 是否禁用按钮 | *boolean* | `false` | - | - | -| loading | 是否显示为加载状态 | *boolean* | `false` | - | - | -| url | 点击后跳转的链接地址 | *string* | - | - | -| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | - | -| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| text | 按钮文字 | *string* | - | +| type | 按钮类型，可选值为 `primary` `info` `warning` `danger` | *string* | `default` | +| color `v2.1.8` | 按钮颜色，支持传入`linear-gradient`渐变色 | *string* | - | +| disabled | 是否禁用按钮 | *boolean* | `false` | - | +| loading | 是否显示为加载状态 | *boolean* | `false` | - | +| url | 点击后跳转的链接地址 | *string* | - | +| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | +| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` | ### GoodsActionIcon Slots diff --git a/src/grid/README.md b/src/grid/README.md index 8a6c7d41c..7b9cacaa4 100644 --- a/src/grid/README.md +++ b/src/grid/README.md @@ -99,27 +99,27 @@ Vue.use(Grid).use(GridItem); ### Grid Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| column-num | Column Num | *number* | `4` | 2.0.4 | -| gutter | Gutter | *string \| number* | `0` | - | -| border | Whether to show border | *boolean* | `true` | - | -| center | Whether to center content | *boolean* | `true` | - | -| square | Whether to be square shape | *boolean* | `false` | - | -| clickable | Whether to show click feedback when clicked | *boolean* | `false` | - | -| icon-size | Icon size | *string \| number* | `28px` | 2.2.6 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| column-num `v2.0.4` | Column Num | *number* | `4` | +| gutter | Gutter | *string \| number* | `0` | +| border | Whether to show border | *boolean* | `true` | +| center | Whether to center content | *boolean* | `true` | +| square | Whether to be square shape | *boolean* | `false` | +| clickable | Whether to show click feedback when clicked | *boolean* | `false` | +| icon-size `v2.2.6` | Icon size | *string \| number* | `28px` | ### GridItem Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| text | Text | *string* | - | - | -| icon | Icon name or URL | *string* | - | - | -| dot | Whether to show red dot | *boolean* | `false` | 2.2.1 | -| info | Content of the badge | *string \| number* | - | 2.2.1 | -| 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` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| text | Text | *string* | - | +| icon | Icon name or URL | *string* | - | +| dot `v2.2.1` | Whether to show red dot | *boolean* | `false` | +| info `v2.2.1` | Content of the badge | *string \| number* | - | +| 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` | ### GridItem Events diff --git a/src/grid/README.zh-CN.md b/src/grid/README.zh-CN.md index eccbed496..526294d47 100644 --- a/src/grid/README.zh-CN.md +++ b/src/grid/README.zh-CN.md @@ -117,27 +117,27 @@ Vue.use(Grid).use(GridItem); ### Grid Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| column-num | 列数 | *number* | `4` | 2.0.4 | -| gutter | 格子之间的间距，默认单位为`px` | *string \| number* | `0` | - | -| border | 是否显示边框 | *boolean* | `true` | - | -| center | 是否将格子内容居中显示 | *boolean* | `true` | - | -| square | 是否将格子固定为正方形 | *boolean* | `false` | - | -| clickable | 是否开启格子点击反馈 | *boolean* | `false` | - | -| icon-size | 图标大小，默认单位为`px` | *string \| number* | `28px` | 2.2.6 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| column-num `v2.0.4` | 列数 | *number* | `4` | +| gutter | 格子之间的间距，默认单位为`px` | *string \| number* | `0` | +| border | 是否显示边框 | *boolean* | `true` | +| center | 是否将格子内容居中显示 | *boolean* | `true` | +| square | 是否将格子固定为正方形 | *boolean* | `false` | +| clickable | 是否开启格子点击反馈 | *boolean* | `false` | +| icon-size `v2.2.6` | 图标大小，默认单位为`px` | *string \| number* | `28px` | ### GridItem Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| text | 文字 | *string* | - | - | -| icon | 图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | - | -| dot | 是否显示图标右上角小红点 | *boolean* | `false` | 2.2.1 | -| info | 图标右上角徽标的内容 | *string \| number* | - | 2.2.1 | -| url | 点击后跳转的链接地址 | *string* | - | - | -| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | - | -| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| text | 文字 | *string* | - | +| icon | 图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | +| dot `v2.2.1` | 是否显示图标右上角小红点 | *boolean* | `false` | +| info `v2.2.1` | 图标右上角徽标的内容 | *string \| number* | - | +| url | 点击后跳转的链接地址 | *string* | - | +| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | +| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` | ### GridItem Events diff --git a/src/icon/README.md b/src/icon/README.md index f17477afb..5faeba216 100644 --- a/src/icon/README.md +++ b/src/icon/README.md @@ -83,15 +83,15 @@ import 'vant/lib/icon/local.css'; ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| name | Icon name or URL | *string* | `''` | - | -| dot | Whether to show red dot | *boolean* | `false` | 2.2.1 | -| info | Content of the badge | *string \| number* | `''` | - | -| color | Icon color | *string* | `inherit` | - | -| size | Icon size | *string \| number* | `inherit` | - | -| class-prefix | ClassName prefix | *string* | `van-icon` | - | -| tag | HTML Tag | *string* | `i` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| name | Icon name or URL | *string* | `''` | +| dot `v2.2.1` | Whether to show red dot | *boolean* | `false` | +| info | Content of the badge | *string \| number* | `''` | +| color | Icon color | *string* | `inherit` | +| size | Icon size | *string \| number* | `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 b3a103404..2f1c8d197 100644 --- a/src/icon/README.zh-CN.md +++ b/src/icon/README.zh-CN.md @@ -89,15 +89,15 @@ import 'vant/lib/icon/local.css'; ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| name | 图标名称或图片链接 | *string* | - | - | -| dot | 是否显示图标右上角小红点 | *boolean* | `false` | 2.2.1 | -| info | 图标右上角徽标的内容 | *string \| number* | - | - | -| color | 图标颜色 | *string* | `inherit` | - | -| size | 图标大小，如 `20px` `2em`，默认单位为`px` | *string \| number* | `inherit` | - | -| class-prefix | 类名前缀 | *string* | `van-icon` | - | -| tag | HTML 标签 | *string* | `i` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| name | 图标名称或图片链接 | *string* | - | +| dot `v2.2.1` | 是否显示图标右上角小红点 | *boolean* | `false` | +| info | 图标右上角徽标的内容 | *string \| number* | - | +| color | 图标颜色 | *string* | `inherit` | +| size | 图标大小，如 `20px` `2em`，默认单位为`px` | *string \| number* | `inherit` | +| class-prefix | 类名前缀 | *string* | `van-icon` | +| tag | HTML 标签 | *string* | `i` | ### Events diff --git a/src/image-preview/README.md b/src/image-preview/README.md index ca29f9631..7657748fd 100644 --- a/src/image-preview/README.md +++ b/src/image-preview/README.md @@ -88,39 +88,39 @@ export default { ### Options -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| images | Images URL list | *string[]* | `[]` | - | -| startPosition | Start position | *number* | `0` | - | -| showIndex | Whether to show index | *boolean* | `true` | - | -| showIndicators | Whether to show indicators | *boolean* | `false` | - | -| loop | Whether to enable loop | *boolean* | `true` | - | -| swipeDuration | Animation duration (ms) | *number* | `500` | - | -| onClose | Triggered when close | *Function* | - | - | -| onChange | Triggered when current image change | *Function* | - | 2.0.3 | -| closeOnPopstate | Whether to close when popstate | *boolean* | `false` | - | -| asyncClose | Whether to enable async close | *boolean* | `false` | - | -| className | Custom className | *any* | - | - | -| lazyLoad | Whether to enable thumb lazy load，should register [Lazyload](#/en-US/lazyload) component | *boolean* | `false` | - | -| maxZoom | Max zoom | *number* | `3` | - | -| minZoom | Min zoom | *number* | `1/3` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| images | Images URL list | *string[]* | `[]` | +| startPosition | Start position | *number* | `0` | +| showIndex | Whether to show index | *boolean* | `true` | +| showIndicators | Whether to show indicators | *boolean* | `false` | +| loop | Whether to enable loop | *boolean* | `true` | +| swipeDuration | Animation duration (ms) | *number* | `500` | +| onClose | Triggered when close | *Function* | - | +| onChange `v2.0.3` | Triggered when current image change | *Function* | - | +| closeOnPopstate | Whether to close when popstate | *boolean* | `false` | +| asyncClose | Whether to enable async close | *boolean* | `false` | +| className | Custom className | *any* | - | +| lazyLoad | Whether to enable thumb lazy load，should register [Lazyload](#/en-US/lazyload) component | *boolean* | `false` | +| maxZoom | Max zoom | *number* | `3` | +| minZoom | Min zoom | *number* | `1/3` | ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| images | Images URL list | *string[]* | `[]` | - | -| start-position | Start position | *number* | `0` | - | -| show-index | Whether to show index | *boolean* | `true` | - | -| show-indicators | Whether to show indicators | *boolean* | `false` | - | -| loop | Whether to enable loop | *boolean* | `true` | - | -| swipe-duration | Animation duration (ms) | *number* | `500` | - | -| async-close | Whether to enable async close | *boolean* | `false` | - | -| close-on-popstate | Whether to close when popstate | *boolean* | `false` | - | -| class-name | Custom className | *any* | - | - | -| lazy-load | Whether to enable thumb lazy load，should register [Lazyload](#/en-US/lazyload) component | *boolean* | `false` | - | -| max-zoom | Max zoom | *number* | `3` | - | -| min-zoom | Min zoom | *number* | `1/3` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| images | Images URL list | *string[]* | `[]` | +| start-position | Start position | *number* | `0` | +| show-index | Whether to show index | *boolean* | `true` | +| show-indicators | Whether to show indicators | *boolean* | `false` | +| loop | Whether to enable loop | *boolean* | `true` | +| swipe-duration | Animation duration (ms) | *number* | `500` | +| async-close | Whether to enable async close | *boolean* | `false` | +| close-on-popstate | Whether to close when popstate | *boolean* | `false` | +| class-name | Custom className | *any* | - | +| lazy-load | Whether to enable thumb lazy load，should register [Lazyload](#/en-US/lazyload) component | *boolean* | `false` | +| max-zoom | Max zoom | *number* | `3` | +| min-zoom | Min zoom | *number* | `1/3` | ### Events diff --git a/src/image-preview/README.zh-CN.md b/src/image-preview/README.zh-CN.md index 86ebd2bef..0d74d4ecf 100644 --- a/src/image-preview/README.zh-CN.md +++ b/src/image-preview/README.zh-CN.md @@ -100,41 +100,41 @@ export default { 通过函数调用 `ImagePreview` 时，支持传入以下选项： -| 参数名 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| images | 需要预览的图片 URL 数组 | *string[]* | `[]` | - | -| startPosition | 图片预览起始位置索引 | *number* | `0` | - | -| showIndex | 是否显示页码 | *boolean* | `true` | - | -| showIndicators | 是否显示轮播指示器 | *boolean* | `false` | - | -| loop | 是否开启循环播放 | *boolean* | `true` | - | -| swipeDuration | 动画时长，单位为`ms` | *number* | `500` | - | -| onClose | 关闭时的回调函数 | *Function* | - | - | -| onChange | 切换图片时的回调函数，回调参数为当前索引 | *Function* | - | 2.0.3 | -| asyncClose | 是否开启异步关闭 | *boolean* | `false` | - | -| closeOnPopstate | 是否在页面回退时自动关闭 | *boolean* | `false` | - | -| className | 自定义类名 | *any* | - | - | -| lazyLoad | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | *boolean* | `false` | - | -| maxZoom | 手势缩放时，最大缩放比例 | *number* | `3` | - | -| minZoom | 手势缩放时，最小缩放比例 | *number* | `1/3` | - | +| 参数名 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| images | 需要预览的图片 URL 数组 | *string[]* | `[]` | +| startPosition | 图片预览起始位置索引 | *number* | `0` | +| showIndex | 是否显示页码 | *boolean* | `true` | +| showIndicators | 是否显示轮播指示器 | *boolean* | `false` | +| loop | 是否开启循环播放 | *boolean* | `true` | +| swipeDuration | 动画时长，单位为`ms` | *number* | `500` | +| onClose | 关闭时的回调函数 | *Function* | - | +| onChange `v2.0.3` | 切换图片时的回调函数，回调参数为当前索引 | *Function* | - | +| asyncClose | 是否开启异步关闭 | *boolean* | `false` | +| closeOnPopstate | 是否在页面回退时自动关闭 | *boolean* | `false` | +| className | 自定义类名 | *any* | - | +| lazyLoad | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | *boolean* | `false` | +| maxZoom | 手势缩放时，最大缩放比例 | *number* | `3` | +| minZoom | 手势缩放时，最小缩放比例 | *number* | `1/3` | ### Props 通过组件调用 `ImagePreview` 时，支持以下 Props： -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| images | 需要预览的图片 URL 数组 | *string[]* | `[]` | - | -| start-position | 图片预览起始位置索引 | *number* | `0` | - | -| show-index | 是否显示页码 | *boolean* | `true` | - | -| show-indicators | 是否显示轮播指示器 | *boolean* | `false` | - | -| loop | 是否开启循环播放 | *boolean* | `true` | - | -| swipe-duration | 动画时长，单位为 ms | *number* | `500` | - | -| async-close | 是否开启异步关闭 | *boolean* | `false` | - | -| close-on-popstate | 是否在页面回退时自动关闭 | *boolean* | `false` | - | -| class-name | 自定义类名 | *any* | - | - | -| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | *boolean* | `false` | - | -| max-zoom | 手势缩放时，最大缩放比例 | *number* | `3` | - | -| min-zoom | 手势缩放时，最小缩放比例 | *number* | `1/3` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| images | 需要预览的图片 URL 数组 | *string[]* | `[]` | +| start-position | 图片预览起始位置索引 | *number* | `0` | +| show-index | 是否显示页码 | *boolean* | `true` | +| show-indicators | 是否显示轮播指示器 | *boolean* | `false` | +| loop | 是否开启循环播放 | *boolean* | `true` | +| swipe-duration | 动画时长，单位为 ms | *number* | `500` | +| async-close | 是否开启异步关闭 | *boolean* | `false` | +| close-on-popstate | 是否在页面回退时自动关闭 | *boolean* | `false` | +| class-name | 自定义类名 | *any* | - | +| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | *boolean* | `false` | +| max-zoom | 手势缩放时，最大缩放比例 | *number* | `3` | +| min-zoom | 手势缩放时，最小缩放比例 | *number* | `1/3` | ### Events diff --git a/src/image/README.md b/src/image/README.md index db3b6c1cc..aa9af8c1c 100644 --- a/src/image/README.md +++ b/src/image/README.md @@ -66,20 +66,20 @@ Vue.use(Lazyload); ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| src | Src | *string* | - | - | -| fit | Fit mode | *string* | `fill` | - | -| alt | Alt | *string* | - | - | -| width | Width | *string \| number* | - | - | -| height | Height | *string \| number* | - | - | -| radius | Border Radius | *string \| number* | `0` | 2.1.6 | -| round | Whether to be round | *boolean* | `false` | - | -| lazy-load | Whether to enable lazy load，should register [Lazyload](#/en-US/lazyload) component | *boolean* | `false` | - | -| show-error | Whether to show error placeholder | *boolean* | `true` | 2.0.9 | -| show-loading | Whether to show loading placeholder | *boolean* | `true` | 2.0.9 | -| error-icon | Error icon | *string* | `warning-o` | 2.4.2 | -| loading-icon | Loading icon | *string* | `photo-o` | 2.4.2 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| src | Src | *string* | - | +| fit | Fit mode | *string* | `fill` | +| alt | Alt | *string* | - | +| width | Width | *string \| number* | - | +| height | Height | *string \| number* | - | +| radius `v2.1.6` | Border Radius | *string \| number* | `0` | +| round | Whether to be round | *boolean* | `false` | +| lazy-load | Whether to enable lazy load，should register [Lazyload](#/en-US/lazyload) component | *boolean* | `false` | +| show-error `v2.0.9` | Whether to show error placeholder | *boolean* | `true` | +| show-loading `v2.0.9` | Whether to show loading placeholder | *boolean* | `true` | +| error-icon `v2.4.2` | Error icon | *string* | `warning-o` | +| loading-icon `v2.4.2` | Loading icon | *string* | `photo-o` | ### fit optional value diff --git a/src/image/README.zh-CN.md b/src/image/README.zh-CN.md index 8c888c9d5..593d580d1 100644 --- a/src/image/README.zh-CN.md +++ b/src/image/README.zh-CN.md @@ -92,20 +92,20 @@ Vue.use(Image); ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| src | 图片链接 | *string* | - | - | -| fit | 图片填充模式 | *string* | `fill` | - | -| alt | 替代文本 | *string* | - | - | -| width | 宽度，默认单位为`px` | *string \| number* | - | - | -| height | 高度，默认单位为`px` | *string \| number* | - | - | -| radius | 圆角大小，默认单位为`px` | *string \| number* | `0` | 2.1.6 | -| round | 是否显示为圆形 | *boolean* | `false` | - | -| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | *boolean* | `false` | - | -| show-error | 是否展示图片加载失败提示 | *boolean* | `true` | 2.0.9 | -| show-loading | 是否展示图片加载中提示 | *boolean* | `true` | 2.0.9 | -| error-icon | 失败时提示的图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | `warning-o` | 2.4.2 | -| loading-icon | 加载时提示的图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | `photo-o` | 2.4.2 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| src | 图片链接 | *string* | - | +| fit | 图片填充模式 | *string* | `fill` | +| alt | 替代文本 | *string* | - | +| width | 宽度，默认单位为`px` | *string \| number* | - | +| height | 高度，默认单位为`px` | *string \| number* | - | +| radius `v2.1.6` | 圆角大小，默认单位为`px` | *string \| number* | `0` | +| round | 是否显示为圆形 | *boolean* | `false` | +| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | *boolean* | `false` | +| show-error `v2.0.9` | 是否展示图片加载失败提示 | *boolean* | `true` | +| show-loading `v2.0.9` | 是否展示图片加载中提示 | *boolean* | `true` | +| error-icon `v2.4.2` | 失败时提示的图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | `warning-o` | +| loading-icon `v2.4.2` | 加载时提示的图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | `photo-o` | ### 图片填充模式 diff --git a/src/index-bar/README.md b/src/index-bar/README.md index ea905b324..88a5836d2 100644 --- a/src/index-bar/README.md +++ b/src/index-bar/README.md @@ -61,19 +61,19 @@ export default { ### IndexBar Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| index-list | Index List | *string[] \| number[]* | `A-Z` | - | -| z-index | z-index | *number* | `1` | - | -| sticky | Whether to enable anchor sticky top | *boolean* | `true` | - | -| sticky-offset-top | Anchor offset top when sticky | *number* | `0` | 2.0.7 | -| highlight-color | Index character highlight color | *string* | `#07c160` | - | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| index-list | Index List | *string[] \| number[]* | `A-Z` | +| z-index | z-index | *number* | `1` | +| sticky | Whether to enable anchor sticky top | *boolean* | `true` | +| sticky-offset-top `v2.0.7` | Anchor offset top when sticky | *number* | `0` | +| highlight-color | Index character highlight color | *string* | `#07c160` | - | ### IndexAnchor Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| index | Index | *string \| number* | - | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| index | Index | *string \| number* | - | ### IndexBar Events diff --git a/src/index-bar/README.zh-CN.md b/src/index-bar/README.zh-CN.md index 193843db8..693dc4e09 100644 --- a/src/index-bar/README.zh-CN.md +++ b/src/index-bar/README.zh-CN.md @@ -65,19 +65,19 @@ export default { ### IndexBar Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| index-list | 索引字符列表 | *string[] \| number[]* | `A-Z` | - | -| z-index | z-index 层级 | *number* | `1` | - | -| sticky | 是否开启锚点自动吸顶 | *boolean* | `true` | - | -| sticky-offset-top | 锚点自动吸顶时与顶部的距离 | *number* | `0` | 2.0.7 | -| highlight-color | 索引字符高亮颜色 | *string* | `#07c160` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| index-list | 索引字符列表 | *string[] \| number[]* | `A-Z` | +| z-index | z-index 层级 | *number* | `1` | +| sticky | 是否开启锚点自动吸顶 | *boolean* | `true` | +| sticky-offset-top `v2.0.7` | 锚点自动吸顶时与顶部的距离 | *number* | `0` | +| highlight-color | 索引字符高亮颜色 | *string* | `#07c160` | ### IndexAnchor Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| index | 索引字符 | *string \| number* | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| index | 索引字符 | *string \| number* | - | ### IndexBar Events diff --git a/src/lazyload/README.md b/src/lazyload/README.md index cc777ef88..5d9ab1319 100644 --- a/src/lazyload/README.md +++ b/src/lazyload/README.md @@ -57,15 +57,15 @@ Vue.use(Lazyload, { ### Options -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| loading | Src of the image while loading | *string* | - | - | -| error | Src of the image upon load fail | *string* | - | - | -| preload | Proportion of pre-loading height | *string* | - | - | -| attempt | Attempts count | *number* | `3` | - | -| listenEvents | Events that you want vue listen for | *string[]* | `scroll`... | - | -| adapter | Dynamically modify the attribute of element | *object* | - | - | -| filter | The image's listener filter | *object* | - | - | -| lazyComponent | Lazyload component | *boolean* | `false` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| loading | Src of the image while loading | *string* | - | +| error | Src of the image upon load fail | *string* | - | +| preload | Proportion of pre-loading height | *string* | - | +| attempt | Attempts count | *number* | `3` | +| listenEvents | Events that you want vue listen for | *string[]* | `scroll`... | +| adapter | Dynamically modify the attribute of element | *object* | - | +| filter | The image's listener filter | *object* | - | +| lazyComponent | Lazyload component | *boolean* | `false` | > See more：[ vue-lazyload ](https://github.com/hilongjw/vue-lazyload) diff --git a/src/lazyload/README.zh-CN.md b/src/lazyload/README.zh-CN.md index 273a6b635..c0482a73c 100644 --- a/src/lazyload/README.zh-CN.md +++ b/src/lazyload/README.zh-CN.md @@ -64,15 +64,15 @@ Vue.use(Lazyload, { ### Options -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| loading | 加载时的图片 | *string* | - | - | -| error | 错误时的图片 | *string* | - | - | -| preload | 预加载高度的比例 | *string* | - | - | -| attempt | 尝试次数 | *number* | `3` | - | -| listenEvents | 监听的事件 | *string[]* | `scroll`等 | - | -| adapter | 适配器 | *object* | - | - | -| filter | 图片 URL 过滤 | *object* | - | - | -| lazyComponent | 是否能懒加载模块 | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| loading | 加载时的图片 | *string* | - | +| error | 错误时的图片 | *string* | - | +| preload | 预加载高度的比例 | *string* | - | +| attempt | 尝试次数 | *number* | `3` | +| listenEvents | 监听的事件 | *string[]* | `scroll`等 | +| adapter | 适配器 | *object* | - | +| filter | 图片 URL 过滤 | *object* | - | +| lazyComponent | 是否能懒加载模块 | *boolean* | `false` | > 更多内容请参照：[vue-lazyload 官方文档](https://github.com/hilongjw/vue-lazyload) diff --git a/src/list/README.md b/src/list/README.md index de79609fd..996246e7e 100644 --- a/src/list/README.md +++ b/src/list/README.md @@ -100,17 +100,17 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Whether to show loading info，the `load` event will not be triggered when loading | *boolean* | `false` | - | -| finished | Whether loading is finished，the `load` event will not be triggered when finished | *boolean* | `false` | - | -| error | Whether loading is error，the `load` event will be triggered only when error text clicked, the `sync` modifier is needed | *boolean* | `false` | - | -| offset | The load event will be triggered when the distance between the scrollbar and the bottom is less than offset | *number* | `300` | - | -| loading-text | Loading text | *string* | `Loading...` | - | -| finished-text | Finished text | *string* | - | - | -| error-text | Error loaded text | *string* | - | - | -| immediate-check | Whether to check loading position immediately after mounted | *boolean* | `true` | - | -| direction | Scroll direction，can be set to `up` | *string* | `down` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Whether to show loading info，the `load` event will not be triggered when loading | *boolean* | `false` | +| finished | Whether loading is finished，the `load` event will not be triggered when finished | *boolean* | `false` | +| error | Whether loading is error，the `load` event will be triggered only when error text clicked, the `sync` modifier is needed | *boolean* | `false` | +| offset | The load event will be triggered when the distance between the scrollbar and the bottom is less than offset | *number* | `300` | +| loading-text | Loading text | *string* | `Loading...` | +| finished-text | Finished text | *string* | - | +| error-text | Error loaded text | *string* | - | +| immediate-check | Whether to check loading position immediately after mounted | *boolean* | `true` | +| direction | Scroll direction，can be set to `up` | *string* | `down` | ### Events diff --git a/src/list/README.zh-CN.md b/src/list/README.zh-CN.md index 9c694d57f..3aaad2207 100644 --- a/src/list/README.zh-CN.md +++ b/src/list/README.zh-CN.md @@ -107,17 +107,17 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 是否处于加载状态，加载过程中不触发`load`事件 | *boolean* | `false` | - | -| finished | 是否已加载完成，加载完成后不再触发`load`事件 | *boolean* | `false` | - | -| error | 是否加载失败，加载失败后点击错误提示可以重新
触发`load`事件，必须使用`sync`修饰符 | *boolean* | `false` | - | -| offset | 滚动条与底部距离小于 offset 时触发`load`事件 | *number* | `300` | - | -| loading-text | 加载过程中的提示文案 | *string* | `加载中...` | - | -| finished-text | 加载完成后的提示文案 | *string* | - | - | -| error-text | 加载失败后的提示文案 | *string* | - | - | -| immediate-check | 是否在初始化时立即执行滚动位置检查 | *boolean* | `true` | - | -| direction | 滚动触发加载的方向，可选值为`up` | *string* | `down` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 是否处于加载状态，加载过程中不触发`load`事件 | *boolean* | `false` | +| finished | 是否已加载完成，加载完成后不再触发`load`事件 | *boolean* | `false` | +| error | 是否加载失败，加载失败后点击错误提示可以重新
触发`load`事件，必须使用`sync`修饰符 | *boolean* | `false` | +| offset | 滚动条与底部距离小于 offset 时触发`load`事件 | *number* | `300` | +| loading-text | 加载过程中的提示文案 | *string* | `加载中...` | +| finished-text | 加载完成后的提示文案 | *string* | - | +| error-text | 加载失败后的提示文案 | *string* | - | +| immediate-check | 是否在初始化时立即执行滚动位置检查 | *boolean* | `true` | +| direction | 滚动触发加载的方向，可选值为`up` | *string* | `down` | ### Events diff --git a/src/loading/README.md b/src/loading/README.md index 73a762c68..9f9678495 100644 --- a/src/loading/README.md +++ b/src/loading/README.md @@ -41,13 +41,13 @@ Vue.use(Loading); ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| color | Loading color | *string* | `#c9c9c9` | - | -| type | Can be set to `spinner` | *string* | `circular` | - | -| size | Icon size | *string \| number* | `30px` | - | -| text-size | Text font size | *string \| number* | `14px` | - | -| vertical | Whether to arrange icons and text content vertically | *boolean* | `false` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| color | Loading color | *string* | `#c9c9c9` | +| type | Can be set to `spinner` | *string* | `circular` | +| size | Icon size | *string \| number* | `30px` | +| text-size | Text font size | *string \| number* | `14px` | +| vertical | Whether to arrange icons and text content vertically | *boolean* | `false` | ### Slots diff --git a/src/loading/README.zh-CN.md b/src/loading/README.zh-CN.md index 82eac892b..22b27fd3b 100644 --- a/src/loading/README.zh-CN.md +++ b/src/loading/README.zh-CN.md @@ -41,13 +41,13 @@ Vue.use(Loading); ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| color | 颜色 | *string* | `#c9c9c9` | - | -| type | 类型，可选值为 `spinner` | *string* | `circular` | - | -| size | 加载图标大小，默认单位为`px` | *string \| number* | `30px` | - | -| text-size | 文字大小，默认单位为`px` | *string \| number* | `14px` | - | -| vertical | 是否垂直排列图标和文字内容 | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| color | 颜色 | *string* | `#c9c9c9` | +| type | 类型，可选值为 `spinner` | *string* | `circular` | +| size | 加载图标大小，默认单位为`px` | *string \| number* | `30px` | +| text-size | 文字大小，默认单位为`px` | *string \| number* | `14px` | +| vertical | 是否垂直排列图标和文字内容 | *boolean* | `false` | ### Slots diff --git a/src/nav-bar/README.md b/src/nav-bar/README.md index 5ac63b219..d6e57b63e 100644 --- a/src/nav-bar/README.md +++ b/src/nav-bar/README.md @@ -49,15 +49,15 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| title | Title | *string* | `''` | - | -| left-text | Left Text | *string* | `''` | - | -| right-text | Right Text | *string* | `''` | - | -| left-arrow | Whether to show left arrow | *boolean* | `false` | - | -| fixed | Whether to fixed top | *boolean* | `false` | - | -| border | Whether to show bottom border | *boolean* | `true` | - | -| z-index | Z-index | *number* | `1` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| title | Title | *string* | `''` | +| left-text | Left Text | *string* | `''` | +| right-text | Right Text | *string* | `''` | +| left-arrow | Whether to show left arrow | *boolean* | `false` | +| fixed | Whether to fixed top | *boolean* | `false` | +| border | Whether to show bottom border | *boolean* | `true` | +| z-index | Z-index | *number* | `1` | ### Slots diff --git a/src/nav-bar/README.zh-CN.md b/src/nav-bar/README.zh-CN.md index 12058228e..13800fd01 100644 --- a/src/nav-bar/README.zh-CN.md +++ b/src/nav-bar/README.zh-CN.md @@ -51,15 +51,15 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| title | 标题 | *string* | `''` | - | -| left-text | 左侧文案 | *string* | `''` | - | -| right-text | 右侧文案 | *string* | `''` | - | -| left-arrow | 是否显示左侧箭头 | *boolean* | `false` | - | -| fixed | 是否固定在顶部 | *boolean* | `false` | - | -| border | 是否显示下边框 | *boolean* | `true` | - | -| z-index | 元素 z-index | *number* | `1` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| title | 标题 | *string* | `''` | +| left-text | 左侧文案 | *string* | `''` | +| right-text | 右侧文案 | *string* | `''` | +| left-arrow | 是否显示左侧箭头 | *boolean* | `false` | +| fixed | 是否固定在顶部 | *boolean* | `false` | +| border | 是否显示下边框 | *boolean* | `true` | +| z-index | 元素 z-index | *number* | `1` | ### Slots diff --git a/src/notice-bar/README.md b/src/notice-bar/README.md index beddb7aeb..3ef2591b7 100644 --- a/src/notice-bar/README.md +++ b/src/notice-bar/README.md @@ -64,17 +64,17 @@ Vue.use(NoticeBar); ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| mode | Mode, can be set to `closeable` `link` | *string* | `''` | - | -| text | Notice text content | *string* | `''` | - | - | -| delay | Animation delay (s) | *number* | `1` | - | -| speed | Scroll speed (px/s) | *number* | `50` | - | -| scrollable | Whether to scroll content | *boolean* | `true` | - | -| wrapable | Whether to enable text wrap | *boolean* | `false` | - | - | -| left-icon | Left Icon | *string* | - | - | -| color | Text color | *string* | `#f60` | - | -| background | Background color | *string* | `#fff7cc` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| mode | Mode, can be set to `closeable` `link` | *string* | `''` | +| text | Notice text content | *string* | `''` | - | +| delay | Animation delay (s) | *number* | `1` | +| speed | Scroll speed (px/s) | *number* | `50` | +| scrollable | Whether to scroll content | *boolean* | `true` | +| wrapable | Whether to enable text wrap | *boolean* | `false` | - | +| left-icon | Left Icon | *string* | - | +| color | Text color | *string* | `#f60` | +| background | Background color | *string* | `#fff7cc` | ### Events diff --git a/src/notice-bar/README.zh-CN.md b/src/notice-bar/README.zh-CN.md index d80baaef2..48c236d03 100644 --- a/src/notice-bar/README.zh-CN.md +++ b/src/notice-bar/README.zh-CN.md @@ -72,17 +72,17 @@ Vue.use(NoticeBar); ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| mode | 通知栏模式，可选值为 `closeable` `link` | *string* | `''` | - | -| text | 通知文本内容 | *string* | `''` | - | -| delay | 动画延迟时间 (s) | *number* | `1` | - | -| speed | 滚动速率 (px/s) | *number* | `50` | - | -| scrollable | 是否在长度溢出时滚动播放 | *boolean* | `true` | - | -| wrapable | 是否开启文本换行，只在禁用滚动时生效 | *boolean* | `false` | - | -| left-icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | - | -| color | 文本颜色 | *string* | `#f60` | - | -| background | 滚动条背景 | *string* | `#fff7cc` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| mode | 通知栏模式，可选值为 `closeable` `link` | *string* | `''` | +| text | 通知文本内容 | *string* | `''` | +| delay | 动画延迟时间 (s) | *number* | `1` | +| speed | 滚动速率 (px/s) | *number* | `50` | +| scrollable | 是否在长度溢出时滚动播放 | *boolean* | `true` | +| wrapable | 是否开启文本换行，只在禁用滚动时生效 | *boolean* | `false` | +| left-icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | +| color | 文本颜色 | *string* | `#f60` | +| background | 滚动条背景 | *string* | `#fff7cc` | ### Events diff --git a/src/notify/README.md b/src/notify/README.md index 94153c38e..4db4c3d75 100644 --- a/src/notify/README.md +++ b/src/notify/README.md @@ -66,14 +66,14 @@ export default { ### Options -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| type | Can be set to `primary` `success` `warning` | *string* | `danger` | 2.1.6 | -| message | Message | *string* | - | - | -| duration | Duration(ms), won't disappear if value is 0 | *number* | `3000` | - | -| color | Message color | *string* | `#fff` | | - | -| background | Background color | *string* | - | - | -| className | Custom className | *any* | - | - | -| onClick | Callback function after click | *Function* | - | - | -| onOpened | Callback function after opened | *Function* | - | - | -| onClose | Callback function after close | *Function* | - | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| type `v2.1.6` | Can be set to `primary` `success` `warning` | *string* | `danger` | +| message | Message | *string* | - | +| duration | Duration(ms), won't disappear if value is 0 | *number* | `3000` | +| color | Message color | *string* | `#fff` | | +| background | Background color | *string* | - | +| className | Custom className | *any* | - | +| onClick | Callback function after click | *Function* | - | +| onOpened | Callback function after opened | *Function* | - | +| onClose | Callback function after close | *Function* | - | diff --git a/src/notify/README.zh-CN.md b/src/notify/README.zh-CN.md index 7a3f583ae..1fcc4e903 100644 --- a/src/notify/README.zh-CN.md +++ b/src/notify/README.zh-CN.md @@ -77,14 +77,14 @@ export default { ### Options -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| type | 类型，可选值为 `primary` `success` `warning` | *string* | `danger` | 2.1.6 | -| message | 展示文案，支持通过`\n`换行 | *string* | - | - | -| duration | 展示时长(ms)，值为 0 时，notify 不会消失 | *number* | `3000` | - | -| color | 字体颜色 | *string* | `#fff` | - | -| background | 背景颜色 | *string* | - | - | -| className | 自定义类名 | *any* | - | - | -| onClick | 点击时的回调函数 | *Function* | - | - | -| onOpened | 完全展示后的回调函数 | *Function* | - | - | -| onClose | 关闭时的回调函数 | *Function* | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| type `v2.1.6` | 类型，可选值为 `primary` `success` `warning` | *string* | `danger` | +| message | 展示文案，支持通过`\n`换行 | *string* | - | +| duration | 展示时长(ms)，值为 0 时，notify 不会消失 | *number* | `3000` | +| color | 字体颜色 | *string* | `#fff` | +| background | 背景颜色 | *string* | - | +| className | 自定义类名 | *any* | - | +| onClick | 点击时的回调函数 | *Function* | - | +| onOpened | 完全展示后的回调函数 | *Function* | - | +| onClose | 关闭时的回调函数 | *Function* | - | diff --git a/src/number-keyboard/README.md b/src/number-keyboard/README.md index db8102105..1a64da1fa 100644 --- a/src/number-keyboard/README.md +++ b/src/number-keyboard/README.md @@ -94,21 +94,21 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Current value | *string* | - | 2.0.2 | -| show | Whether to show keyboard | *boolean* | - | - | -| theme | Keyboard theme，can be set to `default` `custom` | *string* | `default` | - | -| title | Keyboard title | *string* | - | - | -| maxlength | Value maxlength | *string \| number* | - | 2.0.2 | -| transition | Whether to show transition animation | *boolean* | `true` | - | -| z-index | Keyboard z-index | *number* | `100` | - | -| extra-key | Content of bottom left key | *string* | `''` | - | -| close-button-text | Close button text | *string* | `-` | - | -| delete-button-text | Delete button text | *string* | `delete` | - | -| show-delete-key | Whether to show delete button | *boolean* | `true` | - | -| hide-on-click-outside | Whether to hide keyboard when click outside | *boolean* | `true` | - | -| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `true` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model `v2.0.2` | Current value | *string* | - | +| show | Whether to show keyboard | *boolean* | - | +| theme | Keyboard theme，can be set to `default` `custom` | *string* | `default` | +| title | Keyboard title | *string* | - | +| maxlength `v2.0.2` | Value maxlength | *string \| number* | - | +| transition | Whether to show transition animation | *boolean* | `true` | +| z-index | Keyboard z-index | *number* | `100` | +| extra-key | Content of bottom left key | *string* | `''` | +| close-button-text | Close button text | *string* | `-` | +| delete-button-text | Delete button text | *string* | `delete` | +| show-delete-key | Whether to show delete button | *boolean* | `true` | +| hide-on-click-outside | Whether to hide keyboard when click outside | *boolean* | `true` | +| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `true` | ### Events diff --git a/src/number-keyboard/README.zh-CN.md b/src/number-keyboard/README.zh-CN.md index 8159414c6..6ed827e87 100644 --- a/src/number-keyboard/README.zh-CN.md +++ b/src/number-keyboard/README.zh-CN.md @@ -100,21 +100,21 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 当前输入值 | *string* | - | 2.0.2 | -| show | 是否显示键盘 | *boolean* | - | - | -| theme | 样式风格，可选值为 `default` `custom` | *string* | `default` | - | -| title | 键盘标题 | *string* | - | - | -| maxlength | 输入值最大长度 | *string \| number* | - | 2.0.2 | -| transition | 是否开启过场动画 | *boolean* | `true` | - | -| z-index | 键盘 z-index | *number* | `100` | - | -| extra-key | 左下角按键内容 | *string* | `''` | - | -| close-button-text | 关闭按钮文字，空则不展示 | *string* | `-` | - | -| delete-button-text | 删除按钮文字 | *string* | `删除` | - | -| show-delete-key | 是否展示删除按钮 | *boolean* | `true` | - | -| hide-on-click-outside | 点击外部时是否收起键盘 | *boolean* | `true` | - | -| safe-area-inset-bottom | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `true` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model `v2.0.2` | 当前输入值 | *string* | - | +| show | 是否显示键盘 | *boolean* | - | +| theme | 样式风格，可选值为 `default` `custom` | *string* | `default` | +| title | 键盘标题 | *string* | - | +| maxlength `v2.0.2` | 输入值最大长度 | *string \| number* | - | +| transition | 是否开启过场动画 | *boolean* | `true` | +| z-index | 键盘 z-index | *number* | `100` | +| extra-key | 左下角按键内容 | *string* | `''` | +| close-button-text | 关闭按钮文字，空则不展示 | *string* | `-` | +| delete-button-text | 删除按钮文字 | *string* | `删除` | +| show-delete-key | 是否展示删除按钮 | *boolean* | `true` | +| hide-on-click-outside | 点击外部时是否收起键盘 | *boolean* | `true` | +| safe-area-inset-bottom | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `true` | ### Events diff --git a/src/overlay/README.md b/src/overlay/README.md index 29413b15a..96646e10e 100644 --- a/src/overlay/README.md +++ b/src/overlay/README.md @@ -58,22 +58,22 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| show | Whether to show overlay | *boolean* | `false` | - | -| z-index | z-index | *string \| number* | `1` | - | -| duration | Animation duration | *string \| number* | `0.3` | - | -| class-name | ClassName | *string* | - | - | -| custom-class | Custom style | *object* | - | 2.2.5 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| show | Whether to show overlay | *boolean* | `false` | +| z-index | z-index | *string \| number* | `1` | +| duration | Animation duration | *string \| number* | `0.3` | +| class-name | ClassName | *string* | - | +| custom-class `v2.2.5` | Custom style | *object* | - | ### Events -| Event | Description | Arguments | Version | -|------|------|------|------| -| click | Triggered when clicked | event: Event | - | +| Event | Description | Arguments | +|------|------|------| +| click | Triggered when clicked | event: Event | ### Slots -| Name | Description | Version | -|------|------|------| -| default | Default slot | 2.2.5 | +| Name | Description | +|------|------| +| default `v2.2.5` | Default slot | diff --git a/src/overlay/README.zh-CN.md b/src/overlay/README.zh-CN.md index 2a4c259de..59c5fbdcd 100644 --- a/src/overlay/README.zh-CN.md +++ b/src/overlay/README.zh-CN.md @@ -64,22 +64,22 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| show | 是否展示遮罩层 | *boolean* | `false` | - | -| z-index | z-index 层级 | *string \| number* | `1` | - | -| duration | 动画时长，单位秒 | *string \| number* | `0.3` | - | -| class-name | 自定义类名 | *string* | - | - | -| custom-style | 自定义样式 | *object* | - | 2.2.5 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| show | 是否展示遮罩层 | *boolean* | `false` | +| z-index | z-index 层级 | *string \| number* | `1` | +| duration | 动画时长，单位秒 | *string \| number* | `0.3` | +| class-name | 自定义类名 | *string* | - | +| custom-style `v2.2.5` | 自定义样式 | *object* | - | ### Events -| 事件名 | 说明 | 回调参数 | 版本 | -|------|------|------|------| -| click | 点击时触发 | event: Event | - | +| 事件名 | 说明 | 回调参数 | +|------|------|------| +| click | 点击时触发 | event: Event | ### Slots -| 名称 | 说明 | 版本 | -|------|------|------| -| default | 默认插槽，用于在遮罩层上方嵌入内容 | 2.0.5 | +| 名称 | 说明 | +|------|------| +| default `v2.0.5` | 默认插槽，用于在遮罩层上方嵌入内容 | diff --git a/src/pagination/README.md b/src/pagination/README.md index 9992cf4c1..ed727a99f 100644 --- a/src/pagination/README.md +++ b/src/pagination/README.md @@ -56,17 +56,17 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Current page number | *number* | - | - | -| mode | Mode, can be set to `simple` `multi` | *string* | `multi` | - | -| total-items | Total items | *number* | `0` | - | -| items-per-page | Item number per page | *number* | `10` | - | -| page-count | The total number of pages, if not set, will be calculated based on `total-items` and `items-per-page` | *number* | `-` | - | -| prev-text | Previous text | *string* | `Previous` | - | -| next-text | Next text | *string* | `Next` | - | -| show-page-size | Count of page size to show | *number* | `5` | - | -| force-ellipses | Whether to show ellipses | *boolean* | `false` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Current page number | *number* | - | +| mode | Mode, can be set to `simple` `multi` | *string* | `multi` | +| total-items | Total items | *number* | `0` | +| items-per-page | Item number per page | *number* | `10` | +| page-count | The total number of pages, if not set, will be calculated based on `total-items` and `items-per-page` | *number* | `-` | +| prev-text | Previous text | *string* | `Previous` | +| next-text | Next text | *string* | `Next` | +| show-page-size | Count of page size to show | *number* | `5` | +| force-ellipses | Whether to show ellipses | *boolean* | `false` | ### Events diff --git a/src/pagination/README.zh-CN.md b/src/pagination/README.zh-CN.md index 9375c6fc9..82e0e1b66 100644 --- a/src/pagination/README.zh-CN.md +++ b/src/pagination/README.zh-CN.md @@ -57,17 +57,17 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 当前页码 | *number* | - | - | -| mode | 显示模式，可选值为 `simple` `multi` | *string* | `multi` | - | -| total-items | 总记录数 | *number* | `0` | - | -| items-per-page | 每页记录数 | *number* | `10` | - | -| page-count | 总页数 | *number* | `根据页数计算` | - | -| prev-text | 上一页 | *string* | `上一页` | - | -| next-text | 下一页 | *string* | `下一页` | - | -| show-page-size | 显示的页码个数 | *number* | `5` | - | -| force-ellipses | 显示省略号 | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 当前页码 | *number* | - | +| mode | 显示模式，可选值为 `simple` `multi` | *string* | `multi` | +| total-items | 总记录数 | *number* | `0` | +| items-per-page | 每页记录数 | *number* | `10` | +| page-count | 总页数 | *number* | `根据页数计算` | +| prev-text | 上一页 | *string* | `上一页` | +| next-text | 下一页 | *string* | `下一页` | +| show-page-size | 显示的页码个数 | *number* | `5` | +| force-ellipses | 显示省略号 | *boolean* | `false` | ### Events diff --git a/src/panel/README.md b/src/panel/README.md index 64e1b24b2..fbbd7605a 100644 --- a/src/panel/README.md +++ b/src/panel/README.md @@ -35,12 +35,12 @@ Vue.use(Panel); ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| icon | Left Icon | *string* | - | - | -| title | Title | *string* | - | - | -| desc | Description | *string* | - | - | -| status | Status | *string* | - | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| icon | Left Icon | *string* | - | +| title | Title | *string* | - | +| desc | Description | *string* | - | +| status | Status | *string* | - | ### Slots diff --git a/src/panel/README.zh-CN.md b/src/panel/README.zh-CN.md index 1385911e1..1db9b45f2 100644 --- a/src/panel/README.zh-CN.md +++ b/src/panel/README.zh-CN.md @@ -39,12 +39,12 @@ Vue.use(Panel); ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| title | 标题 | *string* | - | - | -| desc | 描述 | *string* | - | - | -| status | 状态 | *string* | - | - | -| icon | 标题左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| title | 标题 | *string* | - | +| desc | 描述 | *string* | - | +| status | 状态 | *string* | - | +| icon | 标题左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | ### Slots diff --git a/src/password-input/README.md b/src/password-input/README.md index afcb4c15d..dd2b0b931 100644 --- a/src/password-input/README.md +++ b/src/password-input/README.md @@ -82,15 +82,15 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| value | Password value | *string* | `''` | - | -| length | Maxlength of password | *number* | `6` | - | -| mask | Whether to mask value | *boolean* | `true` | - | -| focused | Whether to show focused cursor | *boolean* | `false` | 2.1.8 | -| info | Bottom info | *string* | - | - | -| error-info | Bottom error info | *string* | - | - | -| gutter | Gutter of input | *string \| number* | `0` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| value | Password value | *string* | `''` | +| length | Maxlength of password | *number* | `6` | +| mask | Whether to mask value | *boolean* | `true` | +| focused `v2.1.8` | Whether to show focused cursor | *boolean* | `false` | +| info | Bottom info | *string* | - | +| error-info | Bottom error info | *string* | - | +| gutter | Gutter of input | *string \| number* | `0` | ### Events diff --git a/src/password-input/README.zh-CN.md b/src/password-input/README.zh-CN.md index e4728cd07..b2d815dff 100644 --- a/src/password-input/README.zh-CN.md +++ b/src/password-input/README.zh-CN.md @@ -82,15 +82,15 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| value | 密码值 | *string* | `''` | - | -| length | 密码最大长度 | *number* | `6` | - | -| mask | 是否隐藏密码内容 | *boolean* | `true` | - | -| focused | 是否已聚焦，聚焦时会显示光标 | *boolean* | `false` | 2.1.8 | -| info | 输入框下方文字提示 | *string* | - | - | -| error-info | 输入框下方错误提示 | *string* | - | - | -| gutter | 输入框格子之间的间距，如 `20px` `2em`，默认单位为`px` | *string \| number* | `0` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| value | 密码值 | *string* | `''` | +| length | 密码最大长度 | *number* | `6` | +| mask | 是否隐藏密码内容 | *boolean* | `true` | +| focused `v2.1.8` | 是否已聚焦，聚焦时会显示光标 | *boolean* | `false` | +| info | 输入框下方文字提示 | *string* | - | +| error-info | 输入框下方错误提示 | *string* | - | +| gutter | 输入框格子之间的间距，如 `20px` `2em`，默认单位为`px` | *string \| number* | `0` | ### Events diff --git a/src/picker/README.md b/src/picker/README.md index 4708ecb73..05275fe40 100644 --- a/src/picker/README.md +++ b/src/picker/README.md @@ -184,21 +184,21 @@ When Picker columns data is acquired asynchronously, use `loading` prop to show ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| columns | Columns data | *Column[]* | `[]` | - | -| show-toolbar | Whether to show toolbar | *boolean* | `false` | - | -| toolbar-position | Toolbar position, cat be set to `bottom` | *string* | `top` | - | -| title | Toolbar title | *string* | `''` | - | -| loading | Whether to show loading prompt | *boolean* | `false` | - | -| value-key | Key of option text | *string* | `text` | - | -| item-height | Option height | *number* | `44` | - | -| confirm-button-text | Text of confirm button | *string* | `Confirm` | - | -| cancel-button-text | Text of cancel button | *string* | `Cancel` | - | -| visible-item-count | Count of visible columns | *number* | `5` | - | -| allow-html | Whether to allow HTML in option text | *boolean* | `true` | 2.1.8 | -| default-index | Default value index of single column picker | *number* | `0` | - | -| swipe-duration | Duration of the momentum animation，unit `ms` | *number* | `1000` | 2.2.10 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| columns | Columns data | *Column[]* | `[]` | +| show-toolbar | Whether to show toolbar | *boolean* | `false` | +| toolbar-position | Toolbar position, cat be set to `bottom` | *string* | `top` | +| title | Toolbar title | *string* | `''` | +| loading | Whether to show loading prompt | *boolean* | `false` | +| value-key | Key of option text | *string* | `text` | +| item-height | Option height | *number* | `44` | +| confirm-button-text | Text of confirm button | *string* | `Confirm` | +| cancel-button-text | Text of cancel button | *string* | `Cancel` | +| visible-item-count | Count of visible columns | *number* | `5` | +| allow-html `v2.1.8` | Whether to allow HTML in option text | *boolean* | `true` | +| default-index | Default value index of single column picker | *number* | `0` | +| swipe-duration `v2.2.10` | Duration of the momentum animation，unit `ms` | *number* | `1000` | ### Events @@ -229,16 +229,16 @@ Picker events will pass different parameters according to the columns are single Use [ref](https://vuejs.org/v2/api/#ref) to get Picker instance and call instance methods -| Name | Description | Attribute | Return value | Version | -|------|------|------|------|------| -| getValues | Get current values of all columns | - | values | - | -| setValues | Set current values of all columns | values | - | - | -| getIndexes | Get current indexes of all columns | - | indexes | - | -| setIndexes | Set current indexes of all columns | indexes | - | - | -| getColumnValue | Get current value of the column | columnIndex | value | - | -| setColumnValue | Set current value of the column | columnIndex, value | - | - | -| getColumnIndex | Get current index of the column | columnIndex | optionIndex | - | -| 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 | Stop scrolling and emit confirm event | - | - | 2.4.0 | +| Name | Description | Attribute | Return value | +|------|------|------|------| +| getValues | Get current values of all columns | - | values | +| setValues | Set current values of all columns | values | - | +| getIndexes | Get current indexes of all columns | - | indexes | +| setIndexes | Set current indexes of all columns | indexes | - | +| getColumnValue | Get current value of the column | columnIndex | value | +| setColumnValue | Set current value of the column | columnIndex, value | - | +| getColumnIndex | Get current index of the column | columnIndex | optionIndex | +| 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 | - | - | diff --git a/src/picker/README.zh-CN.md b/src/picker/README.zh-CN.md index c4bc27262..c00d61190 100644 --- a/src/picker/README.zh-CN.md +++ b/src/picker/README.zh-CN.md @@ -192,21 +192,21 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| columns | 对象数组，配置每一列显示的数据 | *Column[]* | `[]` | - | -| show-toolbar | 是否显示顶部栏 | *boolean* | `false` | - | -| toolbar-position | 顶部栏位置，可选值为`bottom` | *string* | `top` | - | -| title | 顶部栏标题 | *string* | `''` | - | -| loading | 是否显示加载状态 | *boolean* | `false` | - | -| value-key | 选项对象中，文字对应的 key | *string* | `text` | - | -| item-height | 选项高度 | *number* | `44` | - | -| confirm-button-text | 确认按钮文字 | *string* | `确认` | - | -| cancel-button-text | 取消按钮文字 | *string* | `取消` | - | -| visible-item-count | 可见的选项个数 | *number* | `5` | - | -| allow-html | 是否允许选项内容中渲染 HTML | *boolean* | `true` | 2.1.8 | -| default-index | 单列选择器的默认选中项索引，
多列选择器请参考下方的 Columns 配置 | *number* | `0` | - | -| swipe-duration | 快速滑动时惯性滚动的时长，单位`ms` | *number* | `1000` | 2.2.10 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| columns | 对象数组，配置每一列显示的数据 | *Column[]* | `[]` | +| show-toolbar | 是否显示顶部栏 | *boolean* | `false` | +| toolbar-position | 顶部栏位置，可选值为`bottom` | *string* | `top` | +| title | 顶部栏标题 | *string* | `''` | +| loading | 是否显示加载状态 | *boolean* | `false` | +| value-key | 选项对象中，文字对应的 key | *string* | `text` | +| item-height | 选项高度 | *number* | `44` | +| confirm-button-text | 确认按钮文字 | *string* | `确认` | +| cancel-button-text | 取消按钮文字 | *string* | `取消` | +| visible-item-count | 可见的选项个数 | *number* | `5` | +| allow-html `v2.1.8` | 是否允许选项内容中渲染 HTML | *boolean* | `true` | +| default-index | 单列选择器的默认选中项索引，
多列选择器请参考下方的 Columns 配置 | *number* | `0` | +| swipe-duration `v2.2.10` | 快速滑动时惯性滚动的时长，单位`ms` | *number* | `1000` | ### Events @@ -241,19 +241,19 @@ Picker 组件的事件会根据 columns 是单列或多列返回不同的参数 通过 [ref](https://cn.vuejs.org/v2/api/#ref) 可以获取到 Picker 实例并调用实例方法 -| 方法名 | 说明 | 参数 | 返回值 | 版本 | -|------|------|------|------|------| -| getValues | 获取所有列选中的值 | - | values | - | -| setValues | 设置所有列选中的值 | values | - | - | -| getIndexes | 获取所有列选中值对应的索引 | - | indexes | - | -| setIndexes | 设置所有列选中值对应的索引 | indexes | - | - | -| getColumnValue | 获取对应列选中的值 | columnIndex | value | - | -| setColumnValue | 设置对应列选中的值 | columnIndex, value | - | - | -| getColumnIndex | 获取对应列选中项的索引 | columnIndex | optionIndex | - | -| setColumnIndex | 设置对应列选中项的索引 | columnIndex, optionIndex | - | - | -| getColumnValues | 获取对应列中所有选项 | columnIndex | values | - | -| setColumnValues | 设置对应列中所有选项 | columnIndex, values | - | - | -| confirm | 停止惯性滚动并触发 confirm 事件 | - | - | 2.4.0 | +| 方法名 | 说明 | 参数 | 返回值 | +|------|------|------|------| +| getValues | 获取所有列选中的值 | - | values | +| setValues | 设置所有列选中的值 | values | - | +| getIndexes | 获取所有列选中值对应的索引 | - | indexes | +| setIndexes | 设置所有列选中值对应的索引 | indexes | - | +| getColumnValue | 获取对应列选中的值 | columnIndex | value | +| setColumnValue | 设置对应列选中的值 | columnIndex, value | - | +| getColumnIndex | 获取对应列选中项的索引 | columnIndex | optionIndex | +| setColumnIndex | 设置对应列选中项的索引 | columnIndex, optionIndex | - | +| getColumnValues | 获取对应列中所有选项 | columnIndex | values | +| setColumnValues | 设置对应列中所有选项 | columnIndex, values | - | +| confirm `v2.4.0` | 停止惯性滚动并触发 confirm 事件 | - | - | ## 常见问题 diff --git a/src/popup/README.md b/src/popup/README.md index d0841105c..8a32a45ed 100644 --- a/src/popup/README.md +++ b/src/popup/README.md @@ -118,25 +118,25 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Whether to show popup | *boolean* | `false` | - | -| overlay | Whether to show overlay | *boolean* | `true` | - | -| position | Can be set to `top` `bottom` `right` `left` | *string* | `center` | - | -| overlay-class | Custom overlay class | *string* | - | - | -| overlay-style | Custom overlay style | *object* | - | - | -| duration | Transition duration, unit second | *number* | `0.3` | - | -| round | Whether to show round corner | *boolean* | `false` | 2.0.7 | -| lock-scroll | Whether to lock background scroll | *boolean* | `true` | - | -| lazy-render | Whether to lazy render util appeared | *boolean* | `true` | - | -| close-on-popstate | Whether to close when popstate | *boolean* | `false` | 2.2.10 | -| close-on-click-overlay | Whether to close when click overlay | *boolean* | `true` | - | -| closeable | Whether to show close icon | *boolean* | `false` | 2.2.0 | -| close-icon | Close icon name | *string* | `cross` | 2.2.0 | -| close-icon-position | Close Icon Position，can be set to `top-left` `bottom-left` `bottom-right` | *string* | `top-right` | 2.2.2 | -| transition | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | *string* | - | - | -| get-container | Return the mount node for Popup | *string \| () => Element* | - | - | -| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `false` | 2.2.1 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Whether to show popup | *boolean* | `false` | +| overlay | Whether to show overlay | *boolean* | `true` | +| position | Can be set to `top` `bottom` `right` `left` | *string* | `center` | +| overlay-class | Custom overlay class | *string* | - | +| overlay-style | Custom overlay style | *object* | - | +| duration | Transition duration, unit second | *number* | `0.3` | +| round `v2.0.7` | Whether to show round corner | *boolean* | `false` | +| lock-scroll | Whether to lock background scroll | *boolean* | `true` | +| lazy-render | Whether to lazy render util appeared | *boolean* | `true` | +| close-on-popstate `v2.2.10` | Whether to close when popstate | *boolean* | `false` | +| close-on-click-overlay | Whether to close when click overlay | *boolean* | `true` | +| closeable `v2.2.0` | Whether to show close icon | *boolean* | `false` | +| close-icon `v2.2.0` | Close icon name | *string* | `cross` | +| close-icon-position `v2.2.2` | 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://vuejs.org/v2/api/#transition) | *string* | - | +| get-container | Return the mount node for Popup | *string \| () => Element* | - | +| safe-area-inset-bottom `v2.2.1` | Whether to enable bottom safe area adaptation | *boolean* | `false` | ### Events diff --git a/src/popup/README.zh-CN.md b/src/popup/README.zh-CN.md index 0e0b3eb78..ecf1ff694 100644 --- a/src/popup/README.zh-CN.md +++ b/src/popup/README.zh-CN.md @@ -129,25 +129,25 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 当前组件是否显示 | *boolean* | `false` | - | -| overlay | 是否显示遮罩层 | *boolean* | `true` | - | -| position | 弹出位置，可选值为 `top` `bottom` `right` `left` | *string* | `center` | - | -| overlay-class | 自定义遮罩层类名 | *string* | - | - | -| overlay-style | 自定义遮罩层样式 | *object* | - | - | -| duration | 动画时长，单位秒 | *number* | `0.3` | - | -| round | 是否显示圆角 | *boolean* | `false` | 2.0.7 | -| lock-scroll | 是否锁定背景滚动 | *boolean* | `true` | - | -| lazy-render | 是否在显示弹层时才渲染节点 | *boolean* | `true` | - | -| close-on-popstate | 是否在页面回退时自动关闭 | *boolean* | `false` | 2.2.10 | -| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `true` | - | -| closeable | 是否显示关闭图标 | *boolean* | `false` | 2.2.0 | -| close-icon | 关闭图标名称或图片链接 | *string* | `cross` | 2.2.0 | -| close-icon-position | 关闭图标位置，可选值为`top-left`
`bottom-left` `bottom-right` | *string* | `top-right` | 2.2.2 | -| transition | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | *string* | - | - | -| get-container | 指定挂载的节点 | *string \| () => Element* | - | - | -| safe-area-inset-bottom | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` | 2.2.1 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 当前组件是否显示 | *boolean* | `false` | +| overlay | 是否显示遮罩层 | *boolean* | `true` | +| position | 弹出位置，可选值为 `top` `bottom` `right` `left` | *string* | `center` | +| overlay-class | 自定义遮罩层类名 | *string* | - | +| overlay-style | 自定义遮罩层样式 | *object* | - | +| duration | 动画时长，单位秒 | *number* | `0.3` | +| round `v2.0.7` | 是否显示圆角 | *boolean* | `false` | +| lock-scroll | 是否锁定背景滚动 | *boolean* | `true` | +| lazy-render | 是否在显示弹层时才渲染节点 | *boolean* | `true` | +| close-on-popstate `v2.2.10` | 是否在页面回退时自动关闭 | *boolean* | `false` | +| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `true` | +| closeable `v2.2.0` | 是否显示关闭图标 | *boolean* | `false` | +| close-icon `v2.2.0` | 关闭图标名称或图片链接 | *string* | `cross` | +| close-icon-position `v2.2.2` | 关闭图标位置，可选值为`top-left`
`bottom-left` `bottom-right` | *string* | `top-right` | +| transition | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | *string* | - | +| get-container | 指定挂载的节点 | *string \| () => Element* | - | +| safe-area-inset-bottom `v2.2.1` | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` | ### Events diff --git a/src/progress/README.md b/src/progress/README.md index bd1b380d7..c9310f3b4 100644 --- a/src/progress/README.md +++ b/src/progress/README.md @@ -61,14 +61,14 @@ Use `pivot-text` to custom text，use `color` to custom bar color ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| inactive | Whether to be gray | *boolean* | `false` | - | -| percentage | Percentage | *number* | `0` | - | -| stroke-width | Stroke width | *string \| number* | `4px` | 2.2.1 | -| show-pivot | Whether to show text | *boolean* | `true` | - | -| color | Color | *string* | `#1989fa` | - | -| text-color | Text color | *string* | `#fff` | - | -| track-color | Track color | *string* | `#e5e5e5` | 2.2.9 | -| pivot-text | Text | *string* | percentage | - | -| pivot-color | Text background color | *string* | inherit progress color | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| inactive | Whether to be gray | *boolean* | `false` | +| percentage | Percentage | *number* | `0` | +| stroke-width `v2.2.1` | Stroke width | *string \| number* | `4px` | +| show-pivot | Whether to show text | *boolean* | `true` | +| color | Color | *string* | `#1989fa` | +| text-color | Text color | *string* | `#fff` | +| track-color `v2.2.9` | Track color | *string* | `#e5e5e5` | +| pivot-text | Text | *string* | percentage | +| pivot-color | Text background color | *string* | inherit progress color | diff --git a/src/progress/README.zh-CN.md b/src/progress/README.zh-CN.md index 67cd62f2b..722e9977c 100644 --- a/src/progress/README.zh-CN.md +++ b/src/progress/README.zh-CN.md @@ -64,14 +64,14 @@ Vue.use(Progress); ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| inactive | 是否置灰 | *boolean* | `false` | - | -| percentage | 进度百分比 | *number* | `0` | - | -| stroke-width | 进度条粗细，默认单位为`px` | *string \| number* | `4px` | 2.2.1 | -| show-pivot | 是否显示进度文字 | *boolean* | `true` | - | -| color | 进度条颜色 | *string* | `#1989fa` | - | -| text-color | 进度文字颜色 | *string* | `#fff` | - | -| track-color | 轨道颜色 | *string* | `#e5e5e5` | 2.2.9 | -| pivot-text | 文字显示 | *string* | 百分比文字 | - | -| pivot-color | 文字背景色 | *string* | 与进度条颜色一致 | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| inactive | 是否置灰 | *boolean* | `false` | +| percentage | 进度百分比 | *number* | `0` | +| stroke-width `v2.2.1` | 进度条粗细，默认单位为`px` | *string \| number* | `4px` | +| show-pivot | 是否显示进度文字 | *boolean* | `true` | +| color | 进度条颜色 | *string* | `#1989fa` | +| text-color | 进度文字颜色 | *string* | `#fff` | +| track-color `v2.2.9` | 轨道颜色 | *string* | `#e5e5e5` | +| pivot-text | 文字显示 | *string* | 百分比文字 | +| pivot-color | 文字背景色 | *string* | 与进度条颜色一致 | diff --git a/src/pull-refresh/README.md b/src/pull-refresh/README.md index 65b66ae85..39ba2d2b0 100644 --- a/src/pull-refresh/README.md +++ b/src/pull-refresh/README.md @@ -96,17 +96,17 @@ Use slots to custom tips ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Loading status | *boolean* | - | - | -| pulling-text | Text to show when pulling | *string* | `Pull to refresh...` | - | -| loosing-text | Text to show when loosing | *string* | `Loose to refresh...` | - | -| loading-text | Text to show when loading | *string* | `Loading...` | - | -| success-text | Text to show when loading success | *string* | - | - | -| success-duration | Success text display duration(ms) | *number* | `500` | - | -| animation-duration | Animation duration | *number* | `300` | - | -| head-height | Height of head | *number* | `50` | 2.4.2 | -| disabled | Whether to disable pull refresh | *boolean* | `false` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Loading status | *boolean* | - | +| pulling-text | Text to show when pulling | *string* | `Pull to refresh...` | +| loosing-text | Text to show when loosing | *string* | `Loose to refresh...` | +| loading-text | Text to show when loading | *string* | `Loading...` | +| success-text | Text to show when loading success | *string* | - | +| success-duration | Success text display duration(ms) | *number* | `500` | +| animation-duration | Animation duration | *number* | `300` | +| head-height `v2.4.2` | Height of head | *number* | `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 8412300d6..9918cfb3e 100644 --- a/src/pull-refresh/README.zh-CN.md +++ b/src/pull-refresh/README.zh-CN.md @@ -99,17 +99,17 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 是否处于加载中状态 | *boolean* | - | - | -| pulling-text | 下拉过程提示文案 | *string* | `下拉即可刷新...` | - | -| loosing-text | 释放过程提示文案 | *string* | `释放即可刷新...` | - | -| loading-text | 加载过程提示文案 | *string* | `加载中...` | - | -| success-text | 刷新成功提示文案 | *string* | - | - | -| success-duration | 刷新成功提示展示时长(ms) | *number* | `500` | - | -| animation-duration | 动画时长 | *number* | `300` | - | -| head-height | 顶部内容高度 | *number* | `50` | 2.4.2 | -| disabled | 是否禁用下拉刷新 | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 是否处于加载中状态 | *boolean* | - | +| pulling-text | 下拉过程提示文案 | *string* | `下拉即可刷新...` | +| loosing-text | 释放过程提示文案 | *string* | `释放即可刷新...` | +| loading-text | 加载过程提示文案 | *string* | `加载中...` | +| success-text | 刷新成功提示文案 | *string* | - | +| success-duration | 刷新成功提示展示时长(ms) | *number* | `500` | +| animation-duration | 动画时长 | *number* | `300` | +| head-height `v2.4.2` | 顶部内容高度 | *number* | `50` | +| disabled | 是否禁用下拉刷新 | *boolean* | `false` | ### Events diff --git a/src/radio/README.md b/src/radio/README.md index c6fe97b4b..0b1651022 100644 --- a/src/radio/README.md +++ b/src/radio/README.md @@ -134,24 +134,24 @@ export default { ### Radio Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| name | Radio name | *any* | - | - | -| shape | Can be set to `square` | *string* | `round` | - | -| disabled | Whether to disable radio | *boolean* | `false` | - | -| label-disabled | Whether to disable label click | *boolean* | `false` | - | -| label-position | Can be set to `left` | *string* | `right` | - | -| icon-size | Icon size | *string \| number* | `20px` | - | -| checked-color | Checked color | *string* | `#1989fa` | - | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| name | Radio name | *any* | - | +| shape | Can be set to `square` | *string* | `round` | +| disabled | Whether to disable radio | *boolean* | `false` | +| label-disabled | Whether to disable label click | *boolean* | `false` | +| label-position | Can be set to `left` | *string* | `right` | +| icon-size | Icon size | *string \| number* | `20px` | +| checked-color | Checked color | *string* | `#1989fa` | - | ### RadioGroup Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Name of checked radio | *any* | - | - | -| disabled | Disable all radios | *boolean* | `false` | - | -| icon-size | Icon size of all radios | *string \| number* | `20px` | 2.2.3 | -| checked-color | Checked color of all radios | *string* | `#1989fa` | - | 2.2.3 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Name of checked radio | *any* | - | +| disabled | Disable all radios | *boolean* | `false` | +| icon-size `v2.2.3` | Icon size of all radios | *string \| number* | `20px` | +| checked-color `v2.2.3` | Checked color of all radios | *string* | `#1989fa` | - | ### Radio Events diff --git a/src/radio/README.zh-CN.md b/src/radio/README.zh-CN.md index 4ee25881e..2a11d1c33 100644 --- a/src/radio/README.zh-CN.md +++ b/src/radio/README.zh-CN.md @@ -144,24 +144,24 @@ export default { ### Radio Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| name | 标识符 | *any* | - | - | -| shape | 形状，可选值为 `square` | *string* | `round` | - | -| disabled | 是否为禁用状态 | *boolean* | `false` | - | -| label-disabled | 是否禁用文本内容点击 | *boolean* | `false` | - | -| label-position | 文本位置，可选值为 `left` | *string* | `right` | - | -| icon-size | 图标大小，默认单位为`px` | *string \| number* | `20px` | - | -| checked-color | 选中状态颜色 | *string* | `#1989fa` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| name | 标识符 | *any* | - | +| shape | 形状，可选值为 `square` | *string* | `round` | +| disabled | 是否为禁用状态 | *boolean* | `false` | +| label-disabled | 是否禁用文本内容点击 | *boolean* | `false` | +| label-position | 文本位置，可选值为 `left` | *string* | `right` | +| icon-size | 图标大小，默认单位为`px` | *string \| number* | `20px` | +| checked-color | 选中状态颜色 | *string* | `#1989fa` | ### RadioGroup Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 当前选中项的标识符 | *any* | - | - | -| disabled | 是否禁用所有单选框 | *boolean* | `false` | - | -| icon-size | 所有单选框的图标大小，默认单位为`px` | *string \| number* | `20px` | 2.2.3 | -| checked-color | 所有单选框的选中状态颜色 | *string* | `#1989fa` | 2.2.3 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 当前选中项的标识符 | *any* | - | +| disabled | 是否禁用所有单选框 | *boolean* | `false` | +| icon-size `v2.2.3` | 所有单选框的图标大小，默认单位为`px` | *string \| number* | `20px` | +| checked-color `v2.2.3` | 所有单选框的选中状态颜色 | *string* | `#1989fa` | ### Radio Events diff --git a/src/rate/README.md b/src/rate/README.md index e366310d5..64034a1a6 100644 --- a/src/rate/README.md +++ b/src/rate/README.md @@ -92,21 +92,21 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Current rate | *number* | - | - | -| count | Count | *number* | `5` | - | -| size | Icon size| *string \| number* | `20px` | - | -| gutter | Icon gutter | *string \| number* | `4px` | - | -| color | Selected color | *string* | `#ffd21e` | - | -| void-color | Void color | *string* | `#c7c7c7` | - | -| disabled-color | Disabled color | *string* | `#bdbdbd` | - | -| icon | Selected icon | *string* | `star` | - | -| void-icon | Void icon | *string* | `star-o` | - | -| allow-half | Whether to allow half star | *boolean* | `false` | - | -| readonly | Whether to be readonly | *boolean* | `false` | - | -| disabled | Whether to disable rate | *boolean* | `false` | - | -| touchable | Whether to allow select rate by touch gesture | *boolean* | `true` | 2.2.0 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Current rate | *number* | - | +| count | Count | *number* | `5` | +| size | Icon size| *string \| number* | `20px` | +| gutter | Icon gutter | *string \| number* | `4px` | +| color | Selected color | *string* | `#ffd21e` | +| void-color | Void color | *string* | `#c7c7c7` | +| disabled-color | Disabled color | *string* | `#bdbdbd` | +| icon | Selected icon | *string* | `star` | +| void-icon | Void icon | *string* | `star-o` | +| allow-half | Whether to allow half star | *boolean* | `false` | +| readonly | Whether to be readonly | *boolean* | `false` | +| disabled | Whether to disable rate | *boolean* | `false` | +| touchable `v2.2.0` | Whether to allow select rate by touch gesture | *boolean* | `true` | ### Events diff --git a/src/rate/README.zh-CN.md b/src/rate/README.zh-CN.md index 6dfcffffe..9cc37a1d6 100644 --- a/src/rate/README.zh-CN.md +++ b/src/rate/README.zh-CN.md @@ -92,21 +92,21 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 当前分值 | *number* | - | - | -| count | 图标总数 | *number* | `5` | - | -| size | 图标大小，默认单位为`px` | *string \| number* | `20px` | - | -| gutter | 图标间距，默认单位为`px` | *string \| number* | `4px` | - | -| color | 选中时的颜色 | *string* | `#ffd21e` | - | -| void-color | 未选中时的颜色 | *string* | `#c7c7c7` | - | -| disabled-color | 禁用时的颜色 | *string* | `#bdbdbd` | - | -| icon | 选中时的图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | `star` | - | -| void-icon | 未选中时的图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | `star-o` | - | -| allow-half | 是否允许半选 | *boolean* | `false` | - | -| readonly | 是否为只读状态 | *boolean* | `false` | - | -| disabled | 是否禁用评分 | *boolean* | `false` | - | -| touchable | 是否可以通过滑动手势选择评分 | *boolean* | `true` | 2.2.0 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 当前分值 | *number* | - | +| count | 图标总数 | *number* | `5` | +| size | 图标大小，默认单位为`px` | *string \| number* | `20px` | +| gutter | 图标间距，默认单位为`px` | *string \| number* | `4px` | +| color | 选中时的颜色 | *string* | `#ffd21e` | +| void-color | 未选中时的颜色 | *string* | `#c7c7c7` | +| disabled-color | 禁用时的颜色 | *string* | `#bdbdbd` | +| icon | 选中时的图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | `star` | +| void-icon | 未选中时的图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | `star-o` | +| allow-half | 是否允许半选 | *boolean* | `false` | +| readonly | 是否为只读状态 | *boolean* | `false` | +| disabled | 是否禁用评分 | *boolean* | `false` | +| touchable `v2.2.0` | 是否可以通过滑动手势选择评分 | *boolean* | `true` | ### Events diff --git a/src/search/README.md b/src/search/README.md index 924c1086a..c7b2a4236 100644 --- a/src/search/README.md +++ b/src/search/README.md @@ -62,23 +62,23 @@ Use `action` slot to custom right button, `cancel` event will no longer be trigg ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| label | Left side label | *string* | - | - | -| shape | Shape of field, can be set to `round` | *string* | `square` | - | -| background | Background color of field | *string* | `#f2f2f2` | - | -| maxlength | Max length of value | *string \| number* | - | - | -| placeholder | Placeholder | *string* | - | - | -| clearable | Whether to be clearable | *boolean* | `true` | - | -| 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` | 2.2.2 | -| disabled | Whether to disable field | *boolean* | `false` | - | -| readonly | Whether to be readonly | *boolean* | `false` | - | -| error | Whether to show error info | *boolean* | `false` | - | -| input-align | Text align of field, can be set to `center` `right` | *string* | `left` | - | -| left-icon | Left icon name | *string* | `search` | - | -| right-icon | Right icon name | *string* | - | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| label | Left side label | *string* | - | +| shape | Shape of field, can be set to `round` | *string* | `square` | +| background | Background color of field | *string* | `#f2f2f2` | +| maxlength | Max length of value | *string \| number* | - | +| placeholder | Placeholder | *string* | - | +| clearable | Whether to be clearable | *boolean* | `true` | +| autofocus | Whether to auto focus, unsupported in iOS | *boolean* | `false` | +| show-action | Whether to show right action button | *boolean* | `false` | +| action-text `v2.2.2` | Text of action button | *boolean* | `Cancel` | +| disabled | Whether to disable field | *boolean* | `false` | +| readonly | Whether to be readonly | *boolean* | `false` | +| error | Whether to show error info | *boolean* | `false` | +| input-align | Text align of field, can be set to `center` `right` | *string* | `left` | +| left-icon | Left icon name | *string* | `search` | +| right-icon | Right icon name | *string* | - | ### Events diff --git a/src/search/README.zh-CN.md b/src/search/README.zh-CN.md index 6d84c66c1..52c7d4722 100644 --- a/src/search/README.zh-CN.md +++ b/src/search/README.zh-CN.md @@ -57,23 +57,23 @@ Search 组件提供了`search`和`cancel`事件，`search`事件在点击键盘 ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| label | 搜索框左侧文本 | *string* | - | - | -| shape | 搜索框形状，可选值为 `round` | *string* | `square` | - | -| background | 搜索框背景色 | *string* | `#f2f2f2` | - | -| maxlength | 输入的最大字符数 | *string \| number* | - | - | -| placeholder | 占位提示文字 | *string* | - | - | -| clearable | 是否启用清除控件 | *boolean* | `true` | - | -| autofocus | 是否自动聚焦，iOS 系统不支持该属性 | *boolean* | `false` | - | -| show-action | 是否在搜索框右侧显示取消按钮 | *boolean* | `false` | - | -| action-text | 取消按钮文字 | *boolean* | `取消` | 2.2.2 | -| disabled | 是否禁用输入框 | *boolean* | `false` | - | -| readonly | 是否将输入框设为只读 | *boolean* | `false` | - | -| error | 是否将输入内容标红 | *boolean* | `false` | - | -| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` | - | -| left-icon | 输入框左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | `search` | - | -| right-icon | 输入框右侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| label | 搜索框左侧文本 | *string* | - | +| shape | 搜索框形状，可选值为 `round` | *string* | `square` | +| background | 搜索框背景色 | *string* | `#f2f2f2` | +| maxlength | 输入的最大字符数 | *string \| number* | - | +| placeholder | 占位提示文字 | *string* | - | +| clearable | 是否启用清除控件 | *boolean* | `true` | +| autofocus | 是否自动聚焦，iOS 系统不支持该属性 | *boolean* | `false` | +| show-action | 是否在搜索框右侧显示取消按钮 | *boolean* | `false` | +| action-text `v2.2.2` | 取消按钮文字 | *boolean* | `取消` | +| disabled | 是否禁用输入框 | *boolean* | `false` | +| readonly | 是否将输入框设为只读 | *boolean* | `false` | +| error | 是否将输入内容标红 | *boolean* | `false` | +| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` | +| left-icon | 输入框左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | `search` | +| right-icon | 输入框右侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | ### Events diff --git a/src/sidebar/README.md b/src/sidebar/README.md index bd8d6da67..eab8f9b06 100644 --- a/src/sidebar/README.md +++ b/src/sidebar/README.md @@ -81,9 +81,9 @@ export default { ### Sidebar Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Index of chosen item | *string \| number* | `0` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Index of chosen item | *string \| number* | `0` | ### Sidebar Events @@ -93,15 +93,15 @@ export default { ### SidebarItem Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| title | Content | *string* | `''` | - | -| dot | Whether to show red dot | *boolean* | `false` | 2.2.1 | -| info | Content of the badge | *string \| number* | `''` | - | -| disabled | Whether to be disabled | *boolean* | `false` | 2.2.0 | -| url | Link | *string* | - | - | -| to | Target route of the link, same as to of vue-router | *string \| object* | - | 2.0.4 | -| replace | If true, the navigation will not leave a history record | *boolean* | `false` | 2.0.4 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| title | Content | *string* | `''` | +| dot `v2.2.1` | Whether to show red dot | *boolean* | `false` | +| info | Content of the badge | *string \| number* | `''` | +| disabled `v2.2.0` | Whether to be disabled | *boolean* | `false` | +| url | Link | *string* | - | +| to `v2.0.4` | Target route of the link, same as to of vue-router | *string \| object* | - | +| replace `v2.0.4` | If true, the navigation will not leave a history record | *boolean* | `false` | ### SidebarItem Events diff --git a/src/sidebar/README.zh-CN.md b/src/sidebar/README.zh-CN.md index 7a4d51130..ed1d62428 100644 --- a/src/sidebar/README.zh-CN.md +++ b/src/sidebar/README.zh-CN.md @@ -90,9 +90,9 @@ export default { ### Sidebar Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 当前导航项的索引 | *string \| number* | `0` | 2.0.4 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model `v2.0.4` | 当前导航项的索引 | *string \| number* | `0` | ### Sidebar Events @@ -102,15 +102,15 @@ export default { ### SidebarItem Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| title | 内容 | *string* | `''` | - | -| dot | 是否显示右上角小红点 | *boolean* | `false` | 2.2.1 | -| info | 右上角徽标的内容 | *string \| number* | - | - | -| disabled | 是否禁用该项 | *boolean* | `false` | 2.2.0 | -| url | 点击后跳转的链接地址 | *string* | - | - | -| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | 2.0.4 | -| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` | 2.0.4 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| title | 内容 | *string* | `''` | +| dot `v2.2.1` | 是否显示右上角小红点 | *boolean* | `false` | +| info | 右上角徽标的内容 | *string \| number* | - | +| disabled `v2.2.0` | 是否禁用该项 | *boolean* | `false` | +| url | 点击后跳转的链接地址 | *string* | - | +| to `v2.0.4` | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | +| replace `v2.0.4` | 是否在跳转时替换当前页面历史 | *boolean* | `false` | ### SidebarItem Events diff --git a/src/skeleton/README.md b/src/skeleton/README.md index f9b0bd41c..e7347e058 100644 --- a/src/skeleton/README.md +++ b/src/skeleton/README.md @@ -53,14 +53,14 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| row | Row count | *number* | `0` | - | -| row-width | Row width, can be array | *number \| string \| number[] \| string[]* | `100%` | - | -| title | Whether to show title placeholder | *boolean* | `false` | - | -| title-width | Title width | *string \| number* | `40%` | - | -| avatar | Whether to show avatar placeholder | *boolean* | `false` | - | -| avatar-size | Size of avatar placeholder | *string \| number* | `32px` | - | -| avatar-shape | Shape of avatar placeholder，can be set to `square` | *string* | `round` | - | -| loading | Whether to show skeleton，pass `false` to show child component | *boolean* | `true` | - | -| animate | Whether to enable animation | *boolean* | `true` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| row | Row count | *number* | `0` | +| row-width | Row width, can be array | *number \| string \| number[] \| string[]* | `100%` | +| title | Whether to show title placeholder | *boolean* | `false` | +| title-width | Title width | *string \| number* | `40%` | +| avatar | Whether to show avatar placeholder | *boolean* | `false` | +| avatar-size | Size of avatar placeholder | *string \| number* | `32px` | +| avatar-shape | Shape of avatar placeholder，can be set to `square` | *string* | `round` | +| loading | Whether to show skeleton，pass `false` to show child component | *boolean* | `true` | +| animate | Whether to enable animation | *boolean* | `true` | diff --git a/src/skeleton/README.zh-CN.md b/src/skeleton/README.zh-CN.md index d769f39d3..a807da556 100644 --- a/src/skeleton/README.zh-CN.md +++ b/src/skeleton/README.zh-CN.md @@ -59,14 +59,14 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| row | 段落占位图行数 | *number* | `0` | - | -| row-width | 段落占位图宽度，可传数组来设置每一行的宽度 | *number \| string \| number[] \| string[]* | `100%` | - | -| title | 是否显示标题占位图 | *boolean* | `false` | - | -| title-width | 标题占位图宽度 | *string \| number* | `40%` | - | -| avatar | 是否显示头像占位图 | *boolean* | `false` | - | -| avatar-size | 头像占位图大小 | *string \| number* | `32px` | - | -| avatar-shape | 头像占位图形状，可选值为`square` | *string* | `round` | - | -| loading | 是否显示占位图，传`false`时会展示子组件内容 | *boolean* | `true` | - | -| animate | 是否开启动画 | *boolean* | `true` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| row | 段落占位图行数 | *number* | `0` | +| row-width | 段落占位图宽度，可传数组来设置每一行的宽度 | *number \| string \| number[] \| string[]* | `100%` | +| title | 是否显示标题占位图 | *boolean* | `false` | +| title-width | 标题占位图宽度 | *string \| number* | `40%` | +| avatar | 是否显示头像占位图 | *boolean* | `false` | +| avatar-size | 头像占位图大小 | *string \| number* | `32px` | +| avatar-shape | 头像占位图形状，可选值为`square` | *string* | `round` | +| loading | 是否显示占位图，传`false`时会展示子组件内容 | *boolean* | `true` | +| animate | 是否开启动画 | *boolean* | `true` | diff --git a/src/sku/README.md b/src/sku/README.md index bc4eb7758..c68b6e9fa 100644 --- a/src/sku/README.md +++ b/src/sku/README.md @@ -116,32 +116,32 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Whether to show sku | *boolean* | `false` | - | -| sku | Sku data | *object* | - | - | -| goods | Goods info | *object* | - | - | -| goods-id | Goods id | `string | *number* | - | - | -| price-tag | Tag behind the price | *string* | - | - | -| hide-stock | Whether to hide stock | *boolean* | `false` | - | -| hide-quota-text | Whether to hide quota text | *boolean* | `false` | - | -| hide-selected-text | Whether to hide selected text | *boolean* | `false` | - | -| stock-threshold | stock threshold | *boolean* | `50` | - | -| show-add-cart-btn | Whether to show cart button | *boolean* | `true` | - | -| buy-text | Buy button text | *string* | - | - | - | -| add-cart-text | Add cart button text | *string* | - | - | - | -| quota | Quota (0 as no limit) | *number* | `0` | - | -| quota-used | Used quota | *number* | `0` | - | -| reset-stepper-on-hide | Whether to reset stepper when hide | *boolean* | `false` | - | -| reset-selected-sku-on-hide | Whether to reset selected sku when hide | *boolean* | `false` | - | -| disable-stepper-input | Whether to disable stepper input | *boolean* | `false` | - | -| close-on-click-overlay | Whether to close sku popup when click overlay | *boolean* | `false` | - | -| stepper-title | Quantity title | *string* | `Quantity` | - | -| custom-stepper-config | Custom stepper related config | *object* | `{}` | - | -| message-config | Message related config | *object* | `{}` | - | -| get-container | Return the mount node for sku | *string \| () => Element* | - | - | -| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `false` | 2.2.1 | -| start-sale-num | Minimum quantity | *number* | `1` | 2.3.0 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Whether to show sku | *boolean* | `false` | +| sku | Sku data | *object* | - | +| goods | Goods info | *object* | - | +| goods-id | Goods id | `string | *number* | - | +| price-tag | Tag behind the price | *string* | - | +| hide-stock | Whether to hide stock | *boolean* | `false` | +| hide-quota-text | Whether to hide quota text | *boolean* | `false` | +| hide-selected-text | Whether to hide selected text | *boolean* | `false` | +| stock-threshold | stock threshold | *boolean* | `50` | +| show-add-cart-btn | Whether to show cart button | *boolean* | `true` | +| buy-text | Buy button text | *string* | - | - | +| add-cart-text | Add cart button text | *string* | - | - | +| quota | Quota (0 as no limit) | *number* | `0` | +| quota-used | Used quota | *number* | `0` | +| reset-stepper-on-hide | Whether to reset stepper when hide | *boolean* | `false` | +| reset-selected-sku-on-hide | Whether to reset selected sku when hide | *boolean* | `false` | +| disable-stepper-input | Whether to disable stepper input | *boolean* | `false` | +| close-on-click-overlay | Whether to close sku popup when click overlay | *boolean* | `false` | +| stepper-title | Quantity title | *string* | `Quantity` | +| custom-stepper-config | Custom stepper related config | *object* | `{}` | +| message-config | Message related config | *object* | `{}` | +| get-container | Return the mount node for sku | *string \| () => Element* | - | +| safe-area-inset-bottom `v2.2.1` | Whether to enable bottom safe area adaptation | *boolean* | `false` | +| start-sale-num `v2.3.0` | Minimum quantity | *number* | `1` | ### Events diff --git a/src/sku/README.zh-CN.md b/src/sku/README.zh-CN.md index f5600e0ee..f74420181 100644 --- a/src/sku/README.zh-CN.md +++ b/src/sku/README.zh-CN.md @@ -118,34 +118,34 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 是否显示sku | *boolean* | `false` | - | -| sku | 商品sku数据 | *object* | - | - | -| goods | 商品信息 | *object* | - | - | -| goods-id | 商品 id | *string \| number* | - | - | -| price-tag | 显示在价格后面的标签 | *string* | - | - | -| hide-stock | 是否显示商品剩余库存 | *boolean* | `false` | - | -| hide-quota-text | 是否显示限购提示 | *boolean* | `false` | - | -| hide-selected-text | 是否隐藏已选提示 | *boolean* | `false` | - | -| stock-threshold | 库存阈值。低于这个值会把库存数高亮显示 | *boolean* | `50` | - | -| show-add-cart-btn | 是否显示加入购物车按钮 | *boolean* | `true` | - | -| buy-text | 购买按钮文字 | *string* | `立即购买` | - | -| add-cart-text | 加入购物车按钮文字 | *string* | `加入购物车` | - | -| quota | 限购数，0 表示不限购 | *number* | `0` | - | -| quota-used | 已经购买过的数量 | *number* | `0` | - | -| reset-stepper-on-hide | 隐藏时重置选择的商品数量 | *boolean* | `false` | - | -| reset-selected-sku-on-hide | 隐藏时重置已选择的 sku | *boolean* | `false` | - | -| disable-stepper-input | 是否禁用步进器输入 | *boolean* | `false` | - | -| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `false` | - | -| stepper-title | 数量选择组件左侧文案 | *string* | `购买数量` | - | -| custom-stepper-config | 步进器相关自定义配置 | *object* | `{}` | - | -| message-config | 留言相关配置 | *object* | `{}` | - | -| get-container | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | - | - | -| initial-sku | 默认选中的 sku，具体参考高级用法 | *object* | `{}` | - | -| show-soldout-sku | 是否展示售罄的 sku，默认展示并置灰 | *boolean* | `true` | - | -| safe-area-inset-bottom | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` | 2.2.1 | -| start-sale-num | 起售数量 | *number* | `1` | 2.3.0 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 是否显示sku | *boolean* | `false` | +| sku | 商品sku数据 | *object* | - | +| goods | 商品信息 | *object* | - | +| goods-id | 商品 id | *string \| number* | - | +| price-tag | 显示在价格后面的标签 | *string* | - | +| hide-stock | 是否显示商品剩余库存 | *boolean* | `false` | +| hide-quota-text | 是否显示限购提示 | *boolean* | `false` | +| hide-selected-text | 是否隐藏已选提示 | *boolean* | `false` | +| stock-threshold | 库存阈值。低于这个值会把库存数高亮显示 | *boolean* | `50` | +| show-add-cart-btn | 是否显示加入购物车按钮 | *boolean* | `true` | +| buy-text | 购买按钮文字 | *string* | `立即购买` | +| add-cart-text | 加入购物车按钮文字 | *string* | `加入购物车` | +| quota | 限购数，0 表示不限购 | *number* | `0` | +| quota-used | 已经购买过的数量 | *number* | `0` | +| reset-stepper-on-hide | 隐藏时重置选择的商品数量 | *boolean* | `false` | +| reset-selected-sku-on-hide | 隐藏时重置已选择的 sku | *boolean* | `false` | +| disable-stepper-input | 是否禁用步进器输入 | *boolean* | `false` | +| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `false` | +| stepper-title | 数量选择组件左侧文案 | *string* | `购买数量` | +| custom-stepper-config | 步进器相关自定义配置 | *object* | `{}` | +| message-config | 留言相关配置 | *object* | `{}` | +| get-container | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | *string \| () => Element* | - | +| initial-sku | 默认选中的 sku，具体参考高级用法 | *object* | `{}` | +| show-soldout-sku | 是否展示售罄的 sku，默认展示并置灰 | *boolean* | `true` | +| safe-area-inset-bottom `v2.2.1` | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` | +| start-sale-num `v2.3.0` | 起售数量 | *number* | `1` | ### Events @@ -162,10 +162,10 @@ export default { 通过 [ref](https://cn.vuejs.org/v2/api/#ref) 可以获取到 Sku 实例并调用实例方法 -| 方法名 | 说明 | 参数 | 返回值 | 版本 | -|------|------|------|------|------| -| getSkuData | 获取当前 skuData | - | skuData | - | -| resetSelectedSku | 重置选中规格到初始状态 | - | - | 2.3.0 | +| 方法名 | 说明 | 参数 | 返回值 | +|------|------|------|------| +| getSkuData | 获取当前 skuData | - | skuData | +| resetSelectedSku `v2.3.0` | 重置选中规格到初始状态 | - | - | ### Slots diff --git a/src/slider/README.md b/src/slider/README.md index 2cc16923e..7aab6986c 100644 --- a/src/slider/README.md +++ b/src/slider/README.md @@ -89,17 +89,17 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| value | Current value | *number* | `0` | - | -| max | Max value | *number* | `100` | - | -| min | Min value | *number* | `0` | - | -| step | Step size | *number* | `1` | - | -| bar-height | Height of bar | *string \| number* | `2px` | - | -| active-color | Active color of bar | *string* | `#1989fa` | - | -| inactive-color | Inactive color of bar | *string* | `#e5e5e5` | - | -| disabled | Whether to disable slider | *boolean* | `false` | - | -| vertical | Whether to display slider vertically | *boolean* | `false` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| value | Current value | *number* | `0` | +| max | Max value | *number* | `100` | +| min | Min value | *number* | `0` | +| step | Step size | *number* | `1` | +| bar-height | Height of bar | *string \| number* | `2px` | +| active-color | Active color of bar | *string* | `#1989fa` | +| inactive-color | Inactive color of bar | *string* | `#e5e5e5` | +| disabled | Whether to disable slider | *boolean* | `false` | +| vertical | Whether to display slider vertically | *boolean* | `false` | ### Events diff --git a/src/slider/README.zh-CN.md b/src/slider/README.zh-CN.md index 1b74b6032..c3e91dba8 100644 --- a/src/slider/README.zh-CN.md +++ b/src/slider/README.zh-CN.md @@ -91,17 +91,17 @@ Slider 垂直展示时，高度为 100% 父元素高度 ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| value | 当前进度百分比 | *number* | `0` | - | -| max | 最大值 | *number* | `100` | - | -| min | 最小值 | *number* | `0` | - | -| step | 步长 | *number* | `1` | - | -| bar-height | 进度条高度，默认单位为`px` | *string \| number* | `2px` | - | -| active-color | 进度条激活态颜色 | *string* | `#1989fa` | - | -| inactive-color | 进度条默认颜色 | *string* | `#e5e5e5` | - | -| disabled | 是否禁用滑块 | *boolean* | `false` | - | -| vertical | 是否垂直展示 | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| value | 当前进度百分比 | *number* | `0` | +| max | 最大值 | *number* | `100` | +| min | 最小值 | *number* | `0` | +| step | 步长 | *number* | `1` | +| bar-height | 进度条高度，默认单位为`px` | *string \| number* | `2px` | +| active-color | 进度条激活态颜色 | *string* | `#1989fa` | +| inactive-color | 进度条默认颜色 | *string* | `#e5e5e5` | +| disabled | 是否禁用滑块 | *boolean* | `false` | +| vertical | 是否垂直展示 | *boolean* | `false` | ### Events diff --git a/src/stepper/README.md b/src/stepper/README.md index cf50769dc..87816ad2e 100644 --- a/src/stepper/README.md +++ b/src/stepper/README.md @@ -98,25 +98,25 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Current value | *string \| number* | - | - | -| min | Min value | *string \| number* | `1` | - | -| max | Max value | *string \| number* | - | - | -| default-value | Default value, valid when v-model is empty | *string \| number* | `1` | - | -| step | Value change step | *string \| number* | `1` | - | -| name | Stepper name | *string \| number* | - | 2.0.3 | -| integer | Whether to allow only integers | *boolean* | `false` | - | -| disabled | Disable value change | *boolean* | `false` | - | -| disable-plus | Whether to disable plus button | *boolean* | `false` | 2.2.16 | -| disable-minus | Whether to disable minus button | *boolean* | `false` | 2.2.16 | -| disable-input | Whether to disable input | *boolean* | `false` | - | -| async-change | Whether to enable async change | *boolean* | `false` | - | - | -| input-width | Input width | *string \| number* | `32px` | - | -| button-size | Button size | *string \| number* | `28px` | 2.0.5 | -| show-plus | Whether to show plus button | *boolean* | `true` | 2.1.2 | -| show-minus | Whether to show minus button | *boolean* | `true` | 2.1.2 | -| decimal-length | Decimal length | *number* | - | 2.2.1 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Current value | *string \| number* | - | +| min | Min value | *string \| number* | `1` | +| max | Max value | *string \| number* | - | +| default-value | Default value, valid when v-model is empty | *string \| number* | `1` | +| step | Value change step | *string \| number* | `1` | +| name `v2.0.3` | Stepper name | *string \| number* | - | +| integer | Whether to allow only integers | *boolean* | `false` | +| disabled | Disable value change | *boolean* | `false` | +| disable-plus `v2.2.16` | Whether to disable plus button | *boolean* | `false` | +| disable-minus `v2.2.16` | Whether to disable minus button | *boolean* | `false` | +| disable-input | Whether to disable input | *boolean* | `false` | +| async-change | Whether to enable async change | *boolean* | `false` | - | +| input-width | Input width | *string \| number* | `32px` | +| button-size `v2.0.5` | Button size | *string \| number* | `28px` | +| show-plus `v2.1.2` | Whether to show plus button | *boolean* | `true` | +| show-minus `v2.1.2` | Whether to show minus button | *boolean* | `true` | +| decimal-length `v2.2.1` | Decimal length | *number* | - | ### Events diff --git a/src/stepper/README.zh-CN.md b/src/stepper/README.zh-CN.md index 6f7b86160..efd51d136 100644 --- a/src/stepper/README.zh-CN.md +++ b/src/stepper/README.zh-CN.md @@ -120,25 +120,25 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 当前输入值 | *string \| number* | - | - | -| min | 最小值 | *string \| number* | `1` | - | -| max | 最大值 | *string \| number* | - | - | -| default-value | 初始值，当 v-model 为空时生效 | *string \| number* | `1` | - | -| step | 步长，每次点击时改变的值 | *string \| number* | `1` | - | -| name | 标识符，可以在`change`事件回调参数中获取 | *string \| number* | - | 2.2.11 | -| integer | 是否只允许输入整数 | *boolean* | `false` | - | -| disabled | 是否禁用步进器 | *boolean* | `false` | - | -| disable-plus | 是否禁用增加按钮 | *boolean* | `false` | 2.2.16 | -| disable-minus | 是否禁用减少按钮 | *boolean* | `false` | 2.2.16 | -| disable-input | 是否禁用输入框 | *boolean* | `false` | - | -| async-change | 是否开启异步变更，开启后需要手动控制输入值 | *boolean* | `false` | - | -| input-width | 输入框宽度，默认单位为`px` | *string \| number* | `32px` | - | -| button-size | 按钮大小以及输入框高度，默认单位为`px` | *string \| number* | `28px` | 2.0.5 | -| show-plus | 是否显示增加按钮 | *boolean* | `true` | 2.1.2 | -| show-minus | 是否显示减少按钮 | *boolean* | `true` | 2.1.2 | -| decimal-length | 固定显示的小数位数 | *number* | - | 2.2.1 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 当前输入值 | *string \| number* | - | +| min | 最小值 | *string \| number* | `1` | +| max | 最大值 | *string \| number* | - | +| default-value | 初始值，当 v-model 为空时生效 | *string \| number* | `1` | +| step | 步长，每次点击时改变的值 | *string \| number* | `1` | +| name `v2.2.11` | 标识符，可以在`change`事件回调参数中获取 | *string \| number* | - | +| integer | 是否只允许输入整数 | *boolean* | `false` | +| disabled | 是否禁用步进器 | *boolean* | `false` | +| disable-plus `v2.2.16` | 是否禁用增加按钮 | *boolean* | `false` | +| disable-minus `v2.2.16` | 是否禁用减少按钮 | *boolean* | `false` | +| disable-input | 是否禁用输入框 | *boolean* | `false` | +| async-change | 是否开启异步变更，开启后需要手动控制输入值 | *boolean* | `false` | +| input-width | 输入框宽度，默认单位为`px` | *string \| number* | `32px` | +| button-size `v2.0.5` | 按钮大小以及输入框高度，默认单位为`px` | *string \| number* | `28px` | +| show-plus `v2.1.2` | 是否显示增加按钮 | *boolean* | `true` | +| show-minus `v2.1.2` | 是否显示减少按钮 | *boolean* | `true` | +| decimal-length `v2.2.1` | 固定显示的小数位数 | *number* | - | ### Events diff --git a/src/steps/README.md b/src/steps/README.md index 6d7245451..350dd394b 100644 --- a/src/steps/README.md +++ b/src/steps/README.md @@ -70,14 +70,14 @@ export default { ### Steps Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| active | Active step | *number* | 0 | - | -| description | Description | *string* | - | - | -| direction | Can be set to `vertical` | *string* | `horizontal` | - | -| active-color | Active step color | *string* | `#07c160` | - | -| active-icon | Active icon name | *string* | `checked` | - | -| inactive-icon | Active icon name | *string* | - | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| active | Active step | *number* | 0 | +| description | Description | *string* | - | +| direction | Can be set to `vertical` | *string* | `horizontal` | +| active-color | Active step color | *string* | `#07c160` | +| active-icon | Active icon name | *string* | `checked` | +| inactive-icon | Active icon name | *string* | - | ### Step Slots diff --git a/src/steps/README.zh-CN.md b/src/steps/README.zh-CN.md index fda422d0a..9fdfc3262 100644 --- a/src/steps/README.zh-CN.md +++ b/src/steps/README.zh-CN.md @@ -74,13 +74,13 @@ export default { ### Steps Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| active | 当前步骤 | *number* | 0 | - | -| direction | 显示方向，可选值为 `vertical` | *string* | `horizontal` | - | -| active-color | 激活状态颜色 | *string* | `#07c160` | - | -| active-icon | 激活状态底部图标，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | `checked` | - | -| inactive-icon | 未激活状态底部图标，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| active | 当前步骤 | *number* | 0 | +| direction | 显示方向，可选值为 `vertical` | *string* | `horizontal` | +| active-color | 激活状态颜色 | *string* | `#07c160` | +| active-icon | 激活状态底部图标，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | `checked` | +| inactive-icon | 未激活状态底部图标，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | ### Step Slots diff --git a/src/sticky/README.md b/src/sticky/README.md index 6fda38d64..3e3231afe 100644 --- a/src/sticky/README.md +++ b/src/sticky/README.md @@ -54,11 +54,11 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| offset-top | Offset top | *number* | `0` | - | -| z-index | z-index when sticky | *number* | `99` | - | -| container | Container DOM | *HTMLElement* | - | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| offset-top | Offset top | *number* | `0` | +| z-index | z-index when sticky | *number* | `99` | +| container | Container DOM | *HTMLElement* | - | ### Events diff --git a/src/sticky/README.zh-CN.md b/src/sticky/README.zh-CN.md index 2329a021b..00abb0c57 100644 --- a/src/sticky/README.zh-CN.md +++ b/src/sticky/README.zh-CN.md @@ -64,11 +64,11 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| offset-top | 吸顶时与顶部的距离，单位`px` | *number* | `0` | - | -| z-index | 吸顶时的 z-index | *number* | `99` | - | -| container | 容器对应的 HTML 节点 | *HTMLElement* | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| offset-top | 吸顶时与顶部的距离，单位`px` | *number* | `0` | +| z-index | 吸顶时的 z-index | *number* | `99` | +| container | 容器对应的 HTML 节点 | *HTMLElement* | - | ### Events diff --git a/src/submit-bar/README.md b/src/submit-bar/README.md index 0a3b1c212..458eb69fc 100644 --- a/src/submit-bar/README.md +++ b/src/submit-bar/README.md @@ -70,21 +70,21 @@ Use slot to add custom contents. ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| price | Price | *number* | - | - | -| label | Price left label | *string* | `Total：` | - | -| suffix-label | Price right label | *string* | - | - | -| text-align | Price label text align can be set to `right` `left` | *string* | `right` | 2.3.0 | -| button-text | Button text | *string* | - | - | -| button-type | Button type | *string* | `danger` | - | -| tip | Tip | *string* | - | - | -| tip-icon | Icon | *string* | - | - | -| disabled | Whether to disable button | *boolean* | `false` | - | -| loading | Whether to show loading icon | *boolean* | `false` | - | -| currency | Currency symbol | *string* | `¥` | - | -| decimal-length | number of digits to appear after the decimal point | *number* | `2` | - | -| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `false` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| price | Price | *number* | - | +| 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 `right` `left` | *string* | `right` | +| button-text | Button text | *string* | - | +| button-type | Button type | *string* | `danger` | +| tip | Tip | *string* | - | +| tip-icon | Icon | *string* | - | +| disabled | Whether to disable button | *boolean* | `false` | +| loading | Whether to show loading icon | *boolean* | `false` | +| currency | Currency symbol | *string* | `¥` | +| decimal-length | number of digits to appear after the decimal point | *number* | `2` | +| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `false` | ### Events diff --git a/src/submit-bar/README.zh-CN.md b/src/submit-bar/README.zh-CN.md index 73fc94831..b93d160c8 100644 --- a/src/submit-bar/README.zh-CN.md +++ b/src/submit-bar/README.zh-CN.md @@ -70,21 +70,21 @@ Vue.use(SubmitBar); ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| price | 价格（单位分） | *number* | - | - | -| label | 价格左侧文案 | *string* | `合计：` | - | -| suffix-label | 价格右侧文案 | *string* | - | - | -| text-align | 价格文案对齐方向，可选值为 `right` `left` | *string* | `right` | 2.3.0 | -| button-text | 按钮文字 | *string* | - | - | -| button-type | 按钮类型 | *string* | `danger` | - | -| tip | 提示文案 | *string* | - | - | -| tip-icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | - | -| disabled | 是否禁用按钮 | *boolean* | `false` | - | -| loading | 是否显示加载中的按钮 | *boolean* | `false` | - | -| currency | 货币符号 | *string* | `¥` | - | -| decimal-length | 价格小数点后位数 | *number* | `2` | - | -| safe-area-inset-bottom | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| price | 价格（单位分） | *number* | - | +| label | 价格左侧文案 | *string* | `合计：` | +| suffix-label | 价格右侧文案 | *string* | - | +| text-align `v2.3.0` | 价格文案对齐方向，可选值为 `right` `left` | *string* | `right` | +| button-text | 按钮文字 | *string* | - | +| button-type | 按钮类型 | *string* | `danger` | +| tip | 提示文案 | *string* | - | +| tip-icon | 左侧图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | +| disabled | 是否禁用按钮 | *boolean* | `false` | +| loading | 是否显示加载中的按钮 | *boolean* | `false` | +| currency | 货币符号 | *string* | `¥` | +| decimal-length | 价格小数点后位数 | *number* | `2` | +| safe-area-inset-bottom | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` | ### Events diff --git a/src/swipe-cell/README.md b/src/swipe-cell/README.md index 2e9b50c3f..2a9ceb497 100644 --- a/src/swipe-cell/README.md +++ b/src/swipe-cell/README.md @@ -71,14 +71,14 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| name | Identifier of SwipeCell | *string \| number* | - | 2.0.4 | -| before-close | Callback function before close | *Function* | - | 2.3.0 | -| disabled | Whether to disabled swipe | *boolean* | `false` | - | -| left-width | Width of the left swipe area | *number* | `auto` | - | -| right-width | Width of the right swipe area | *number* | `auto` | - | -| stop-propagation | Whether to stop touchmove event propagation | *boolean* | `false` | 2.1.0 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| name `v2.0.4` | Identifier of SwipeCell | *string \| number* | - | +| before-close `v2.3.0` | Callback function before close | *Function* | - | +| disabled | Whether to disabled swipe | *boolean* | `false` | +| left-width | Width of the left swipe area | *number* | `auto` | +| right-width | Width of the right swipe area | *number* | `auto` | +| stop-propagation `v2.1.0` | Whether to stop touchmove event propagation | *boolean* | `false` | ### Slots diff --git a/src/swipe-cell/README.zh-CN.md b/src/swipe-cell/README.zh-CN.md index 328733c93..df147b726 100644 --- a/src/swipe-cell/README.zh-CN.md +++ b/src/swipe-cell/README.zh-CN.md @@ -77,14 +77,14 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| name | 标识符，可以在事件参数中获取到 | *string \| number* | - | 2.0.4 | -| before-close | 关闭前的回调函数 | *Function* | - | 2.3.0 | -| disabled | 是否禁用滑动 | *boolean* | `false` | - | -| left-width | 指定左侧滑动区域宽度 | *number* | `auto` | - | -| right-width | 指定右侧滑动区域宽度 | *number* | `auto` | - | -| stop-propagation | 是否阻止滑动事件冒泡 | *boolean* | `false` | 2.1.0 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| name `v2.0.4` | 标识符，可以在事件参数中获取到 | *string \| number* | - | +| before-close `v2.3.0` | 关闭前的回调函数 | *Function* | - | +| disabled | 是否禁用滑动 | *boolean* | `false` | +| left-width | 指定左侧滑动区域宽度 | *number* | `auto` | +| right-width | 指定右侧滑动区域宽度 | *number* | `auto` | +| stop-propagation `v2.1.0` | 是否阻止滑动事件冒泡 | *boolean* | `false` | ### Slots diff --git a/src/swipe/README.md b/src/swipe/README.md index 3bab04b61..b2e141860 100644 --- a/src/swipe/README.md +++ b/src/swipe/README.md @@ -128,42 +128,42 @@ export default { ### Swipe Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| autoplay | Autoplay interval (ms) | *number* | - | - | -| duration | Animation duration (ms) | *number* | `500` | - | -| initial-swipe | Index of initial swipe, start from 0 | *number* | `0` | - | -| width | Set Swiper Item Width | *number* | `0` | - | -| height | Set Swiper Item Height | *number* | `0` | - | -| loop | Whether to enable loop | *boolean* | `true` | - | -| show-indicators | Whether to show indicators | *boolean* | `true` | - | -| indicator-color | Indicator color | *string* | `#1989fa` | - | -| 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` | 2.1.0 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| autoplay | Autoplay interval (ms) | *number* | - | +| duration | Animation duration (ms) | *number* | `500` | +| initial-swipe | Index of initial swipe, start from 0 | *number* | `0` | +| width | Set Swiper Item Width | *number* | `0` | +| height | Set Swiper Item Height | *number* | `0` | +| loop | Whether to enable loop | *boolean* | `true` | +| show-indicators | Whether to show indicators | *boolean* | `true` | +| indicator-color | Indicator color | *string* | `#1989fa` | +| vertical | Whether to be vertical Scrolling | *boolean* | `false` | +| touchable | Whether to allow swipe by touch gesture | *boolean* | `true` | +| stop-propagation `v2.1.0` | Whether to stop touchmove event propagation | *boolean* | `false` | ### Swipe Events -| Event | Description | Arguments | Version | -|------|------|------|------| -| change | Triggered when current swipe change | index: index of current swipe | - | +| Event | Description | Arguments | +|------|------|------| +| change | Triggered when current swipe change | index: index of current swipe | ### SwipeItem Events -| Event | Description | Arguments | Version | -|------|------|------|------| -| click | Triggered when clicked | event: Event | - | +| Event | Description | Arguments | +|------|------|------| +| click | Triggered when clicked | event: Event | ### Swipe Methods Use [ref](https://vuejs.org/v2/api/#ref) to get Swipe instance and call instance methods -| Name | Description | Attribute | Return value | Version | -|------|------|------|------|------| -| prev | Swipe to prev item | - | - | 2.4.2 | -| next | Swipe to next item | - | - | 2.4.2 | -| swipeTo | Swipe to target index | index: target index, options: Options | void | - | -| resize | Resize Swipe when container element resized | - | void | 2.2.14 | +| Name | Description | Attribute | Return value | +|------|------|------|------| +| prev `v2.4.2` | Swipe to prev item | - | - | +| next `v2.4.2` | Swipe to next item | - | - | +| swipeTo | Swipe to target index | index: target index, options: Options | void | +| resize `v2.2.14` | Resize Swipe when container element resized | - | void | ### swipeTo Options @@ -173,7 +173,7 @@ Use [ref](https://vuejs.org/v2/api/#ref) to get Swipe instance and call instance ### Swipe Slots -| Name | Description | Version | -|------|------|------| -| default | Content | - | -| indicator | Custom indicator | - | +| Name | Description | +|------|------| +| default | Content | +| indicator | Custom indicator | diff --git a/src/swipe/README.zh-CN.md b/src/swipe/README.zh-CN.md index 6b7a584cf..061263fcc 100644 --- a/src/swipe/README.zh-CN.md +++ b/src/swipe/README.zh-CN.md @@ -134,42 +134,42 @@ export default { ### Swipe Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| autoplay | 自动轮播间隔，单位为 ms | *number* | - | - | -| duration | 动画时长，单位为 ms | *number* | `500` | - | -| initial-swipe | 初始位置索引值 | *number* | `0` | - | -| width | 滑块宽度 | *number* | `auto` | - | -| height | 滑块高度 | *number* | `auto` | - | -| loop | 是否开启循环播放 | *boolean* | `true` | - | -| show-indicators | 是否显示指示器 | *boolean* | `true` | - | -| indicator-color | 指示器颜色 | *string* | `#1989fa` | - | -| vertical | 是否为纵向滚动 | *boolean* | `false` | - | -| touchable | 是否可以通过手势滑动 | *boolean* | `true` | - | -| stop-propagation | 是否阻止滑动事件冒泡 | *boolean* | `true` | 2.2.13 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| autoplay | 自动轮播间隔，单位为 ms | *number* | - | +| duration | 动画时长，单位为 ms | *number* | `500` | +| initial-swipe | 初始位置索引值 | *number* | `0` | +| width | 滑块宽度 | *number* | `auto` | +| height | 滑块高度 | *number* | `auto` | +| loop | 是否开启循环播放 | *boolean* | `true` | +| show-indicators | 是否显示指示器 | *boolean* | `true` | +| indicator-color | 指示器颜色 | *string* | `#1989fa` | +| vertical | 是否为纵向滚动 | *boolean* | `false` | +| touchable | 是否可以通过手势滑动 | *boolean* | `true` | +| stop-propagation `v2.2.13` | 是否阻止滑动事件冒泡 | *boolean* | `true` | ### Swipe Events -| 事件名 | 说明 | 回调参数 | 版本 | -|------|------|------|------| -| change | 每一页轮播结束后触发 | index, 当前页的索引 | - | +| 事件名 | 说明 | 回调参数 | +|------|------|------| +| change | 每一页轮播结束后触发 | index, 当前页的索引 | ### SwipeItem Events -| 事件名 | 说明 | 回调参数 | 版本 | -|------|------|------|------| -| click | 点击时触发 | event: Event | - | +| 事件名 | 说明 | 回调参数 | +|------|------|------| +| click | 点击时触发 | event: Event | ### Swipe 方法 通过 [ref](https://cn.vuejs.org/v2/api/#ref) 可以获取到 Swipe 实例并调用实例方法 -| 方法名 | 说明 | 参数 | 返回值 | 版本 | -|------|------|------|------|------| -| prev | 切换到上一轮播 | - | - | 2.4.2 | -| next | 切换到下一轮播 | - | - | 2.4.2 | -| swipeTo | 切换到指定位置 | index: number, options: Options | void | - | -| resize | 外层元素大小变化后，可以调用此方法来触发重绘 | - | void | 2.2.14 | +| 方法名 | 说明 | 参数 | 返回值 | +|------|------|------|------| +| prev `v2.4.2` | 切换到上一轮播 | - | - | +| next `v2.4.2` | 切换到下一轮播 | - | - | +| swipeTo | 切换到指定位置 | index: number, options: Options | void | +| resize `v2.2.14` | 外层元素大小变化后，可以调用此方法来触发重绘 | - | void | ### swipeTo Options 格式 @@ -179,10 +179,10 @@ export default { ### Swipe Slots -| 名称 | 说明 | 版本 | -|------|------|------| -| default | 轮播内容 | - | -| indicator | 自定义指示器 | - | +| 名称 | 说明 | +|------|------| +| default | 轮播内容 | +| indicator | 自定义指示器 | ## 常见问题 diff --git a/src/switch-cell/README.md b/src/switch-cell/README.md index e9631f361..d4328021a 100644 --- a/src/switch-cell/README.md +++ b/src/switch-cell/README.md @@ -57,19 +57,19 @@ use `loading` property to keep component in loading state ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | on-off state of the switch | *any* | `false` | - | -| title | the left side title | *string* | `''` | - | -| border | whether to show cell border | *boolean* | `true` | - | -| cell-size | Cell size，can be set to `large` | *string* | - | - | -| loading | whether switch is loading | *boolean* | `false` | - | -| disabled | whether to disable switch | *boolean* | `false` | - | -| size | Size of switch | *string \| number* | `24px` | - | -| active-color | Background of switch color when active | *string* | `#1989fa` | - | -| inactive-color | Background of switch color when inactive | *string* | `#fff` | - | -| active-value | Value when active | *any* | `true` | - | -| inactive-value | Value when inactive | *any* | `false` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | on-off state of the switch | *any* | `false` | +| title | the left side title | *string* | `''` | +| border | whether to show cell border | *boolean* | `true` | +| cell-size | Cell size，can be set to `large` | *string* | - | +| loading | whether switch is loading | *boolean* | `false` | +| disabled | whether to disable switch | *boolean* | `false` | +| size | Size of switch | *string \| number* | `24px` | +| active-color | Background of switch color when active | *string* | `#1989fa` | +| inactive-color | Background of switch color when inactive | *string* | `#fff` | +| active-value | Value when active | *any* | `true` | +| inactive-value | Value when inactive | *any* | `false` | ### Events diff --git a/src/switch-cell/README.zh-CN.md b/src/switch-cell/README.zh-CN.md index 2ccfeb728..8ef1d28fa 100644 --- a/src/switch-cell/README.zh-CN.md +++ b/src/switch-cell/README.zh-CN.md @@ -57,19 +57,19 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 开关状态 | *any* | `false` | - | -| title | 左侧标题 | *string* | `''` | - | -| border | 是否展示单元格内边框 | *boolean* | `true` | - | -| cell-size | 单元格大小，可选值为 `large` | *string* | - | -| loading | 是否为加载状态 | *boolean* | `false` | - | -| disabled | 是否为禁用状态 | *boolean* | `false` | - | -| size | 开关尺寸 | *string \| number* | `24px` | - | -| active-color | 开关时的背景色 | *string* | `#1989fa` | - | -| inactive-color | 开关时的背景色 | *string* | `#fff` | - | -| active-value | 打开时的值 | *any* | `true` | - | -| inactive-value | 关闭时的值 | *any* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 开关状态 | *any* | `false` | +| title | 左侧标题 | *string* | `''` | +| border | 是否展示单元格内边框 | *boolean* | `true` | +| cell-size | 单元格大小，可选值为 `large` | *string* | +| loading | 是否为加载状态 | *boolean* | `false` | +| disabled | 是否为禁用状态 | *boolean* | `false` | +| size | 开关尺寸 | *string \| number* | `24px` | +| active-color | 开关时的背景色 | *string* | `#1989fa` | +| inactive-color | 开关时的背景色 | *string* | `#fff` | +| active-value | 打开时的值 | *any* | `true` | +| inactive-value | 关闭时的值 | *any* | `false` | ### Events diff --git a/src/switch/README.md b/src/switch/README.md index 0bacb763e..0a3f3d07e 100644 --- a/src/switch/README.md +++ b/src/switch/README.md @@ -82,20 +82,20 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Check status of Switch | *any* | `false` | - | -| loading | Whether to show loading icon | *boolean* | `false` | - | -| disabled | Whether to disable switch | *boolean* | `false` | - | -| size | Size of switch | *string \| number* | `30px` | 2.2.11 | -| active-color | Background color when active | *string* | `#1989fa` | - | -| inactive-color | Background color when inactive | *string* | `#fff` | - | -| active-value | Value when active | *any* | `true` | - | -| inactive-value | Value when inactive | *any* | `false` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Check status of Switch | *any* | `false` | +| loading | Whether to show loading icon | *boolean* | `false` | +| disabled | Whether to disable switch | *boolean* | `false` | +| size `v2.2.11` | Size of switch | *string \| number* | `30px` | +| active-color | Background color when active | *string* | `#1989fa` | +| inactive-color | Background color when inactive | *string* | `#fff` | +| active-value | Value when active | *any* | `true` | +| inactive-value | Value when inactive | *any* | `false` | ### Events -| Event | Description | Parameters | Version | -|------|------|------|------| -| change | Triggered when check status changed | checked: is switch checked | - | -| click | Triggered when clicked | event: Event | 2.2.11 | +| Event | Description | Parameters | +|------|------|------| +| change | Triggered when check status changed | checked: is switch checked | +| click `v2.2.11` | Triggered when clicked | event: Event | diff --git a/src/switch/README.zh-CN.md b/src/switch/README.zh-CN.md index 13460c7e7..c867124f5 100644 --- a/src/switch/README.zh-CN.md +++ b/src/switch/README.zh-CN.md @@ -94,20 +94,20 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 开关选中状态 | *any* | `false` | - | -| loading | 是否为加载状态 | *boolean* | `false` | - | -| disabled | 是否为禁用状态 | *boolean* | `false` | - | -| size | 开关尺寸，默认单位为`px` | *string \| number* | `30px` | 2.2.11 | -| active-color | 打开时的背景色 | *string* | `#1989fa` | - | -| inactive-color | 关闭时的背景色 | *string* | `#fff` | - | -| active-value | 打开时的值 | *any* | `true` | - | -| inactive-value | 关闭时的值 | *any* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 开关选中状态 | *any* | `false` | +| loading | 是否为加载状态 | *boolean* | `false` | +| disabled | 是否为禁用状态 | *boolean* | `false` | +| size `v2.2.11` | 开关尺寸，默认单位为`px` | *string \| number* | `30px` | +| active-color | 打开时的背景色 | *string* | `#1989fa` | +| inactive-color | 关闭时的背景色 | *string* | `#fff` | +| active-value | 打开时的值 | *any* | `true` | +| inactive-value | 关闭时的值 | *any* | `false` | ### Events -| 事件名 | 说明 | 回调参数 | 版本 | -|------|------|------|------| -| change | 开关状态切换回调 | checked: 是否选中开关 | - | -| click | 点击时触发 | event: Event | 2.2.11 | +| 事件名 | 说明 | 回调参数 | +|------|------|------| +| change | 开关状态切换回调 | checked: 是否选中开关 | +| click `v2.2.11` | 点击时触发 | event: Event | diff --git a/src/tab/README.md b/src/tab/README.md index f5cfbab8b..1a64afbea 100644 --- a/src/tab/README.md +++ b/src/tab/README.md @@ -186,50 +186,50 @@ In scrollspy mode, the list of content will be tiled ### Tabs Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Index of active tab | *string \| number* | `0` | - | -| type | Can be set to `line` `card` | *string* | `line` | - | -| duration | Toggle tab's animation time | *number* | `0.3` | - | - | -| background | Background color | *string* | `white` | - | -| line-width | Width of tab line | *string \| number* | Width of active tab | - | -| line-height | Height of tab line | *string \| number* | `3px` | - | -| color | Tab color | *string* | `#ee0a24` | - | -| title-active-color | Title active color | *string* | - | - | -| title-inactive-color | Title inactive color | *string* | - | - | -| swipe-threshold | Set swipe tabs threshold | *number* | `4` | - | - | -| offset-top | Offset top when use sticky mode | *number* | `0` | - | -| animated | Whether to change tabs with animation | *boolean* | `false` | - | -| border | Whether to show border when `type="line"` | *boolean* | `true` | - | -| ellipsis | Whether to ellipsis too long title | *boolean* | `true` | - | -| 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 | Whether to use scrollspy mode | *boolean* | `false` | 2.3.0 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Index of active tab | *string \| number* | `0` | +| type | Can be set to `line` `card` | *string* | `line` | +| duration | Toggle tab's animation time | *number* | `0.3` | - | +| background | Background color | *string* | `white` | +| line-width | Width of tab line | *string \| number* | Width of active tab | +| line-height | Height of tab line | *string \| number* | `3px` | +| color | Tab color | *string* | `#ee0a24` | +| title-active-color | Title active color | *string* | - | +| title-inactive-color | Title inactive color | *string* | - | +| swipe-threshold | Set swipe tabs threshold | *number* | `4` | - | +| offset-top | Offset top when use sticky mode | *number* | `0` | +| animated | Whether to change tabs with animation | *boolean* | `false` | +| border | Whether to show border when `type="line"` | *boolean* | `true` | +| ellipsis | Whether to ellipsis too long title | *boolean* | `true` | +| 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` | ### Tab Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| name | Identifier | *string \| number* | Index of tab | - | -| title | Title | *string* | - | - | -| title-style | Custom title style | *any* | - | 2.2.14 | -| disabled | Whether to disable tab | *boolean* | `false` | - | -| dot | Whether to show red dot on the title | *boolean* | `false` | 2.3.0 | -| info | Content of the badge on the title | *string \| number* | - | 2.3.0 | -| url | Link | *string* | - | 2.2.1 | -| to | Target route of the link, same as to of vue-router | *string \| object* | - | 2.2.1 | -| replace | If true, the navigation will not leave a history record | *boolean* | `false` | 2.2.1 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| name | Identifier | *string \| number* | Index of tab | +| title | Title | *string* | - | +| title-style `v2.2.14` | Custom title style | *any* | - | +| disabled | Whether to disable tab | *boolean* | `false` | +| dot `v2.3.0` | Whether to show red dot on the title | *boolean* | `false` | +| info `v2.3.0` | Content of the badge on the title | *string \| number* | - | +| url `v2.2.1` | Link | *string* | - | +| to `v2.2.1` | Target route of the link, same as to of vue-router | *string \| object* | - | +| replace `v2.2.1` | If true, the navigation will not leave a history record | *boolean* | `false` | ### Tabs Events -| Event | Description | Arguments | Version | -|------|------|------|------| -| click | Triggered when click tab | name，title | - | -| change | Triggered when active tab changed | name，title | - | -| disabled | Triggered when click disabled tab | name，title | - | -| rendered | Triggered when content first rendered in lazy-render mode | name，title | 2.3.0 | -| scroll | Triggered when tab scroll in sticky mode | object: { scrollTop, isFixed } | - | +| Event | Description | Arguments | +|------|------|------| +| click | Triggered when click tab | name，title | +| change | Triggered when active tab changed | name，title | +| disabled | Triggered when click disabled tab | name，title | +| rendered `v2.3.0` | Triggered when content first rendered in lazy-render mode | name，title | +| scroll | Triggered when tab scroll in sticky mode | object: { scrollTop, isFixed } | ### Tabs Methods diff --git a/src/tab/README.zh-CN.md b/src/tab/README.zh-CN.md index 3e0a8e207..237ef9e1c 100644 --- a/src/tab/README.zh-CN.md +++ b/src/tab/README.zh-CN.md @@ -190,50 +190,50 @@ export default { ### Tabs Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 绑定当前选中标签的标识符 | *string \| number* | `0` | - | -| type | 样式类型，可选值为`card` | *string* | `line` | - | -| duration | 动画时间，单位秒 | *number* | `0.3` | - | -| background | 标签栏背景色 | *string* | `white` | - | -| line-width | 底部条宽度，默认单位 px | *string \| number* | `auto` | - | -| line-height | 底部条高度，默认单位 px | *string \| number* | `3px` | - | -| color | 标签主题色 | *string* | `#ee0a24` | - | -| title-active-color | 标题选中态颜色 | *string* | - | - | -| title-inactive-color | 标题默认态颜色 | *string* | - | - | -| swipe-threshold | 滚动阈值，标签数量超过多少个可滚动 | *number* | `4` | - | -| offset-top | 粘性定位布局下与顶部的最小距离，单位 px | *number* | `0` | - | -| animated | 是否开启切换标签内容时的转场动画 | *boolean* | `false` | - | -| border | 是否显示标签栏外边框，仅在`type="line"`时有效 | *boolean* | `true` | - | -| ellipsis | 是否省略过长的标题文字 | *boolean* | `true` | - | -| sticky | 是否使用粘性定位布局 | *boolean* | `false` | - | -| swipeable | 是否开启手势滑动切换 | *boolean* | `false` | - | -| lazy-render | 是否开启延迟渲染（首次切换到标签时才触发内容渲染） | *boolean* | `true` | - | -| scrollspy | 是否开启滚动导航 | *boolean* | `false` | 2.3.0 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 绑定当前选中标签的标识符 | *string \| number* | `0` | +| type | 样式类型，可选值为`card` | *string* | `line` | +| duration | 动画时间，单位秒 | *number* | `0.3` | +| background | 标签栏背景色 | *string* | `white` | +| line-width | 底部条宽度，默认单位 px | *string \| number* | `auto` | +| line-height | 底部条高度，默认单位 px | *string \| number* | `3px` | +| color | 标签主题色 | *string* | `#ee0a24` | +| title-active-color | 标题选中态颜色 | *string* | - | +| title-inactive-color | 标题默认态颜色 | *string* | - | +| swipe-threshold | 滚动阈值，标签数量超过多少个可滚动 | *number* | `4` | +| offset-top | 粘性定位布局下与顶部的最小距离，单位 px | *number* | `0` | +| animated | 是否开启切换标签内容时的转场动画 | *boolean* | `false` | +| border | 是否显示标签栏外边框，仅在`type="line"`时有效 | *boolean* | `true` | +| ellipsis | 是否省略过长的标题文字 | *boolean* | `true` | +| sticky | 是否使用粘性定位布局 | *boolean* | `false` | +| swipeable | 是否开启手势滑动切换 | *boolean* | `false` | +| lazy-render | 是否开启延迟渲染（首次切换到标签时才触发内容渲染） | *boolean* | `true` | +| scrollspy `v2.3.0` | 是否开启滚动导航 | *boolean* | `false` | ### Tab Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| name | 标签名称，作为匹配的标识符 | *string \| number* | 标签的索引值 | 2.0.6 | -| title | 标题 | *string* | - | - | -| title-style | 自定义标题样式 | *any* | - | 2.2.14 | -| disabled | 是否禁用标签 | *boolean* | `false` | - | -| dot | 是否在标题右上角显示小红点 | *boolean* | `false` | 2.3.0 | -| info | 标题右上角徽标的内容 | *string \| number* | - | 2.3.0 | -| url | 点击后跳转的链接地址 | *string* | - | 2.2.1 | -| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | 2.2.1 | -| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` | 2.2.1 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| name `v2.0.6` | 标签名称，作为匹配的标识符 | *string \| number* | 标签的索引值 | +| title | 标题 | *string* | - | +| title-style `v2.2.14` | 自定义标题样式 | *any* | - | +| disabled | 是否禁用标签 | *boolean* | `false` | +| dot `v2.3.0` | 是否在标题右上角显示小红点 | *boolean* | `false` | +| info `v2.3.0` | 标题右上角徽标的内容 | *string \| number* | - | +| url `v2.2.1` | 点击后跳转的链接地址 | *string* | - | +| to `v2.2.1` | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | +| replace `v2.2.1` | 是否在跳转时替换当前页面历史 | *boolean* | `false` | ### Tabs Events -| 事件名 | 说明 | 回调参数 | 版本 | -|------|------|------|------| -| click | 点击标签时触发 | name：标识符，title：标题 | - | -| change | 当前激活的标签改变时触发 | name：标识符，title：标题 | - | -| disabled | 点击被禁用的标签时触发 | name：标识符，title：标题 | - | -| rendered | 标签内容首次渲染时触发（仅在开启延迟渲染后触发） | name：标识符，title：标题 | 2.3.0 | -| scroll | 滚动时触发，仅在 sticky 模式下生效 | { scrollTop: 距离顶部位置, isFixed: 是否吸顶 } | - | +| 事件名 | 说明 | 回调参数 | +|------|------|------| +| click | 点击标签时触发 | name：标识符，title：标题 | +| change | 当前激活的标签改变时触发 | name：标识符，title：标题 | +| disabled | 点击被禁用的标签时触发 | name：标识符，title：标题 | +| rendered `v2.3.0` | 标签内容首次渲染时触发（仅在开启延迟渲染后触发） | name：标识符，title：标题 | +| scroll | 滚动时触发，仅在 sticky 模式下生效 | { scrollTop: 距离顶部位置, isFixed: 是否吸顶 } | ### Tabs 方法 diff --git a/src/tabbar/README.md b/src/tabbar/README.md index 50d54d2c8..74c4add07 100644 --- a/src/tabbar/README.md +++ b/src/tabbar/README.md @@ -161,16 +161,16 @@ export default { ### Tabbar Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| v-model | Identifier of current tab | *string \| number* | `0` | - | -| fixed | Whether to fixed bottom | *boolean* | `true` | - | -| border | Whether to show border | *boolean* | `true` | - | -| z-index | Z-index | *number* | `1` | - | -| active-color | Color of active tab item | *string* | `#1989fa` | - | -| inactive-color | Color of inactive tab item | *string* | `#7d7e80` | - | -| route | Whether to enable route mode | *boolean* | `false` | - | -| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `false` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| v-model | Identifier of current tab | *string \| number* | `0` | +| fixed | Whether to fixed bottom | *boolean* | `true` | +| border | Whether to show border | *boolean* | `true` | +| z-index | Z-index | *number* | `1` | +| active-color | Color of active tab item | *string* | `#1989fa` | +| inactive-color | Color of inactive tab item | *string* | `#7d7e80` | +| route | Whether to enable route mode | *boolean* | `false` | +| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | *boolean* | `false` | ### Tabbar Events @@ -180,15 +180,15 @@ export default { ### TabbarItem Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| name | Identifier | *string \| number* | Item index | - | -| icon | Icon name | *string* | - | - | -| dot | Whether to show red dot | *boolean* | - | - | -| info | Content of the badge | *string \| number* | - | - | -| 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` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| name | Identifier | *string \| number* | Item index | +| icon | Icon name | *string* | - | +| dot | Whether to show red dot | *boolean* | - | +| info | Content of the badge | *string \| number* | - | +| 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` | ### TabbarItem Slots diff --git a/src/tabbar/README.zh-CN.md b/src/tabbar/README.zh-CN.md index 640ee18dc..dee732a37 100644 --- a/src/tabbar/README.zh-CN.md +++ b/src/tabbar/README.zh-CN.md @@ -168,16 +168,16 @@ export default { ### Tabbar Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| v-model | 当前选中标签的名称或索引值 | *string \| number* | `0` | - | -| fixed | 是否固定在底部 | *boolean* | `true` | - | -| border | 是否显示外边框 | *boolean* | `true` | - | -| z-index | 元素 z-index | *number* | `1` | - | -| active-color | 选中标签的颜色 | *string* | `#1989fa` | - | -| inactive-color | 未选中标签的颜色 | *string* | `#7d7e80` | - | -| route | 是否开启路由模式 | *boolean* | `false` | - | -| safe-area-inset-bottom | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| v-model | 当前选中标签的名称或索引值 | *string \| number* | `0` | +| fixed | 是否固定在底部 | *boolean* | `true` | +| border | 是否显示外边框 | *boolean* | `true` | +| z-index | 元素 z-index | *number* | `1` | +| active-color | 选中标签的颜色 | *string* | `#1989fa` | +| inactive-color | 未选中标签的颜色 | *string* | `#7d7e80` | +| route | 是否开启路由模式 | *boolean* | `false` | +| safe-area-inset-bottom | 是否开启底部安全区适配，[详细说明](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` | ### Tabbar Events @@ -187,15 +187,15 @@ export default { ### TabbarItem Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| name | 标签名称，作为匹配的标识符 | *string \| number* | 当前标签的索引值 | - | -| icon | 图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon)| *string* | - | - | -| dot | 是否显示图标右上角小红点 | *boolean* | `false` | - | -| info | 图标右上角徽标的内容 | *string \| number* | - | - | -| url | 点击后跳转的链接地址 | *string* | - | - | -| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | - | -| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| name | 标签名称，作为匹配的标识符 | *string \| number* | 当前标签的索引值 | +| icon | 图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon)| *string* | - | +| dot | 是否显示图标右上角小红点 | *boolean* | `false` | +| info | 图标右上角徽标的内容 | *string \| number* | - | +| url | 点击后跳转的链接地址 | *string* | - | +| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | *string \| object* | - | +| replace | 是否在跳转时替换当前页面历史 | *boolean* | `false` | ### TabbarItem Slots diff --git a/src/tag/README.md b/src/tag/README.md index 56d9f458e..2defa4523 100644 --- a/src/tag/README.md +++ b/src/tag/README.md @@ -114,16 +114,16 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| type | Type, can be set to `primary` `success` `danger` `warning` | *string* | `default` | - | -| size | Size, can be set to `large` `medium` | *string* | - | - | -| color | Custom color | *string* | - | - | -| plain | Whether to be plain style | *boolean* | `false` | - | -| round | Whether to be round style | *boolean* | `false` | - | -| mark | Whether to be mark style | *boolean* | `false` | - | -| text-color | Text color | *string* | `white` | - | -| closeable | Whether to be closeable | *boolean* | `false` | 2.2.9 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| type | Type, can be set to `primary` `success` `danger` `warning` | *string* | `default` | +| size | Size, can be set to `large` `medium` | *string* | - | +| color | Custom color | *string* | - | +| plain | Whether to be plain style | *boolean* | `false` | +| round | Whether to be round style | *boolean* | `false` | +| mark | Whether to be mark style | *boolean* | `false` | +| text-color | Text color | *string* | `white` | +| closeable `v2.2.9` | Whether to be closeable | *boolean* | `false` | ### Slots diff --git a/src/tag/README.zh-CN.md b/src/tag/README.zh-CN.md index 45583bb1e..88f21eb34 100644 --- a/src/tag/README.zh-CN.md +++ b/src/tag/README.zh-CN.md @@ -124,16 +124,16 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| type | 类型，可选值为`primary` `success` `danger` `warning` | *string* | `default` | - | -| size | 大小, 可选值为`large` `medium` | *string* | - | - | -| color | 标签颜色 | *string* | - | - | -| plain | 是否为空心样式 | *boolean* | `false` | - | -| round | 是否为圆角样式 | *boolean* | `false` | - | -| mark | 是否为标记样式 | *boolean* | `false` | - | -| text-color | 文本颜色，优先级高于`color`属性 | *string* | `white` | - | -| closeable | 是否为可关闭标签 | *boolean* | `false` | 2.2.9 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| type | 类型，可选值为`primary` `success` `danger` `warning` | *string* | `default` | +| size | 大小, 可选值为`large` `medium` | *string* | - | +| color | 标签颜色 | *string* | - | +| plain | 是否为空心样式 | *boolean* | `false` | +| round | 是否为圆角样式 | *boolean* | `false` | +| mark | 是否为标记样式 | *boolean* | `false` | +| text-color | 文本颜色，优先级高于`color`属性 | *string* | `white` | +| closeable `v2.2.9` | 是否为可关闭标签 | *boolean* | `false` | ### Slots diff --git a/src/toast/README.md b/src/toast/README.md index 147d57e9c..2d4887724 100644 --- a/src/toast/README.md +++ b/src/toast/README.md @@ -136,21 +136,21 @@ Toast.resetDefaultOptions('loading'); ### Options -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| type | Can be set to `loading` `success` `fail` `html` | *string* | `text` | - | -| position | Can be set to `top` `middle` `bottom` | *string* | `middle` | - | -| message | Message | *string* | `''` | - | -| icon | Custom icon | *string* | - | 2.0.1 | -| iconPrefix | Icon className prefix | *string* | `van-icon` | 2.0.9 | -| overlay | Whether to show overlay | *boolean* | `false` | 2.2.13 | -| forbidClick | Whether to forbid click background | *boolean* | `false` | - | -| closeOnClick | Whether to close after clicked | *boolean* | `false` | 2.1.5 | -| closeOnClickOverlay | Whether to close when click overlay | *boolean* | `false` | 2.2.13 | -| loadingType | Loading icon type, can be set to `spinner` | *string* | `circular` | - | -| duration | Toast duration(ms), won't disappear if value is 0 | *number* | `2000` | - | -| className | Custom className | *any* | - | - | -| onOpened | Callback function after opened | *Function* | - | - | -| onClose | Callback function after close | *Function* | - | - | -| transition | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | *string* | - | 2.2.6 | -| getContainer | Return the mount node for Toast | *string \| () => Element* | `body` | - | +| Attribute | Description | Type | Default | +|------|------|------|------| +| type | Can be set to `loading` `success` `fail` `html` | *string* | `text` | +| position | Can be set to `top` `middle` `bottom` | *string* | `middle` | +| message | Message | *string* | `''` | +| icon `v2.0.1` | Custom icon | *string* | - | +| iconPrefix `v2.0.9` | Icon className prefix | *string* | `van-icon` | +| overlay `v2.2.13` | Whether to show overlay | *boolean* | `false` | +| forbidClick | Whether to forbid click background | *boolean* | `false` | +| closeOnClick `v2.1.5` | Whether to close after clicked | *boolean* | `false` | +| closeOnClickOverlay `v2.2.13` | Whether to close when click overlay | *boolean* | `false` | +| loadingType | Loading icon type, can be set to `spinner` | *string* | `circular` | +| duration | Toast duration(ms), won't disappear if value is 0 | *number* | `2000` | +| className | Custom className | *any* | - | +| onOpened | Callback function after opened | *Function* | - | +| onClose | Callback function after close | *Function* | - | +| transition `v2.2.6` | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | *string* | - | +| getContainer | Return the mount node for Toast | *string \| () => Element* | `body` | diff --git a/src/toast/README.zh-CN.md b/src/toast/README.zh-CN.md index 4d27cfd56..e27b5af61 100644 --- a/src/toast/README.zh-CN.md +++ b/src/toast/README.zh-CN.md @@ -139,21 +139,21 @@ Toast.resetDefaultOptions('loading'); ### Options -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| type | 提示类型，可选值为 `loading` `success`
`fail` `html` | *string* | `text` | - | -| position | 位置，可选值为 `top` `bottom` | *string* | `middle` | - | -| message | 文本内容，支持通过`\n`换行 | *string* | `''` | - | - | -| icon | 自定义图标，支持传入图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | 2.0.1 | -| iconPrefix | 图标类名前缀 | *string* | `van-icon` | 2.0.9 | -| overlay | 是否显示背景遮罩层 | *boolean* | `false` | 2.2.13 | -| forbidClick | 是否禁止背景点击 | *boolean* | `false` | - | -| closeOnClick | 是否在点击后关闭 | *boolean* | `false` | 2.1.5 | -| closeOnClickOverlay | 是否在点击遮罩层后关闭 | *boolean* | `false` | 2.2.13 | -| loadingType | 加载图标类型, 可选值为 `spinner` | *string* | `circular` | - | -| duration | 展示时长(ms)，值为 0 时，toast 不会消失 | *number* | `2000` | - | -| className | 自定义类名 | *any* | - | - | -| onOpened | 完全展示后的回调函数 | *Function* | - | - | -| onClose | 关闭时的回调函数 | *Function* | - | - | -| transition | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | *string* | - | 2.2.6 | -| getContainer | 指定挂载的节点，可以传入选择器，
或一个返回节点的函数 | *string \| () => Element* | `body` | - | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| type | 提示类型，可选值为 `loading` `success`
`fail` `html` | *string* | `text` | +| position | 位置，可选值为 `top` `bottom` | *string* | `middle` | +| message | 文本内容，支持通过`\n`换行 | *string* | `''` | - | +| icon `v2.0.1` | 自定义图标，支持传入图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | +| iconPrefix `v2.0.9` | 图标类名前缀 | *string* | `van-icon` | +| overlay `v2.2.13` | 是否显示背景遮罩层 | *boolean* | `false` | +| forbidClick | 是否禁止背景点击 | *boolean* | `false` | +| closeOnClick `v2.1.5` | 是否在点击后关闭 | *boolean* | `false` | +| closeOnClickOverlay `v2.2.13` | 是否在点击遮罩层后关闭 | *boolean* | `false` | +| loadingType | 加载图标类型, 可选值为 `spinner` | *string* | `circular` | +| duration | 展示时长(ms)，值为 0 时，toast 不会消失 | *number* | `2000` | +| className | 自定义类名 | *any* | - | +| onOpened | 完全展示后的回调函数 | *Function* | - | +| onClose | 关闭时的回调函数 | *Function* | - | +| transition `v2.2.6` | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | *string* | - | +| getContainer | 指定挂载的节点，可以传入选择器，
或一个返回节点的函数 | *string \| () => Element* | `body` | diff --git a/src/tree-select/README.md b/src/tree-select/README.md index a4a471271..620393276 100644 --- a/src/tree-select/README.md +++ b/src/tree-select/README.md @@ -109,13 +109,13 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| items | Required datasets for the component | *Item[]* | `[]` | - | -| height | Height | *string \| number* | `300` | - | -| main-Active-index | The index of selected parent node | *number* | `0` | - | -| active-id | Id of selected item | *string \| number \| (string \| number)[]* | `0` | - | -| max | Maximum number of selected items | *number* | `Infinity` | 2.2.0 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| items | Required datasets for the component | *Item[]* | `[]` | +| height | Height | *string \| number* | `300` | +| main-Active-index | The index of selected parent node | *number* | `0` | +| active-id | Id of selected item | *string \| number \| (string \| number)[]* | `0` | +| max `v2.2.0` | Maximum number of selected items | *number* | `Infinity` | ### Events diff --git a/src/tree-select/README.zh-CN.md b/src/tree-select/README.zh-CN.md index 4fb894ec9..deccbc639 100644 --- a/src/tree-select/README.zh-CN.md +++ b/src/tree-select/README.zh-CN.md @@ -117,13 +117,13 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| items | 分类显示所需的数据 | *Item[]* | `[]` | - | -| height | 高度，默认单位为`px` | *string \| number* | `300` | - | -| main-active-index | 左侧选中项的索引 | *number* | `0` | - | -| active-id | 右侧选中项的 id，支持传入数组 | *string \| number \| (string \| number)[]* | `0` | - | -| max | 右侧项最大选中个数 | *number* | `Infinity` | 2.2.0 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| items | 分类显示所需的数据 | *Item[]* | `[]` | +| height | 高度，默认单位为`px` | *string \| number* | `300` | +| main-active-index | 左侧选中项的索引 | *number* | `0` | +| active-id | 右侧选中项的 id，支持传入数组 | *string \| number \| (string \| number)[]* | `0` | +| max `v2.2.0` | 右侧项最大选中个数 | *number* | `Infinity` | ### Events diff --git a/src/uploader/README.md b/src/uploader/README.md index e36cab2c7..783a6165f 100644 --- a/src/uploader/README.md +++ b/src/uploader/README.md @@ -109,25 +109,25 @@ export default { ### Props -| Attribute | Description | Type | Default | Version | -|------|------|------|------|------| -| name | Input name | *string \| number* | - | 2.0.3 | -| accept | Accepted file type | *string* | `image/*` | - | -| preview-size | Size of preview image | *string \| number* | `80px` | - | -| preview-image | Whether to show image preview | *boolean* | `true` | 2.1.5 | -| preview-full-image | Whethe to show full screen image preview when click image | *boolean* | `true` | - | -| 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` | 2.2.12 | -| 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* | - | - | -| before-delete | Hook before delete the file, return false to stop reading the file, can return Promise | *Function* | - | - | -| max-size | Max size of file | *number* | - | - | -| max-count | Max count of image | *number* | - | - | -| result-type | Type of file read result, can be set to `file` `text` | *string* | `dataUrl` | 2.2.7 | -| upload-text | Upload text | *string* | - | - | -| image-fit | Preview image fit mode | *string* | `cover` | 2.1.5 | +| Attribute | Description | Type | Default | +|------|------|------|------| +| name `v2.0.3` | Input name | *string \| number* | - | +| accept | Accepted file type | *string* | `image/*` | +| preview-size | Size of preview image | *string \| number* | `80px` | +| preview-image `v2.1.5` | Whether to show image preview | *boolean* | `true` | +| preview-full-image | Whethe to show full screen image preview when click image | *boolean* | `true` | +| multiple | Whether to enable multiple selection pictures | *boolean* | `false` | +| disabled | Whether to disabled the upload | *boolean* | `false` | +| deletable `v2.2.12` | Whether to show delete icon | *boolean* | `true` | +| 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* | - | +| before-delete | Hook before delete the file, return false to stop reading the file, can return Promise | *Function* | - | +| max-size | Max size of file | *number* | - | +| max-count | Max count of image | *number* | - | +| result-type `v2.2.7` | Type of file read result, can be set to `file` `text` | *string* | `dataUrl` | +| upload-text | Upload text | *string* | - | +| image-fit `v2.1.5` | Preview image fit mode | *string* | `cover` | ### Events diff --git a/src/uploader/README.zh-CN.md b/src/uploader/README.zh-CN.md index 142a2831a..8ce4affd6 100644 --- a/src/uploader/README.zh-CN.md +++ b/src/uploader/README.zh-CN.md @@ -125,25 +125,25 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -|------|------|------|------|------| -| name | 标识符，可以在回调函数的第二项参数中获取 | *string \| number* | - | 2.0.3 | -| accept | 接受的文件类型 | *string* | `image/*` | - | -| preview-size | 预览图和上传区域的尺寸，默认单位为`px` | *string \| number* | `80px` | - | -| preview-image | 是否在上传完成后展示预览图 | *boolean* | `true` | - | -| preview-full-image | 是否在点击预览图后展示全屏图片预览 | *boolean* | `true` | 2.1.5 | -| multiple | 是否开启图片多选，部分安卓机型不支持 | *boolean* | `false` | - | -| disabled | 是否禁用文件上传 | *boolean* | `false` | - | -| deletable | 是否展示删除按钮 | *boolean* | `true` | 2.2.12 | -| capture | 图片选取模式，可选值为`camera`(直接调起摄像头) | *string* | - | - | -| after-read | 文件读取完成后的回调函数 | *Function* | - | - | -| before-read | 文件读取前的回调函数，返回`false`可终止文件读取，支持返回`Promise` | *Function* | - | - | -| before-delete | 文件删除前的回调函数，返回`false`可终止文件读取，支持返回`Promise` | *Function* | - | - | -| max-size | 文件大小限制，单位为`byte` | *number* | - | - | -| max-count | 文件上传数量限制 | *number* | - | - | -| result-type | 文件读取结果类型，可选值为`file` `text` | *string* | `dataUrl` | 2.2.7 | -| upload-text | 上传区域文字提示 | *string* | - | - | -| image-fit | 预览图裁剪模式，可选值见 [Image](#/zh-CN/image) 组件 | *string* | `cover` | 2.1.5 | +| 参数 | 说明 | 类型 | 默认值 | +|------|------|------|------| +| name `v2.0.3` | 标识符，可以在回调函数的第二项参数中获取 | *string \| number* | - | +| accept | 接受的文件类型 | *string* | `image/*` | +| preview-size | 预览图和上传区域的尺寸，默认单位为`px` | *string \| number* | `80px` | +| preview-image | 是否在上传完成后展示预览图 | *boolean* | `true` | +| preview-full-image `v2.1.5` | 是否在点击预览图后展示全屏图片预览 | *boolean* | `true` | +| multiple | 是否开启图片多选，部分安卓机型不支持 | *boolean* | `false` | +| disabled | 是否禁用文件上传 | *boolean* | `false` | +| deletable `v2.2.12` | 是否展示删除按钮 | *boolean* | `true` | +| capture | 图片选取模式，可选值为`camera`(直接调起摄像头) | *string* | - | +| after-read | 文件读取完成后的回调函数 | *Function* | - | +| before-read | 文件读取前的回调函数，返回`false`可终止文件读取，支持返回`Promise` | *Function* | - | +| before-delete | 文件删除前的回调函数，返回`false`可终止文件读取，支持返回`Promise` | *Function* | - | +| max-size | 文件大小限制，单位为`byte` | *number* | - | +| max-count | 文件上传数量限制 | *number* | - | +| result-type `v2.2.7` | 文件读取结果类型，可选值为`file` `text` | *string* | `dataUrl` | +| upload-text | 上传区域文字提示 | *string* | - | +| image-fit `v2.1.5` | 预览图裁剪模式，可选值见 [Image](#/zh-CN/image) 组件 | *string* | `cover` | ### Events