blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-05-22 22:49:15 +08:00
Code Issues Projects Releases Wiki Activity

docs: type highlight (#4264)

Browse Source
This commit is contained in:
neverland 2019-08-27 22:09:21 +08:00 committed by GitHub
parent a79750d00c
commit ecbdc2bede
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
129 changed files with 1493 additions and 1484 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
package.json
View File

@ -71,7 +71,7 @@
"@babel/preset-typescript": "^7.3.3",
"@types/jest": "^24.0.16",
"@vant/cli": "^1.0.4",
"@vant/doc": "^2.5.3",
"@vant/doc": "^2.5.5",
"@vant/eslint-config": "^1.2.5",
"@vant/markdown-loader": "^2.2.0",
"@vant/markdown-vetur": "^1.0.0",

2
packages/vant-doc/package.json
View File

@ -1,6 +1,6 @@
{
"name": "@vant/doc",
"version": "2.5.3",
"version": "2.5.5",
"description": "vant document template",
"main": "./lib/index.js",
"publishConfig": {

7
packages/vant-doc/src/component/Content.vue
View File

@ -132,6 +132,13 @@ export default {
font-family: inherit;
word-break: keep-all;
}
em {
color: @van-doc-fuchsia;
font-size: 12px;
font-family: @van-doc-code-font-family;
font-style: normal;
}
}
ul li,

7
packages/vant-doc/src/style/highlight.less
View File

@ -1,5 +1,4 @@
@import './variable';
@import '../../../../src/style/var';
code {
position: relative;
@ -9,7 +8,7 @@ code {
color: @van-doc-code-color;
font-weight: 400;
font-size: 13px;
font-family: 'Source Code Pro', 'Monaco', 'Inconsolata', monospace;
font-family: @van-doc-code-font-family;
line-height: 24px;
white-space: pre-wrap;
word-break: break-all;
@ -36,7 +35,7 @@ pre {
.hljs-template-tag,
.hljs-template-variable,
.hljs-addition {
color: #7232dd;
color: @van-doc-purple;
}
.hljs-comment,
@ -69,7 +68,7 @@ pre {
.hljs-selector-id,
.hljs-selector-class,
.hljs-strong {
color: @blue;
color: @van-doc-blue;
}
.hljs-emphasis {

3
packages/vant-doc/src/style/variable.less
View File

@ -1,5 +1,7 @@
@van-doc-black: #333;
@van-doc-blue: #1989fa;
@van-doc-purple: #5758bb;
@van-doc-fuchsia: #a7419e;
@van-doc-text-color: #34495e;
@van-doc-text-light-blue: rgba(69, 90, 100, .6);
@van-doc-grey: #999;
@ -8,6 +10,7 @@
@van-doc-border-color: #f1f4f8;
@van-doc-code-color: #455a64;
@van-doc-code-background-color: #f1f4f8;
@van-doc-code-font-family: 'Source Code Pro', 'Monaco', 'Inconsolata', monospace;
@van-doc-padding: 30px;
@van-doc-row-max-width: 1680px;
@van-doc-nav-width: 220px;

4
packages/vant-waterfall/README.md
View File

@ -88,7 +88,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-waterfall-lower | 滚动到底部, 触发执行的函数 | `Function` | - | - |
| v-waterfall-upper | 滚动到顶部, 触发执行的函数 | `Function` | - | - |
| v-waterfall-lower | 滚动到底部, 触发执行的函数 | *Function* | - | - |
| v-waterfall-upper | 滚动到顶部, 触发执行的函数 | *Function* | - | - |
| waterfall-disabled | 在 vue 对象中表示是否禁止瀑布流触发的 key 值 | `String` | - | - |
| waterfall-offset | 触发瀑布流加载的阈值 | `Number` | `300` | - |

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

@ -95,18 +95,18 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| actions | Options | `Action[]` | `[]` | - |
| title | Title | `string` | - | - |
| cancel-text | Text of cancel button | `string` | - | - |
| overlay | Whether to show overlay | `boolean` | `true` | - |
| round | Whether to show round corner | `boolean` | `false` | 2.0.9 |
| 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 | () => HTMLElement` | - | - |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation, to enable those features use `viewport-fit=cover` in the `viewport` meta tag | `boolean` | `false` | - |
| actions | Options | *Action[]* | `[]` | - |
| title | Title | *string* | - | - |
| cancel-text | Text of cancel button | *string* | - | - |
| overlay | Whether to show overlay | *boolean* | `true` | - |
| round | Whether to show round corner | *boolean* | `false` | 2.0.9 |
| 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 \| () => HTMLElement* | - | - |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation, to enable those features use `viewport-fit=cover` in the `viewport` meta tag | *boolean* | `false` | - |
### Events
@ -124,9 +124,9 @@ export default {
| Key | Description | Type |
|------|------|------|
| name | Title | `string` |
| subname | Subtitle | `string` |
| color | Text color | `string` |
| className | className for the option | `any` |
| loading | Whether to be loading status | `boolean` |
| disabled | Whether to be disabled | `boolean` |
| name | Title | *string* |
| subname | Subtitle | *string* |
| color | Text color | *string* |
| className | className for the option | *any* |
| loading | Whether to be loading status | *boolean* |
| disabled | Whether to be disabled | *boolean* |

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

@ -109,18 +109,18 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| actions | 菜单选项 | `Action[]` | `[]` | - |
| title | 标题 | `string` | - | - |
| cancel-text | 取消按钮文字 | `string` | - | - |
| overlay | 是否显示遮罩层 | `boolean` | `true` | - |
| round | 是否显示圆角 | `boolean` | `false` | 2.0.9 |
| 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 | 指定挂载的节点，可以传入选择器，<br>或一个返回节点的函数 | `string | () => HTMLElement` | - | - |
| safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `boolean` | `false` | - |
| actions | 菜单选项 | *Action[]* | `[]` | - |
| title | 标题 | *string* | - | - |
| cancel-text | 取消按钮文字 | *string* | - | - |
| overlay | 是否显示遮罩层 | *boolean* | `true` | - |
| round | 是否显示圆角 | *boolean* | `false` | 2.0.9 |
| 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 | 指定挂载的节点，可以传入选择器，<br>或一个返回节点的函数 | *string \| () => HTMLElement* | - | - |
| safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | *boolean* | `false` | - |
### Events
@ -140,9 +140,9 @@ export default {
| 键名 | 说明 | 类型 |
|------|------|------|
| name | 标题 | `string` |
| subname | 二级标题 | `string` |
| color | 选项文字颜色 | `string` |
| className | 为对应列添加额外的 class | `any` |
| loading | 是否为加载状态 | `boolean` |
| disabled | 是否为禁用状态 | `boolean` |
| name | 标题 | *string* |
| subname | 二级标题 | *string* |
| color | 选项文字颜色 | *string* |
| className | 为对应列添加额外的 class | *any* |
| loading | 是否为加载状态 | *boolean* |
| disabled | 是否为禁用状态 | *boolean* |

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

@ -63,22 +63,22 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| area-list | Area List | `object` | - | - |
| 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` | - | - |
| area-list | Area List | *object* | - | - |
| 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* | - | - |
### Events
@ -111,23 +111,23 @@ Use ref to get address-edit instance and call instance methods
| key | Description | Type |
|------|------|------|
| id | Address Id | `string | number` |
| name | Name | `string` |
| tel | Phone | `string` |
| province | Province | `string` |
| city | City | `string` |
| county | County | `string` |
| addressDetail | Detailed Address | `string` |
| areaCode | Area code | `string` |
| postalCode | Postal code | `string` |
| isDefault | Is default address | `boolean` |
| id | Address Id | *string \| number* |
| name | Name | *string* |
| tel | Phone | *string* |
| province | Province | *string* |
| city | City | *string* |
| county | County | *string* |
| addressDetail | Detailed Address | *string* |
| areaCode | Area code | *string* |
| postalCode | Postal code | *string* |
| isDefault | Is default address | *boolean* |
### SearchResult Data Structure
| key | Description | Type |
|------|------|------|
| name | Name | `string` |
| address | Address | `string` |
| name | Name | *string* |
| address | Address | *string* |
### Area Data Structure

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

@ -63,22 +63,22 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| area-list | 地区列表 | `object` | - | - |
| 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` | - | - |
| area-list | 地区列表 | *object* | - | - |
| 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* | - | - |
### Events
@ -113,23 +113,23 @@ export default {
| key | 说明 | 类型 |
|------|------|------|
| id | 每条地址的唯一标识 | `string | number` |
| name | 收货人姓名 | `string` |
| tel | 收货人手机号 | `string` |
| province | 省份 | `string` |
| city | 城市 | `string` |
| county | 区县 | `string` |
| addressDetail | 详细地址 | `string` |
| areaCode | 地区编码，通过`省市区选择`获取（必填） | `string` |
| postalCode | 邮政编码 | `string` |
| isDefault | 是否为默认地址 | `boolean` |
| id | 每条地址的唯一标识 | *string \| number* |
| name | 收货人姓名 | *string* |
| tel | 收货人手机号 | *string* |
| province | 省份 | *string* |
| city | 城市 | *string* |
| county | 区县 | *string* |
| addressDetail | 详细地址 | *string* |
| areaCode | 地区编码，通过`省市区选择`获取（必填） | *string* |
| postalCode | 邮政编码 | *string* |
| isDefault | 是否为默认地址 | *boolean* |
### SearchResult 数据格式
| key | 说明 | 类型 |
|------|------|------|
| name | 地名 | `string` |
| address | 详细地址 | `string` |
| name | 地名 | *string* |
| address | 详细地址 | *string* |
### 省市县列表数据格式

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

@ -71,12 +71,12 @@ export default {
| 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` | - |
| 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` | - |
### Events
@ -93,10 +93,10 @@ export default {
| Key | Description | Type |
|------|------|------|
| id | Id | `string | number` |
| name | Name | `string` |
| tel | Phone | `string | number` |
| address | Address | `string` |
| id | Id | *string \| number* |
| name | Name | *string* |
| tel | Phone | *string \| number* |
| address | Address | *string* |
### Slots

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

@ -72,12 +72,12 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 当前选中地址的 id | `string` | - | - |
| list | 地址列表 | `Address[]` | `[]` | - |
| disabled-list | 不可配送地址列表 | `Address[]` | `[]` | - |
| disabled-text | 不可配送提示文案 | `string` | - | - |
| switchable | 是否允许切换地址 | `boolean` | `true` | - |
| add-button-text | 底部按钮文字 | `string` | `新增地址` | - |
| v-model | 当前选中地址的 id | *string* | - | - |
| list | 地址列表 | *Address[]* | `[]` | - |
| disabled-list | 不可配送地址列表 | *Address[]* | `[]` | - |
| disabled-text | 不可配送提示文案 | *string* | - | - |
| switchable | 是否允许切换地址 | *boolean* | `true` | - |
| add-button-text | 底部按钮文字 | *string* | `新增地址` | - |
### Events
@ -94,10 +94,10 @@ export default {
| 键名 | 说明 | 类型 |
|------|------|------|
| id | 每条地址的唯一标识 | `string | number` |
| name | 收货人姓名 | `string` |
| tel | 收货人手机号 | `string | number` |
| address | 收货地址 | `string` |
| id | 每条地址的唯一标识 | *string \| number* |
| name | 收货人姓名 | *string* |
| tel | 收货人手机号 | *string \| number* |
| address | 收货地址 | *string* |
### Slots

20
src/area/README.md
View File

@ -46,16 +46,16 @@ Set `columns-num` with 2, you'll have a 2 level picker.
| 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` | - |
| 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 |
| value | the `code` of selected area | *string* | - | - |
| title | Toolbar title | *string* | - | - |
| area-list | Area data | *object* | - | - |
| columns-num | level of picker | *string \| number* | `3` | - |
| 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 |
### Events

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

@ -45,16 +45,16 @@ Vue.use(Area);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| value | 当前选中的省市区`code` | `string` | - | - |
| title | 顶部栏标题 | `string` | - | - |
| area-list | 省市区数据，格式见下方 | `object` | - | - |
| columns-num | 显示列数，3-省市区，2-省市，1-省 | `string | number` | `3` | - |
| 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 |
| value | 当前选中的省市区`code` | *string* | - | - |
| title | 顶部栏标题 | *string* | - | - |
| area-list | 省市区数据，格式见下方 | *object* | - | - |
| columns-num | 显示列数，3-省市区，2-省市，1-省 | *string \| number* | `3` | - |
| 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 |
### Events

38
src/button/README.md
View File

@ -94,25 +94,25 @@ Vue.use(Button);
| 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.3 |
| 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` | - |
| 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.3 |
| 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

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

@ -114,26 +114,26 @@ Vue.use(Button);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| type | 类型，可选值为 `primary` `info` `warning` `danger` | `string` | `default` | - |
| size | 尺寸，可选值为 `large` `small` `mini` | `string` | `normal` | - |
| text | 按钮文字 | `string` | - | - |
| color | 按钮颜色，支持传入`linear-gradient`渐变色 | `string` | - | 2.1.3 |
| icon | 左侧图标名称或图片链接，可选值见 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 属性 | `string | object` | - | - |
| replace | 跳转时是否替换当前页面历史 | `boolean` | `false` | - |
| type | 类型，可选值为 `primary` `info` `warning` `danger` | *string* | `default` | - |
| size | 尺寸，可选值为 `large` `small` `mini` | *string* | `normal` | - |
| text | 按钮文字 | *string* | - | - |
| color | 按钮颜色，支持传入`linear-gradient`渐变色 | *string* | - | 2.1.3 |
| icon | 左侧图标名称或图片链接，可选值见 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 属性 | *string \| object* | - | - |
| replace | 跳转时是否替换当前页面历史 | *boolean* | `false` | - |
### Events

22
src/card/README.md
View File

@ -66,17 +66,17 @@ Use slot to custom content.
| 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` | - |
| 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

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

@ -68,17 +68,17 @@ Vue.use(Card);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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

40
src/cell/README.md
View File

@ -100,31 +100,31 @@ Vue.use(Cell).use(CellGroup);
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| title | Group title | `string` | - | - |
| border | Whether to show outer border | `boolean` | `true` | - |
| 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` | - | - |
| 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

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

@ -106,31 +106,31 @@ Vue.use(Cell).use(CellGroup);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| title | 分组标题 | `string` | `-` | - |
| border | 是否显示外边框 | `boolean` | `true` | - |
| title | 分组标题 | *string* | `-` | - |
| border | 是否显示外边框 | *boolean* | `true` | - |
### Cell Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | `string` | - | - |
| title | 左侧标题 | `string | number` | - | - |
| value | 右侧内容 | `string | number` | - | - |
| label | 标题下方的描述信息 | `string` | - | - |
| size | 单元格大小，可选值为 `large` | `string` | - | - |
| url | 跳转链接 | `string` | - | - |
| to | 路由跳转对象，同 vue-router 的 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 组件 | *string* | - | - |
| title | 左侧标题 | *string \| number* | - | - |
| value | 右侧内容 | *string \| number* | - | - |
| label | 标题下方的描述信息 | *string* | - | - |
| size | 单元格大小，可选值为 `large` | *string* | - | - |
| url | 跳转链接 | *string* | - | - |
| to | 路由跳转对象，同 vue-router 的 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

22
src/checkbox/README.md
View File

@ -145,22 +145,22 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| name | Checkbox name | `any` | - | - |
| shape | Can be set to `square` | `string` | `round` | - |
| v-model | Check status | `boolean` | `false` | - |
| disabled | Diable checkbox | `boolean` | `false` | - |
| icon-size | Icon size | `string | number` | `20px` | - |
| label-disabled | Whether to disable label click | `boolean` | `false` | - |
| label-position | Can be set to `left` | `string` | `right` | - |
| checked-color | Checked color | `string` | `#1989fa` | - | - |
| name | Checkbox name | *any* | - | - |
| shape | Can be set to `square` | *string* | `round` | - |
| v-model | Check status | *boolean* | `false` | - |
| disabled | Diable checkbox | *boolean* | `false` | - |
| icon-size | Icon size | *string \| number* | `20px` | - |
| label-disabled | Whether to disable label click | *boolean* | `false` | - |
| label-position | Can be set to `left` | *string* | `right` | - |
| checked-color | Checked color | *string* | `#1989fa` | - | - |
### CheckboxGroup Props
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Names of all checked checkboxes | `any[]` | - | - |
| disabled | Disable all checkboxes | `boolean` | `false` | - |
| max | Maximum amount of checked options | `number` | `0`(Unlimited) | - |
| v-model | Names of all checked checkboxes | *any[]* | - | - |
| disabled | Disable all checkboxes | *boolean* | `false` | - |
| max | Maximum amount of checked options | *number* | `0`(Unlimited) | - |
### Checkbox Events

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

@ -149,22 +149,22 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| name | 标识符 | `any` | - | - |
| shape | 形状，可选值为 `square` | `string` | `round` | - |
| v-model | 是否为选中状态 | `boolean` | `false` | - |
| disabled | 是否禁用复选框 | `boolean` | `false` | - |
| icon-size | 图标大小，默认单位为`px` | `string | number` | `20px` | - |
| label-disabled | 是否禁用复选框文本点击 | `boolean` | `false` | - |
| label-position | 文本位置，可选值为 `left` | `string` | `right` | - |
| checked-color | 选中状态颜色 | `string` | `#1989fa` | - |
| name | 标识符 | *any* | - | - |
| shape | 形状，可选值为 `square` | *string* | `round` | - |
| v-model | 是否为选中状态 | *boolean* | `false` | - |
| disabled | 是否禁用复选框 | *boolean* | `false` | - |
| icon-size | 图标大小，默认单位为`px` | *string \| number* | `20px` | - |
| label-disabled | 是否禁用复选框文本点击 | *boolean* | `false` | - |
| label-position | 文本位置，可选值为 `left` | *string* | `right` | - |
| checked-color | 选中状态颜色 | *string* | `#1989fa` | - |
### CheckboxGroup Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 所有选中项的标识符 | `any[]` | - | - |
| disabled | 是否禁用所有复选框 | `boolean` | `false` | - |
| max | 设置最大可选数，0 为无限制 | `number` | `0` | - |
| v-model | 所有选中项的标识符 | *any[]* | - | - |
| disabled | 是否禁用所有复选框 | *boolean* | `false` | - |
| max | 设置最大可选数，0 为无限制 | *number* | `0` | - |
### Checkbox Events

20
src/circle/README.md
View File

@ -112,16 +112,16 @@ export default {
| 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` | - |
| clockwise | Is clockwise | `boolean` | `true` | - |
| 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` | - |
| clockwise | Is clockwise | *boolean* | `true` | - |
### Slots

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

@ -124,16 +124,16 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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` | - |
| clockwise | 是否顺时针增加 | `boolean` | `true` | - |
| 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` | - |
| clockwise | 是否顺时针增加 | *boolean* | `true` | - |
### Slots

16
src/col/README.md
View File

@ -93,19 +93,19 @@ Setting `type` to `flex` to enable flex layout
| 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` | - |
| 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` | - |
| 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

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

@ -96,19 +96,19 @@ Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| type | 布局方式，可选值为`flex` | `string` | - | - |
| gutter | 列元素之间的间距（单位为px） | `string | number` | - | - |
| tag | 自定义元素标签 | `string` | `div` | - |
| justify | Flex 主轴对齐方式，可选值为 `end` `center` <br> `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` <br> `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

32
src/collapse/README.md
View File

@ -89,32 +89,32 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Names of current active panels | `(string | number)[] `(non-accordion mode)<br>`string | number`(accordion mode) | - | - |
| accordion | Whether to be accordion mode | `boolean` | `false` | - |
| border | Whether to show outer border | `boolean` | `true` | - |
| v-model | Names of current active panels | `(string | number)[] `(non-accordion mode)<br>*string \| number*(accordion mode) | - | - |
| accordion | Whether to be accordion mode | *boolean* | `false` | - |
| border | Whether to show outer border | *boolean* | `true` | - |
### Collapse Events
| Event | Description | Arguments |
|------|------|------|
| change | Triggered when switch panel | activeNames: `(string | number)[] `(non-accordion mode) / `string | number`(accordion mode) |
| change | Triggered when switch panel | activeNames: `(string | number)[] `(non-accordion mode) / *string \| number*(accordion mode) |
### 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` | - | - |
| 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

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

@ -90,32 +90,32 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 当前展开面板的 name | `(string | number)[] `(非手风琴模式)<br>`string | number`(手风琴模式) | - | - |
| accordion | 是否开启手风琴模式 | `boolean` | `false` | - |
| border | 是否显示外边框 | `boolean` | `true` | - |
| v-model | 当前展开面板的 name | `(string | number)[] `(非手风琴模式)<br>*string \| number*(手风琴模式) | - | - |
| accordion | 是否开启手风琴模式 | *boolean* | `false` | - |
| border | 是否显示外边框 | *boolean* | `true` | - |
### Collapse Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| change | 切换面板时触发 | activeNames: `(string | number)[] `(非手风琴模式) / `string | number`(手风琴模式) |
| change | 切换面板时触发 | activeNames: `(string | number)[] `(非手风琴模式) / *string \| number*(手风琴模式) |
### CollapseItem Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| name | 唯一标识符，默认为索引值 | `string | number` | `index` | - |
| icon | 标题栏左侧图标名称或图片链接，可选值见 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 组件 | *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

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

@ -137,10 +137,10 @@ export default {
| 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` | - |
| 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
@ -152,9 +152,9 @@ export default {
| 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` | - |
| v-model | Id of chosen contact | *string \| number* | - | - |
| list | Contact list | *Contact[]* | `[]` | - |
| add-text | Add button text | *string* | `Add new contact` | - |
### ContactList Events
@ -168,11 +168,11 @@ export default {
| 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` | - | - |
| 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* | - | - |
### ContactEdit Events
@ -185,6 +185,6 @@ export default {
| key | Description | Type |
|------|------|------|
| id | ID | `string | number` |
| name | Name | `string` |
| tel | Phone | `string` |
| id | ID | *string \| number* |
| name | Name | *string* |
| tel | Phone | *string* |

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

@ -141,10 +141,10 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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
@ -156,9 +156,9 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 当前选中联系人的 id | `string | number` | - | - |
| list | 联系人列表 | `Contact[]` | `[]` | - |
| add-text | 新建按钮文案 | `string` | `新建联系人` | - |
| v-model | 当前选中联系人的 id | *string \| number* | - | - |
| list | 联系人列表 | *Contact[]* | `[]` | - |
| add-text | 新建按钮文案 | *string* | `新建联系人` | - |
### ContactList Events
@ -172,11 +172,11 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| contact-info | 联系人信息 | `object` | `[]` | - |
| is-edit | 是否为编辑联系人 | `boolean` | `false` | - |
| is-saving | 是否显示保存按钮加载动画 | `boolean` | `false` | - |
| is-deleting | 是否显示删除按钮加载动画 | `boolean` | `false` | - |
| tel-validator | 手机号格式校验函数 | `(tel: string) => boolean` | - | - |
| contact-info | 联系人信息 | *object* | `[]` | - |
| is-edit | 是否为编辑联系人 | *boolean* | `false` | - |
| is-saving | 是否显示保存按钮加载动画 | *boolean* | `false` | - |
| is-deleting | 是否显示删除按钮加载动画 | *boolean* | `false` | - |
| tel-validator | 手机号格式校验函数 | *(tel: string) => boolean* | - | - |
### ContactEdit Events
@ -189,6 +189,6 @@ export default {
| 键名 | 说明 | 类型 |
|------|------|------|
| id | 每位联系人的唯一标识 | `string | number` |
| name | 联系人姓名 | `string` |
| tel | 联系人手机号 | `string | number` |
| id | 每位联系人的唯一标识 | *string \| number* |
| name | 联系人姓名 | *string* |
| tel | 联系人手机号 | *string \| number* |

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

@ -113,10 +113,10 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| time | Total time | `number` | - | - |
| format | Time format，DD-day，HH-hour，mm-minute，ss-second，SSS-millisecond | `string` | `HH:mm:ss` | - |
| auto-start | Whether to auto start count down | `boolean` | `true` | - |
| millisecond | Whether to enable millisecond render | `boolean` | `false` | - |
| time | Total time | *number* | - | - |
| format | Time format，DD-day，HH-hour，mm-minute，ss-second，SSS-millisecond | *string* | `HH:mm:ss` | - |
| auto-start | Whether to auto start count down | *boolean* | `true` | - |
| millisecond | Whether to enable millisecond render | *boolean* | `false` | - |
### Events
@ -134,11 +134,11 @@ export default {
| Name | Description | Type |
|------|------|------|
| days | Remain days | `number` |
| hours | Remain hours | `number` |
| minutes | Remain minutes | `number` |
| seconds | Remain seconds | `number` |
| milliseconds | Remain milliseconds | `number` |
| days | Remain days | *number* |
| hours | Remain hours | *number* |
| minutes | Remain minutes | *number* |
| seconds | Remain seconds | *number* |
| milliseconds | Remain milliseconds | *number* |
### Methods

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

@ -123,10 +123,10 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| time | 倒计时时长，单位毫秒 | `number` | - | - |
| format | 时间格式，DD-日，HH-时，mm-分，ss-秒，SSS-毫秒 | `string` | `HH:mm:ss` | - |
| auto-start | 是否自动开始倒计时 | `boolean` | `true` | - |
| millisecond | 是否开启毫秒级渲染 | `boolean` | `false` | - |
| time | 倒计时时长，单位毫秒 | *number* | - | - |
| format | 时间格式，DD-日，HH-时，mm-分，ss-秒，SSS-毫秒 | *string* | `HH:mm:ss` | - |
| auto-start | 是否自动开始倒计时 | *boolean* | `true` | - |
| millisecond | 是否开启毫秒级渲染 | *boolean* | `false` | - |
### Events
@ -144,11 +144,11 @@ export default {
| 名称 | 说明 | 类型 |
|------|------|------|
| days | 剩余天数 | `number` |
| hours | 剩余小时 | `number` |
| minutes | 剩余分钟 | `number` |
| seconds | 剩余秒数 | `number` |
| milliseconds | 剩余毫秒 | `number` |
| days | 剩余天数 | *number* |
| hours | 剩余小时 | *number* |
| minutes | 剩余分钟 | *number* |
| seconds | 剩余秒数 | *number* |
| milliseconds | 剩余毫秒 | *number* |
### 方法

62
src/coupon-list/README.md
View File

@ -73,32 +73,32 @@ export default {
| 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` | `¥` | - |
| 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` | - |
| 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` | - |
### CouponList Events
@ -111,13 +111,13 @@ export default {
| Key | Description | Type |
|------|------|------|
| id | Id | `string` |
| name | Name | `string` |
| condition | Condition | `string` |
| startAt | Start time (Timestmap, unit second) | `number` |
| endAt | End time (Timestmap, unit second) | `number` |
| description | Description | `string` |
| reason | Unavailable reason | `string` |
| value | Value | `number` |
| valueDesc | Value Text | `string` |
| unitDesc | Unit Text | `string` |
| id | Id | *string* |
| name | Name | *string* |
| condition | Condition | *string* |
| startAt | Start time (Timestmap, unit second) | *number* |
| endAt | End time (Timestmap, unit second) | *number* |
| description | Description | *string* |
| reason | Unavailable reason | *string* |
| value | Value | *number* |
| valueDesc | Value Text | *string* |
| unitDesc | Unit Text | *string* |

66
src/coupon-list/README.zh-CN.md
View File

@ -73,34 +73,34 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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 |
| 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 |
### CouponList Events
@ -113,13 +113,13 @@ export default {
| 键名 | 说明 | 类型 |
|------|------|------|
| id | 优惠券 id | `string` |
| name | 优惠券名称 | `string` |
| condition | 满减条件 | `string` |
| startAt | 卡有效开始时间 (时间戳, 单位秒) | `number` |
| endAt | 卡失效日期 (时间戳, 单位秒) | `number` |
| description | 描述信息，优惠券可用时展示 | `string` |
| reason | 不可用原因，优惠券不可用时展示 | `string` |
| value | 折扣券优惠金额，单位分 | `number` |
| valueDesc | 折扣券优惠金额文案 | `string` |
| unitDesc | 单位文案 | `string` |
| id | 优惠券 id | *string* |
| name | 优惠券名称 | *string* |
| condition | 满减条件 | *string* |
| startAt | 卡有效开始时间 (时间戳, 单位秒) | *number* |
| endAt | 卡失效日期 (时间戳, 单位秒) | *number* |
| description | 描述信息，优惠券可用时展示 | *string* |
| reason | 不可用原因，优惠券不可用时展示 | *string* |
| value | 折扣券优惠金额，单位分 | *number* |
| valueDesc | 折扣券优惠金额文案 | *string* |
| unitDesc | 单位文案 | *string* |

30
src/datetime-picker/README.md
View File

@ -149,21 +149,21 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| type | Can be set to `date` `time`<br> `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` | `''` | - |
| 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` | - |
| type | Can be set to `date` `time`<br> `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* | `''` | - |
| 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` | - |
### Events

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

@ -153,22 +153,22 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| type | 类型，可选值为 `date` <br> `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` | `false` | - |
| loading | 是否显示加载状态 | `boolean` | `false` | - |
| item-height | 选项高度 | `number` | `44` | - |
| confirm-button-text | 确认按钮文字 | `string` | `确认` | - |
| cancel-button-text | 取消按钮文字 | `string` | `取消` | - |
| visible-item-count | 可见的选项个数 | `number` | `5` | - |
| type | 类型，可选值为 `date` <br> `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* | `false` | - |
| loading | 是否显示加载状态 | *boolean* | `false` | - |
| item-height | 选项高度 | *number* | `44` | - |
| confirm-button-text | 确认按钮文字 | *string* | `确认` | - |
| cancel-button-text | 取消按钮文字 | *string* | `取消` | - |
| visible-item-count | 可见的选项个数 | *number* | `5` | - |
### Events

60
src/dialog/README.md
View File

@ -118,43 +118,43 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| title | Title | `string` | - | - |
| 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` | - |
| 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` | - |
| title | Title | *string* | - | - |
| 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` | - |
| 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,<br>call done() to close dialog,<br>call done(false) to cancel loading | (action: string, done: Function) => void | - | - |
| getContainer | Return the mount node for Dialog | `string | () => HTMLElement` | `body` | - |
| getContainer | Return the mount node for Dialog | *string \| () => HTMLElement* | `body` | - |
### Props
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Whether to show dialog | `boolean` | - | - |
| title | Title | `string` | - | - |
| 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` | - |
| 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` | - |
| lock-scroll | Whether to lock background scroll | `boolean` | `true` | - |
| v-model | Whether to show dialog | *boolean* | - | - |
| title | Title | *string* | - | - |
| 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` | - |
| 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` | - |
| lock-scroll | Whether to lock background scroll | *boolean* | `true` | - |
| before-close | Callback before close,<br>call done() to close dialog,<br>call done(false) to cancel loading | (action: string, done: Function) => void | - | - |
| get-container | Return the mount node for Dialog | `string | () => HTMLElement` | - | - |
| get-container | Return the mount node for Dialog | *string \| () => HTMLElement* | - | - |
### Events

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

@ -147,22 +147,22 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| title | 标题 | `string` | - | - |
| message | 文本内容，支持通过`\n`换行 | `string` | - | - |
| messageAlign | 内容对齐方式，可选值为`left` `right` | `string` | `center` | - |
| className | 自定义类名 | `any` | - | - |
| showConfirmButton | 是否展示确认按钮 | `boolean` | `true` | - |
| showCancelButton | 是否展示取消按钮 | `boolean` | `false` | - |
| cancelButtonText | 取消按钮文案 | `string` | `取消` | - |
| cancelButtonColor | 取消按钮颜色 | `string` | `#000` | - |
| confirmButtonText | 确认按钮文案 | `string` | `确认` | - |
| confirmButtonColor | 确认按钮颜色 | `string` | `#1989fa` | - |
| overlay | 是否展示遮罩层 | `boolean` | `true` | - |
| closeOnPopstate | 是否在页面回退时自动关闭 | `boolean` | `false` | 2.0.5 |
| closeOnClickOverlay | 点击遮罩层时是否关闭弹窗 | `boolean` | `false` | - |
| lockScroll | 是否锁定背景滚动 | `boolean` | `true` | - |
| beforeClose | 关闭前的回调函数，<br>调用 done() 后关闭弹窗，<br>调用 done(false) 阻止弹窗关闭 | `(action, done) => void` | - | - |
| getContainer | 指定挂载的节点，可以传入选择器，<br>或一个返回节点的函数 | `string | () => HTMLElement` | `body` | - |
| title | 标题 | *string* | - | - |
| message | 文本内容，支持通过`\n`换行 | *string* | - | - |
| messageAlign | 内容对齐方式，可选值为`left` `right` | *string* | `center` | - |
| className | 自定义类名 | *any* | - | - |
| showConfirmButton | 是否展示确认按钮 | *boolean* | `true` | - |
| showCancelButton | 是否展示取消按钮 | *boolean* | `false` | - |
| cancelButtonText | 取消按钮文案 | *string* | `取消` | - |
| cancelButtonColor | 取消按钮颜色 | *string* | `#000` | - |
| confirmButtonText | 确认按钮文案 | *string* | `确认` | - |
| confirmButtonColor | 确认按钮颜色 | *string* | `#1989fa` | - |
| overlay | 是否展示遮罩层 | *boolean* | `true` | - |
| closeOnPopstate | 是否在页面回退时自动关闭 | *boolean* | `false` | 2.0.5 |
| closeOnClickOverlay | 点击遮罩层时是否关闭弹窗 | *boolean* | `false` | - |
| lockScroll | 是否锁定背景滚动 | *boolean* | `true` | - |
| beforeClose | 关闭前的回调函数，<br>调用 done() 后关闭弹窗，<br>调用 done(false) 阻止弹窗关闭 | *(action, done) => void* | - | - |
| getContainer | 指定挂载的节点，可以传入选择器，<br>或一个返回节点的函数 | *string \| () => HTMLElement* | `body` | - |
### Props
@ -170,22 +170,22 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 是否显示弹窗 | `boolean` | - | - |
| title | 标题 | `string` | - | - |
| message | 内容 | `string` | - | - |
| message-align | 内容对齐方式，可选值为`left` `right` | `string` | `center` | - |
| show-confirm-button | 是否展示确认按钮 | `boolean` | `true` | - |
| show-cancel-button | 是否展示取消按钮 | `boolean` | `false` | - |
| cancel-button-text | 取消按钮文案 | `string` | `取消` | - |
| cancel-button-color | 取消按钮颜色 | `string` | `#000` | - |
| confirm-button-text | 确认按钮文案 | `string` | `确认` | - |
| confirm-button-color | 确认按钮颜色 | `string` | `#1989fa` | - |
| overlay | 是否展示遮罩层 | `boolean` | `true` | - |
| close-on-popstate | 是否在页面回退时自动关闭 | `boolean` | `false` | 2.0.5 |
| close-on-click-overlay | 是否在点击遮罩层后关闭 | `boolean` | `false` | - |
| lock-scroll | 是否锁定背景滚动 | `boolean` | `true` | - |
| before-close | 关闭前的回调函数，<br>调用 done() 后关闭弹窗，<br>调用 done(false) 阻止弹窗关闭 | `(action, done) => void` | - | - |
| get-container | 指定挂载的节点，可以传入选择器，<br>或一个返回节点的函数 | `string | () => HTMLElement` | - | - |
| v-model | 是否显示弹窗 | *boolean* | - | - |
| title | 标题 | *string* | - | - |
| message | 内容 | *string* | - | - |
| message-align | 内容对齐方式，可选值为`left` `right` | *string* | `center` | - |
| show-confirm-button | 是否展示确认按钮 | *boolean* | `true` | - |
| show-cancel-button | 是否展示取消按钮 | *boolean* | `false` | - |
| cancel-button-text | 取消按钮文案 | *string* | `取消` | - |
| cancel-button-color | 取消按钮颜色 | *string* | `#000` | - |
| confirm-button-text | 确认按钮文案 | *string* | `确认` | - |
| confirm-button-color | 确认按钮颜色 | *string* | `#1989fa` | - |
| overlay | 是否展示遮罩层 | *boolean* | `true` | - |
| close-on-popstate | 是否在页面回退时自动关闭 | *boolean* | `false` | 2.0.5 |
| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `false` | - |
| lock-scroll | 是否锁定背景滚动 | *boolean* | `true` | - |
| before-close | 关闭前的回调函数，<br>调用 done() 后关闭弹窗，<br>调用 done(false) 阻止弹窗关闭 | *(action, done) => void* | - | - |
| get-container | 指定挂载的节点，可以传入选择器，<br>或一个返回节点的函数 | *string \| () => HTMLElement* | - | - |
### Events

6
src/divider/README.md
View File

@ -50,9 +50,9 @@ Vue.use(Divider);
| 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` | - |
| 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

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

@ -60,9 +60,9 @@ Vue.use(Divider);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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

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

@ -101,23 +101,23 @@ export default {
| 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 |
| 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 |
### 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` | - | - |
| 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* | - | - |
### DropdownItem Events
@ -140,6 +140,6 @@ Use ref to get DropdownItem instance and call instance methods
| Key | Description | Type |
|------|------|------|
| text | Text | `string` |
| value | Value | `string | number` |
| icon | Left icon | `string` |
| text | Text | *string* |
| value | Value | *string \| number* |
| icon | Left icon | *string* |

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

@ -105,23 +105,23 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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 | 菜单展开方向，可选值为`up` | *string* | `down` | 2.0.1 |
| overlay | 是否显示遮罩层 | *boolean* | `true` | - |
| close-on-click-overlay | 是否在点击遮罩层后关闭菜单 | *boolean* | `true` | - |
| close-on-click-outside | 是否在点击外部元素后关闭菜单 | *boolean* | `true` | 2.0.7 |
### DropdownItem Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| value | 当前选中项对应的 value，可以通过`v-model`双向绑定 | `string | number` | - | - |
| title | 菜单项标题 | `string` | 当前选中项文字 | - |
| options | 选项数组 | `Option[]` | `[]` | - |
| disabled | 是否禁用菜单 | `boolean` | `false` | - |
| title-class | 标题额外类名 | `string` | - | - |
| value | 当前选中项对应的 value，可以通过`v-model`双向绑定 | *string \| number* | - | - |
| title | 菜单项标题 | *string* | 当前选中项文字 | - |
| options | 选项数组 | *Option[]* | `[]` | - |
| disabled | 是否禁用菜单 | *boolean* | `false` | - |
| title-class | 标题额外类名 | *string* | - | - |
### DropdownItem Events
@ -144,6 +144,6 @@ export default {
| 键名 | 说明 | 类型 |
|------|------|------|
| text | 文字 | `string` |
| value | 标识符 | `string | number` |
| icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | `string` |
| text | 文字 | *string* |
| value | 标识符 | *string \| number* |
| icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* |

48
src/field/README.md
View File

@ -122,30 +122,30 @@ Use button slot to insert button
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| value | Field value | `string | number` | - | - |
| label | Field label | `string` | - | - |
| type | Input type, can be set to `tel` `number`<br>`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` | - |
| error | Whether to show error info | `boolean` | `false` | - |
| 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,<br>e.g. { maxHeight: 100, minHeight: 50 } | `boolean | object` | `false` | - |
| left-icon | Left side icon name | `string` | - | - |
| right-icon | Right side icon name | `string` | - | - |
| value | Field value | *string \| number* | - | - |
| label | Field label | *string* | - | - |
| type | Input type, can be set to `tel` *number*<br>`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` | - |
| error | Whether to show error info | *boolean* | `false` | - |
| 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,<br>e.g. { maxHeight: 100, minHeight: 50 } | *boolean \| object* | `false` | - |
| left-icon | Left side icon name | *string* | - | - |
| right-icon | Right side icon name | *string* | - | - |
### Events

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

@ -126,30 +126,30 @@ Vue.use(Field);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| label | 输入框左侧文本 | `string` | - | - |
| value | 当前输入的值 | `string | number` | - | - |
| type | 输入框类型, 可选值为 `tel` `number`<br>`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` | - |
| error | 是否将输入内容标红 | `boolean` | `false` | - |
| 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 有效，可传入对象,<br>如 { maxHeight: 100, minHeight: 50 }，单位为 px | `boolean | object` | `false` | - |
| left-icon | 输入框左侧图标名称或图片链接，可选值见 Icon 组件 | `string` | - | - |
| right-icon | 输入框尾部图标名称或图片链接，可选值见 Icon 组件 | `string` | - | - |
| label | 输入框左侧文本 | *string* | - | - |
| value | 当前输入的值 | *string \| number* | - | - |
| type | 输入框类型, 可选值为 `tel` *number*<br>`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` | - |
| error | 是否将输入内容标红 | *boolean* | `false` | - |
| 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 有效，可传入对象,<br>如 { maxHeight: 100, minHeight: 50 }，单位为 px | *boolean \| object* | `false` | - |
| left-icon | 输入框左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| right-icon | 输入框尾部图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
### Events

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

@ -73,33 +73,33 @@ Use `info` prop to show messages in upper right corner of icon
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation, to enable those features use `viewport-fit=cover` in the `viewport` meta tag | `boolean` | `false` | - |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation, to enable those features use `viewport-fit=cover` in the `viewport` meta tag | *boolean* | `false` | - |
### GoodsActionIcon Props
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| text | Button text | `string` | - | - |
| icon | Icon | `string` | - | - |
| icon-class | Icon class name | `any` | `''` | - |
| info | Info message | `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` | - |
| text | Button text | *string* | - | - |
| icon | Icon | *string* | - | - |
| icon-class | Icon class name | *any* | `''` | - |
| info | Info message | *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` | - |
| 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` | - |
### GoodsActionIcon Slots

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

@ -75,32 +75,32 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `boolean` | `false` | - |
| safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | *boolean* | `false` | - |
### GoodsActionIcon Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| text | 按钮文字 | `string` | - | - |
| icon | 图标 | `string` | - | - |
| icon-class | 图标额外类名 | `any` | - | - |
| info | 图标右上角提示信息 | `string | number` | - | - |
| url | 跳转链接 | `string` | - | - |
| to | 路由跳转对象，同 vue-router 的 to 属性 | `string | object` | - | - |
| replace | 跳转时是否替换当前页面历史 | `boolean` | `false` | - |
| text | 按钮文字 | *string* | - | - |
| icon | 图标 | *string* | - | - |
| icon-class | 图标额外类名 | *any* | - | - |
| info | 图标右上角提示信息 | *string \| number* | - | - |
| url | 跳转链接 | *string* | - | - |
| to | 路由跳转对象，同 vue-router 的 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 属性 | `string | object` | - | - |
| replace | 跳转时是否替换当前页面历史 | `boolean` | `false` | - |
| 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 属性 | *string \| object* | - | - |
| replace | 跳转时是否替换当前页面历史 | *boolean* | `false` | - |
### GoodsActionIcon Slots

22
src/grid/README.md
View File

@ -102,22 +102,22 @@ Vue.use(Grid).use(GridItem);
| 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` | - |
| 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` | - |
### GridItem Props
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| text | Text | `string` | - | - |
| icon | Icon name or URL | `string` | - | - |
| url | Link URL | `string` | - | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - | - |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` | - |
| text | Text | *string* | - | - |
| icon | Icon name or URL | *string* | - | - |
| url | Link URL | *string* | - | - |
| to | Target route of the link, same as to of vue-router | *string \| object* | - | - |
| replace | If true, the navigation will not leave a history record | *boolean* | `false` | - |
### GridItem Events

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

@ -118,22 +118,22 @@ Vue.use(Grid).use(GridItem);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| column-num | 列数 | `number` | `4` | 2.0.4 |
| gutter | 格子之间的间距，默认单位为`px` | `string | number` | `0` | - |
| border | 是否显示边框 | `boolean` | `true` | - |
| center | 是否将格子内容居中显示 | `boolean` | `true` | - |
| square | 是否将格子固定为正方形 | `boolean` | `false` | - |
| clickable | 是否开启格子点击反馈 | `boolean` | `false` | - |
| column-num | 列数 | *number* | `4` | 2.0.4 |
| gutter | 格子之间的间距，默认单位为`px` | *string \| number* | `0` | - |
| border | 是否显示边框 | *boolean* | `true` | - |
| center | 是否将格子内容居中显示 | *boolean* | `true` | - |
| square | 是否将格子固定为正方形 | *boolean* | `false` | - |
| clickable | 是否开启格子点击反馈 | *boolean* | `false` | - |
### GridItem Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| text | 文字 | `string` | - | - |
| icon | 图标名称或图片链接，可选值见 Icon 组件 | `string` | - | - |
| url | 跳转链接 | `string` | - | - |
| to | 路由跳转对象，同 vue-router 的 to 属性 | `string | object` | - | - |
| replace | 跳转时是否替换当前页面历史 | `boolean` | `false` | - |
| text | 文字 | *string* | - | - |
| icon | 图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| url | 跳转链接 | *string* | - | - |
| to | 路由跳转对象，同 vue-router 的 to 属性 | *string \| object* | - | - |
| replace | 跳转时是否替换当前页面历史 | *boolean* | `false` | - |
### GridItem Events

12
src/icon/README.md
View File

@ -62,12 +62,12 @@ import 'vant/lib/icon/local.css';
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| name | Icon name or URL | `string` | `''` | - |
| info | Info message | `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` | - |
| name | Icon name or URL | *string* | `''` | - |
| info | Info message | *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

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

@ -64,12 +64,12 @@ import 'vant/lib/icon/local.css';
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| name | 图标名称或图片链接 | `string` | - | - |
| info | 图标右上角文字提示 | `string | number` | - | - |
| color | 图标颜色 | `string` | `inherit` | - |
| size | 图标大小，如 `20px` `2em`，默认单位为`px` | `string | number` | `inherit` | - |
| class-prefix | 类名前缀 | `string` | `van-icon` | - |
| tag | HTML 标签 | `string` | `i` | - |
| name | 图标名称或图片链接 | *string* | - | - |
| info | 图标右上角文字提示 | *string \| number* | - | - |
| color | 图标颜色 | *string* | `inherit` | - |
| size | 图标大小，如 `20px` `2em`，默认单位为`px` | *string \| number* | `inherit` | - |
| class-prefix | 类名前缀 | *string* | `van-icon` | - |
| tag | HTML 标签 | *string* | `i` | - |
### Events

56
src/image-preview/README.md
View File

@ -90,37 +90,37 @@ export default {
| 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` | - |
| 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` | - |
### 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` | - |
| 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
@ -139,5 +139,5 @@ export default {
| Attribute | Description | Type |
|------|------|------|
| url | Url of current image | `number` |
| index | Index of current image | `string` |
| url | Url of current image | *number* |
| index | Index of current image | *string* |

56
src/image-preview/README.zh-CN.md
View File

@ -102,20 +102,20 @@ export default {
| 参数名 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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 | 切换图片时的回调函数，回调参数为当前索引 | *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` | - |
### Props
@ -123,18 +123,18 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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
@ -157,5 +157,5 @@ export default {
| 参数名 | 说明 | 类型 |
|------|------|------|
| url | 当前图片 URL | `string` |
| index | 当前图片的索引值 | `number` |
| url | 当前图片 URL | *string* |
| index | 当前图片的索引值 | *number* |

20
src/image/README.md
View File

@ -68,16 +68,16 @@ Vue.use(Lazyload);
| 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 |
| 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 |
### fit optional value

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

@ -94,16 +94,16 @@ Vue.use(Image);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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 |
| 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 |
### 图片填充模式

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

@ -63,17 +63,17 @@ export default {
| 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` | - | - |
| 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` | - | - |
### IndexAnchor Props
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| index | Index | `string | number` | - | - |
| index | Index | *string \| number* | - | - |
### IndexBar Events

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

@ -67,17 +67,17 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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 | 锚点自动吸顶时与顶部的距离 | *number* | `0` | 2.0.7 |
| highlight-color | 索引字符高亮颜色 | *string* | `#07c160` | - |
### IndexAnchor Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| index | 索引字符 | `string | number` | - | - |
| index | 索引字符 | *string \| number* | - | - |
### IndexBar Events

16
src/lazyload/README.md
View File

@ -52,13 +52,13 @@ Use `v-lazy:background-image` to set background url, and declare the height of t
| 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` | - |
| 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)

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

@ -59,13 +59,13 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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)

18
src/list/README.md
View File

@ -102,15 +102,15 @@ export default {
| 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` | - |
| 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

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

@ -138,15 +138,15 @@ List 初始化后会触发一次 load 事件，用于加载第一屏的数据，
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 是否处于加载状态，加载过程中不触发`load`事件 | `boolean` | `false` | - |
| finished | 是否已加载完成，加载完成后不再触发`load`事件 | `boolean` | `false` | - |
| error | 是否加载失败，加载失败后点击错误提示可以重新<br>触发`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 | 是否加载失败，加载失败后点击错误提示可以重新<br>触发`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

10
src/loading/README.md
View File

@ -43,11 +43,11 @@ Vue.use(Loading);
| 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` | - |
| 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

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

@ -43,11 +43,11 @@ Vue.use(Loading);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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

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

@ -51,13 +51,13 @@ export default {
| 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` | - |
| 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

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

@ -53,13 +53,13 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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

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

@ -66,15 +66,15 @@ Vue.use(NoticeBar);
| 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` | - |
| 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

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

@ -74,15 +74,15 @@ Vue.use(NoticeBar);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| mode | 通知栏模式，可选值为 `closeable` `link` | `string` | `''` | - |
| text | 通知文本内容 | `string` | `''` | - |
| delay | 动画延迟时间 (s) | `number` | `1` | - |
| speed | 滚动速率 (px/s) | `number` | `50` | - |
| scrollable | 是否在长度溢出时滚动播放 | `boolean` | `true` | - |
| wrapable | 是否开启文本换行，只在禁用滚动时生效 | `boolean` | `false` | - |
| left-icon | 左侧图标名称或图片链接，可选值见 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 组件 | *string* | - | - |
| color | 文本颜色 | *string* | `#f60` | - |
| background | 滚动条背景 | *string* | `#fff7cc` | - |
### Events

18
src/notify/README.md
View File

@ -68,12 +68,12 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| type | Can be set to `primary` `info` `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` | `#f44` | - |
| className | Custom className | `any` | - | - |
| onClick | Callback function after click | `Function` | - | - |
| onOpened | Callback function after opened | `Function` | - | - |
| onClose | Callback function after close | `Function` | - | - |
| type | Can be set to `primary` `info` `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* | `#f44` | - |
| className | Custom className | *any* | - | - |
| onClick | Callback function after click | *Function* | - | - |
| onOpened | Callback function after opened | *Function* | - | - |
| onClose | Callback function after close | *Function* | - | - |

18
src/notify/README.zh-CN.md
View File

@ -79,12 +79,12 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| type | 类型，可选值为 `primary` `info` `warning` | `string` | `danger` | 2.1.6 |
| message | 展示文案，支持通过`\n`换行 | `string` | - | - |
| duration | 展示时长(ms)，值为 0 时，notify 不会消失 | `number` | `3000` | - |
| color | 字体颜色 | `string` | `#fff` | - |
| background | 背景颜色 | `string` | `#f44` | - |
| className | 自定义类名 | `any` | - | - |
| onClick | 点击时的回调函数 | `Function` | - | - |
| onOpened | 完全展示后的回调函数 | `Function` | - | - |
| onClose | 关闭时的回调函数 | `Function` | - | - |
| type | 类型，可选值为 `primary` `info` `warning` | *string* | `danger` | 2.1.6 |
| message | 展示文案，支持通过`\n`换行 | *string* | - | - |
| duration | 展示时长(ms)，值为 0 时，notify 不会消失 | *number* | `3000` | - |
| color | 字体颜色 | *string* | `#fff` | - |
| background | 背景颜色 | *string* | `#f44` | - |
| className | 自定义类名 | *any* | - | - |
| onClick | 点击时的回调函数 | *Function* | - | - |
| onOpened | 完全展示后的回调函数 | *Function* | - | - |
| onClose | 关闭时的回调函数 | *Function* | - | - |

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

@ -96,19 +96,19 @@ export default {
| 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 | `number | string` | - | 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, to enable those features use `viewport-fit=cover` in the `viewport` meta tag | `boolean` | `false` | - |
| 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, to enable those features use `viewport-fit=cover` in the `viewport` meta tag | *boolean* | `false` | - |
### Events

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

@ -98,19 +98,19 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 当前输入值 | `string` | - | 2.0.2 |
| show | 是否显示键盘 | `boolean` | - | - |
| theme | 样式风格，可选值为 `default` `custom` | `string` | `default` | - |
| title | 键盘标题 | `string` | - | - |
| maxlength | 输入值最大长度 | `number | string` | - | 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 | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `boolean` | `false` | - |
| 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 | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | *boolean* | `false` | - |
### Events

8
src/overlay/README.md
View File

@ -42,10 +42,10 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| show | Whether to show overlay | `boolean` | `false` | - |
| z-index | z-index | `number | string` | `1` | - |
| duration | Animation duration | `number | string` | `0.3` | - |
| class-name | ClassName | `string` | - | - |
| 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* | - | - |
### Events

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

@ -46,10 +46,10 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| show | 是否展示遮罩层 | `boolean` | `false` | - |
| z-index | z-index 层级 | `number | string` | `1` | - |
| duration | 动画时长，单位秒 | `number | string` | `0.3` | - |
| class-name | 自定义类名 | `string` | - | - |
| show | 是否展示遮罩层 | *boolean* | `false` | - |
| z-index | z-index 层级 | *string \| number* | `1` | - |
| duration | 动画时长，单位秒 | *string \| number* | `0.3` | - |
| class-name | 自定义类名 | *string* | - | - |
### Events

18
src/pagination/README.md
View File

@ -58,15 +58,15 @@ export default {
| 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` | - |
| 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

18
src/pagination/README.zh-CN.md
View File

@ -59,15 +59,15 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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

8
src/panel/README.md
View File

@ -37,10 +37,10 @@ Vue.use(Panel);
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| icon | Left Icon | `string` | - | - |
| title | Title | `string` | - | - |
| desc | Description | `string` | - | - |
| status | Status | `string` | - | - |
| icon | Left Icon | *string* | - | - |
| title | Title | *string* | - | - |
| desc | Description | *string* | - | - |
| status | Status | *string* | - | - |
### Slots

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

@ -41,10 +41,10 @@ Vue.use(Panel);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| title | 标题 | `string` | - | - |
| desc | 描述 | `string` | - | - |
| status | 状态 | `string` | - | - |
| icon | 标题左侧图标名称或图片链接，可选值见 Icon 组件 | `string` | - | - |
| title | 标题 | *string* | - | - |
| desc | 描述 | *string* | - | - |
| status | 状态 | *string* | - | - |
| icon | 标题左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
### Slots

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

@ -81,12 +81,12 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| value | Password value | `string` | `''` | - |
| length | Maxlength of password | `number` | `6` | - |
| mask | Whether to mask value | `boolean` | `true` | - |
| info | Bottom info | `string` | - | - |
| error-info | Bottom error info | `string` | - | - |
| gutter | Gutter of input | `number | string` | `0` | - |
| value | Password value | *string* | `''` | - |
| length | Maxlength of password | *number* | `6` | - |
| mask | Whether to mask value | *boolean* | `true` | - |
| info | Bottom info | *string* | - | - |
| error-info | Bottom error info | *string* | - | - |
| gutter | Gutter of input | *string \| number* | `0` | - |
### Events

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

@ -79,12 +79,12 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| value | 密码值 | `string` | `''` | - |
| length | 密码最大长度 | `number` | `6` | - |
| mask | 是否隐藏密码内容 | `boolean` | `true` | - |
| info | 输入框下方文字提示 | `string` | - | - |
| error-info | 输入框下方错误提示 | `string` | - | - |
| gutter | 输入框格子之间的间距，如 `20px` `2em`，默认单位为`px` | `number | string` | `0` | - |
| value | 密码值 | *string* | `''` | - |
| length | 密码最大长度 | *number* | `6` | - |
| mask | 是否隐藏密码内容 | *boolean* | `true` | - |
| info | 输入框下方文字提示 | *string* | - | - |
| error-info | 输入框下方错误提示 | *string* | - | - |
| gutter | 输入框格子之间的间距，如 `20px` `2em`，默认单位为`px` | *string \| number* | `0` | - |
### Events

28
src/picker/README.md
View File

@ -186,17 +186,17 @@ When Picker columns data is acquired asynchronously, use `loading` prop to show
| 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` | - |
| default-index | Default value index of single column picker | `number` | `0` | - |
| 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` | - |
| default-index | Default value index of single column picker | *number* | `0` | - |
### Events
@ -218,9 +218,9 @@ Picker events will pass different parameters according to the columns are single
| Key | Description | Type |
|------|------|------|
| values | Value of column | `string[]` |
| defaultIndex | Default value index | `number` |
| className | ClassName for this column | `any` |
| values | Value of column | *string[]* |
| defaultIndex | Default value index | *number* |
| className | ClassName for this column | *any* |
### Methods

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

@ -194,17 +194,17 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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` | - |
| default-index | 单列选择器的默认选中项索引，<br>多列选择器请参考下方的 Columns 配置 | `number` | `0` | - |
| 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` | - |
| default-index | 单列选择器的默认选中项索引，<br>多列选择器请参考下方的 Columns 配置 | *number* | `0` | - |
### Events
@ -228,9 +228,9 @@ Picker 组件的事件会根据 columns 是单列或多列返回不同的参数
| 键名 | 说明 | 类型 |
|------|------|------|
| values | 列中对应的备选值 | `string[]`
| defaultIndex | 初始选中项的索引，默认为 0 | `number` |
| className | 为对应列添加额外的类名 | `any` |
| values | 列中对应的备选值 | *string[]*
| defaultIndex | 初始选中项的索引，默认为 0 | *number* |
| className | 为对应列添加额外的类名 | *any* |
### 方法

24
src/popup/README.md
View File

@ -100,18 +100,18 @@ export default {
| 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-click-overlay | Whether to close when click overlay | `boolean` | `true` | - |
| transition | Transition | `string` | `popup-slide` | - |
| get-container | Return the mount node for Popup | `string | () => HTMLElement` | - | - |
| 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-click-overlay | Whether to close when click overlay | *boolean* | `true` | - |
| transition | Transition | *string* | `popup-slide` | - |
| get-container | Return the mount node for Popup | *string \| () => HTMLElement* | - | - |
### Events

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

@ -109,18 +109,18 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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-click-overlay | 是否在点击遮罩层后关闭 | `boolean` | `true` | - |
| transition | 动画类名，用法与 Vue 内置的`transtion`组件的`name`属性一致 | `string` | - | - |
| get-container | 指定挂载的节点，可以传入选择器，<br>或一个返回节点的函数 | `string | () => HTMLElement` | - | - |
| 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-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `true` | - |
| transition | 动画类名，用法与 Vue 内置的`transtion`组件的`name`属性一致 | *string* | - | - |
| get-container | 指定挂载的节点，可以传入选择器，<br>或一个返回节点的函数 | *string \| () => HTMLElement* | - | - |
### Events

14
src/progress/README.md
View File

@ -58,10 +58,10 @@ Use `pivot-text` to custom text，use `color` to custom bar color
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| inactive | Whether to be gray | `boolean` | `false` | - |
| percentage | Percentage | `number` | `0` | - |
| show-pivot | Whether to show text | `boolean` | `true` | - |
| color | Color | `string` | `#1989fa` | - |
| pivot-text | Text | `string` | percentage | - |
| pivot-color | Text background color | `string` | inherit progress color | - |
| text-color | Text color | `string` | `#fff` | - |
| inactive | Whether to be gray | *boolean* | `false` | - |
| percentage | Percentage | *number* | `0` | - |
| show-pivot | Whether to show text | *boolean* | `true` | - |
| color | Color | *string* | `#1989fa` | - |
| pivot-text | Text | *string* | percentage | - |
| pivot-color | Text background color | *string* | inherit progress color | - |
| text-color | Text color | *string* | `#fff` | - |

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

@ -56,10 +56,10 @@ Vue.use(Progress);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| inactive | 是否置灰 | `boolean` | `false` | - |
| percentage | 进度百分比 | `number` | `0` | - |
| show-pivot | 是否显示进度文字 | `boolean` | `true` | - |
| color | 进度条颜色 | `string` | `#1989fa` | - |
| text-color | 进度条文字颜色 | `string` | `#fff` | - |
| pivot-text | 文字显示 | `string` | 百分比文字 | - |
| pivot-color | 文字背景色 | `string` | 与进度条颜色一致 | - |
| inactive | 是否置灰 | *boolean* | `false` | - |
| percentage | 进度百分比 | *number* | `0` | - |
| show-pivot | 是否显示进度文字 | *boolean* | `true` | - |
| color | 进度条颜色 | *string* | `#1989fa` | - |
| text-color | 进度条文字颜色 | *string* | `#fff` | - |
| pivot-text | 文字显示 | *string* | 百分比文字 | - |
| pivot-color | 文字背景色 | *string* | 与进度条颜色一致 | - |

18
src/pull-refresh/README.md
View File

@ -48,15 +48,15 @@ export default {
| 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` | - |
| disabled | Whether to disable pull refresh | `boolean` | `false` | - |
| 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` | - |
| disabled | Whether to disable pull refresh | *boolean* | `false` | - |
### Events

18
src/pull-refresh/README.zh-CN.md
View File

@ -48,15 +48,15 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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` | - |
| 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 | 顶部内容高度 | *number* | `50` | - |
| disabled | 是否禁用下拉刷新 | *boolean* | `false` | - |
### Events

18
src/radio/README.md
View File

@ -109,20 +109,20 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| name | Radio name | `any` | - | - |
| shape | Can be set to `square` | `string` | `round` | - |
| disabled | Whether to disable radio | `boolean` | `false` | - |
| icon-size | Icon size | `string | number` | `20px` | - |
| label-disabled | Whether to disable label click | `boolean` | `false` | - |
| label-position | Can be set to `left` | `string` | `right` | - |
| checked-color | Checked color | `string` | `#1989fa` | - | - |
| name | Radio name | *any* | - | - |
| shape | Can be set to `square` | *string* | `round` | - |
| disabled | Whether to disable radio | *boolean* | `false` | - |
| icon-size | Icon size | *string \| number* | `20px` | - |
| label-disabled | Whether to disable label click | *boolean* | `false` | - |
| label-position | Can be set to `left` | *string* | `right` | - |
| checked-color | Checked color | *string* | `#1989fa` | - | - |
### RadioGroup Props
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Name of checked radio | `any` | - | - |
| disabled | Diable all radios | `boolean` | `false` | - |
| v-model | Name of checked radio | *any* | - | - |
| disabled | Diable all radios | *boolean* | `false` | - |
### Radio Events

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

@ -115,20 +115,20 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| name | 标识符 | `any` | - | - |
| shape | 形状，可选值为 `square` | `string` | `round` | - |
| disabled | 是否为禁用状态 | `boolean` | `false` | - |
| icon-size | 图标大小，默认单位为`px` | `string | number` | `20px` | - |
| label-disabled | 是否禁用文本内容点击 | `boolean` | `false` | - |
| label-position | 文本位置，可选值为 `left` | `string` | `right` | - |
| checked-color | 选中状态颜色 | `string` | `#1989fa` | - |
| name | 标识符 | *any* | - | - |
| shape | 形状，可选值为 `square` | *string* | `round` | - |
| disabled | 是否为禁用状态 | *boolean* | `false` | - |
| icon-size | 图标大小，默认单位为`px` | *string \| number* | `20px` | - |
| label-disabled | 是否禁用文本内容点击 | *boolean* | `false` | - |
| label-position | 文本位置，可选值为 `left` | *string* | `right` | - |
| checked-color | 选中状态颜色 | *string* | `#1989fa` | - |
### RadioGroup Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 当前选中项的标识符 | `any` | - | - |
| disabled | 是否禁用所有单选框 | `boolean` | `false` | - |
| v-model | 当前选中项的标识符 | *any* | - | - |
| disabled | 是否禁用所有单选框 | *boolean* | `false` | - |
### Radio Events

24
src/rate/README.md
View File

@ -94,18 +94,18 @@ export default {
| 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` | - |
| 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` | - |
| disabled-color | Disabled color | `string` | `#bdbdbd` | - |
| 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` | - |
| 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` | - |
| disabled-color | Disabled color | *string* | `#bdbdbd` | - |
### Events

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

@ -94,18 +94,18 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 当前分值 | `number` | - | - |
| count | 图标总数 | `number` | `5` | - |
| size | 图标大小，默认单位为`px` | `string | number` | `20px` | - |
| gutter | 图标间距，默认单位为`px` | `string | number` | `4px` | - |
| color | 选中时的颜色 | `string` | `#ffd21e` | - |
| void-color | 未选中时的颜色 | `string` | `#c7c7c7` | - |
| icon | 选中时的图标名称或图片链接，可选值见 Icon 组件 | `string` | `star` | - |
| void-icon | 未选中时的图标名称或图片链接，可选值见 Icon 组件 | `string` | `star-o` | - |
| allow-half | 是否允许半选 | `boolean` | `false` | - |
| readonly | 是否为只读状态 | `boolean` | `false` | - |
| disabled | 是否禁用评分 | `boolean` | `false` | - |
| disabled-color | 禁用时的颜色 | `string` | `#bdbdbd` | - |
| v-model | 当前分值 | *number* | - | - |
| count | 图标总数 | *number* | `5` | - |
| size | 图标大小，默认单位为`px` | *string \| number* | `20px` | - |
| gutter | 图标间距，默认单位为`px` | *string \| number* | `4px` | - |
| color | 选中时的颜色 | *string* | `#ffd21e` | - |
| void-color | 未选中时的颜色 | *string* | `#c7c7c7` | - |
| icon | 选中时的图标名称或图片链接，可选值见 Icon 组件 | *string* | `star` | - |
| void-icon | 未选中时的图标名称或图片链接，可选值见 Icon 组件 | *string* | `star-o` | - |
| allow-half | 是否允许半选 | *boolean* | `false` | - |
| readonly | 是否为只读状态 | *boolean* | `false` | - |
| disabled | 是否禁用评分 | *boolean* | `false` | - |
| disabled-color | 禁用时的颜色 | *string* | `#bdbdbd` | - |
### Events

22
src/search/README.md
View File

@ -68,17 +68,17 @@ Search support all native properties of input tag，such as `maxlength`、`place
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| label | Search label | `string` | - | - |
| shape | Can be set to `round` | `string` | `square` | - |
| background | Background color | `string` | `#f2f2f2` | - |
| clearable | Whether to be clearable | `boolean` | `true` | - |
| show-action | Whether to show right button | `boolean` | `false` | - |
| disabled | Whether to disable field | `boolean` | `false` | - |
| readonly | Whether to be readonly | `boolean` | `false` | - |
| error | Whether to show error info | `boolean` | `false` | - |
| input-align | Input text align, can be set to `center` `right` | `string` | `left` | - |
| left-icon | Left icon name | `string` | `search` | - |
| right-icon | Right icon name | `string` | - | - |
| label | Search label | *string* | - | - |
| shape | Can be set to `round` | *string* | `square` | - |
| background | Background color | *string* | `#f2f2f2` | - |
| clearable | Whether to be clearable | *boolean* | `true` | - |
| show-action | Whether to show right button | *boolean* | `false` | - |
| disabled | Whether to disable field | *boolean* | `false` | - |
| readonly | Whether to be readonly | *boolean* | `false` | - |
| error | Whether to show error info | *boolean* | `false` | - |
| input-align | Input text align, can be set to `center` `right` | *string* | `left` | - |
| left-icon | Left icon name | *string* | `search` | - |
| right-icon | Right icon name | *string* | - | - |
### Events

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

@ -61,17 +61,17 @@ Search 默认支持 Input 标签所有的原生属性，比如 `maxlength`、`pl
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| label | 搜索框左侧文本 | `string` | - | - |
| shape | 形状，可选值为 `round` | `string` | `square` | - |
| background | 搜索框背景色 | `string` | `#f2f2f2` | - |
| clearable | 是否启用清除控件 | `boolean` | `true` | - |
| show-action | 是否在搜索框右侧显示取消按钮 | `boolean` | `false` | - |
| disabled | 是否禁用输入框 | `boolean` | `false` | - |
| readonly | 是否将输入框设为只读 | `boolean` | `false` | - |
| error | 是否将输入内容标红 | `boolean` | `false` | - |
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | `string` | `left` | - |
| left-icon | 输入框左侧图标名称或图片链接，可选值见 Icon 组件 | `string` | `search` | - |
| right-icon | 输入框右侧图标名称或图片链接，可选值见 Icon 组件 | `string` | - | - |
| label | 搜索框左侧文本 | *string* | - | - |
| shape | 形状，可选值为 `round` | *string* | `square` | - |
| background | 搜索框背景色 | *string* | `#f2f2f2` | - |
| clearable | 是否启用清除控件 | *boolean* | `true` | - |
| show-action | 是否在搜索框右侧显示取消按钮 | *boolean* | `false` | - |
| disabled | 是否禁用输入框 | *boolean* | `false` | - |
| readonly | 是否将输入框设为只读 | *boolean* | `false` | - |
| error | 是否将输入内容标红 | *boolean* | `false` | - |
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` | - |
| left-icon | 输入框左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | `search` | - |
| right-icon | 输入框右侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
### Events

12
src/sidebar/README.md
View File

@ -48,7 +48,7 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Index of chosen item | `string | number` | `0` | - |
| v-model | Index of chosen item | *string \| number* | `0` | - |
### Sidebar Events
@ -60,11 +60,11 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| title | Content | `string` | `''` | - |
| info | Info Message | `string | number` | `''` | - |
| 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 |
| title | Content | *string* | `''` | - |
| info | Info Message | *string \| number* | `''` | - |
| 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 |
### SidebarItem Events

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

@ -52,7 +52,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 当前导航项的索引 | `string | number` | `0` | 2.0.4 |
| v-model | 当前导航项的索引 | *string \| number* | `0` | 2.0.4 |
### Sidebar Events
@ -64,11 +64,11 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| title | 内容 | `string` | `''` | - |
| info | 提示消息 | `string | number` | `''` | - |
| url | 跳转链接 | `string` | - | - |
| to | 路由跳转对象，同 vue-router 的 to 属性 | `string | object` | - | 2.0.4 |
| replace | 跳转时是否替换当前页面历史 | `boolean` | `false` | 2.0.4 |
| title | 内容 | *string* | `''` | - |
| info | 提示消息 | *string \| number* | `''` | - |
| url | 跳转链接 | *string* | - | - |
| to | 路由跳转对象，同 vue-router 的 to 属性 | *string \| object* | - | 2.0.4 |
| replace | 跳转时是否替换当前页面历史 | *boolean* | `false` | 2.0.4 |
### SidebarItem Events

18
src/skeleton/README.md
View File

@ -55,12 +55,12 @@ export default {
| 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 | `number | string` | `40%` | - |
| avatar | Whether to show avatar placeholder | `boolean` | `false` | - |
| avatar-size | Size of avatar placeholder | `number | string` | `32px` | - |
| avatar-shape | Shape of avatar placeholder，can be set to `square` | `string` | `round` | - |
| loading | Whether to show skeleton，pass `false` to show child component | `boolean` | `true` | - |
| animate | Whether to enable animation | `boolean` | `true` | - |
| 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` | - |

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

@ -61,12 +61,12 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| row | 段落占位图行数 | `number` | `0` | - |
| row-width | 段落占位图宽度，可传数组来设置每一行的宽度 | `number | string | number[] | string[]` | `100%` | - |
| title | 是否显示标题占位图 | `boolean` | `false` | - |
| title-width | 标题占位图宽度 | `number | string` | `40%` | - |
| avatar | 是否显示头像占位图 | `boolean` | `false` | - |
| avatar-size | 头像占位图大小 | `number | string` | `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` | - |

42
src/sku/README.md
View File

@ -118,27 +118,27 @@ export default {
| 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` | - |
| 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 | () => HTMLElement` | - | - |
| 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` | - |
| 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 \| () => HTMLElement* | - | - |
### Events

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

@ -120,29 +120,29 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| 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` | - |
| 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 | 指定挂载的节点，可以传入选择器，<br>或一个返回节点的函数 | `string | () => HTMLElement` | - | - |
| initial-sku | 默认选中的 sku，具体参考高级用法 | `object` | `{}` | - |
| show-soldout-sku | 是否展示售罄的 sku，默认展示并置灰 | `boolean` | `true` | - |
| 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` | - |
| 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 | 指定挂载的节点，可以传入选择器，<br>或一个返回节点的函数 | *string \| () => HTMLElement* | - | - |
| initial-sku | 默认选中的 sku，具体参考高级用法 | *object* | `{}` | - |
| show-soldout-sku | 是否展示售罄的 sku，默认展示并置灰 | *boolean* | `true` | - |
### Events

18
src/slider/README.md
View File

@ -91,15 +91,15 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| value | Current value | `number` | `0` | - |
| disabled | Whether to disable slider | `boolean` | `false` | - |
| max | Max value | `number` | `100` | - |
| min | Min value | `number` | `0` | - |
| step | Step size | `number` | `1` | - |
| bar-height | Height of bar | `number | string` | `2px` | - |
| active-color | Active color of bar | `string` | `#1989fa` | - |
| inactive-color | Inactive color of bar | `string` | `#e5e5e5` | - |
| vertical | Whether to display vertical | `boolean` | `false` | - |
| value | Current value | *number* | `0` | - |
| disabled | Whether to disable slider | *boolean* | `false` | - |
| 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` | - |
| vertical | Whether to display vertical | *boolean* | `false` | - |
### Events

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

@ -93,15 +93,15 @@ Slider 垂直展示时，高度为 100% 父元素高度
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| value | 当前进度百分比 | `number` | `0` | - |
| disabled | 是否禁用滑块 | `boolean` | `false` | - |
| max | 最大值 | `number` | `100` | - |
| min | 最小值 | `number` | `0` | - |
| step | 步长 | `number` | `1` | - |
| bar-height | 进度条高度，默认单位为`px` | `number | string` | `2px` | - |
| active-color | 进度条激活态颜色 | `string` | `#1989fa` | - |
| inactive-color | 进度条默认颜色 | `string` | `#e5e5e5` | - |
| vertical | 是否垂直展示 | `boolean` | `false` | - |
| value | 当前进度百分比 | *number* | `0` | - |
| disabled | 是否禁用滑块 | *boolean* | `false` | - |
| max | 最大值 | *number* | `100` | - |
| min | 最小值 | *number* | `0` | - |
| step | 步长 | *number* | `1` | - |
| bar-height | 进度条高度，默认单位为`px` | *string \| number* | `2px` | - |
| active-color | 进度条激活态颜色 | *string* | `#1989fa` | - |
| inactive-color | 进度条默认颜色 | *string* | `#e5e5e5` | - |
| vertical | 是否垂直展示 | *boolean* | `false` | - |
### Events

Some files were not shown because too many files have changed in this diff Show More