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

[Doc] use ts-style type

Browse Source
This commit is contained in:
陈嘉涵 2019-07-11 20:35:41 +08:00
parent 32f19c5561
commit 019c75506a
120 changed files with 1288 additions and 1288 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -94,16 +94,16 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| actions | Options | `Array` | `[]` |
| title | Title | `String` | - |
| cancel-text | Text of cancel button | `String` | - |
| overlay | Whether to show overlay | `Boolean` | `true` |
| 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` |
| 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` |
| title | Title | `string` | - |
| cancel-text | Text of cancel button | `string` | - |
| overlay | Whether to show overlay | `boolean` | `true` |
| 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` |
| 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

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

@ -101,16 +101,16 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| actions | 菜单选项 | `Array` | `[]` | - |
| title | 标题 | `String` | - | - |
| cancel-text | 取消按钮文字 | `String` | - | - |
| overlay | 是否显示遮罩层 | `Boolean` | `true` | - |
| close-on-click-action | 是否在点击选项后关闭 | `Boolean` | `false` | 2.0.0 |
| close-on-click-overlay | 是否在点击遮罩层后关闭 | `Boolean` | `true` | - |
| lazy-render | 是否在显示弹层时才渲染节点 | `Boolean` | `true` | - |
| lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` | 2.0.0 |
| 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` | 1.6.15 |
| title | 标题 | `string` | - | - |
| cancel-text | 取消按钮文字 | `string` | - | - |
| overlay | 是否显示遮罩层 | `boolean` | `true` | - |
| close-on-click-action | 是否在点击选项后关闭 | `boolean` | `false` | 2.0.0 |
| close-on-click-overlay | 是否在点击遮罩层后关闭 | `boolean` | `true` | - |
| lazy-render | 是否在显示弹层时才渲染节点 | `boolean` | `true` | - |
| lock-scroll | 是否锁定背景滚动 | `boolean` | `true` | 2.0.0 |
| 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` | 1.6.15 |
### Events

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

@ -62,19 +62,19 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| area-list | Area List | `Object` | - |
| address-info | Address Info | `Object` | `{}` |
| area-list | Area List | `object` | - |
| address-info | Address Info | `object` | `{}` |
| search-result | Address search result | `Array` | `[]` |
| 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-maxlenth | Detail maxlength | `Number` | `200` |
| is-saving | Whether to show save button loading status | `Boolean` | `false` |
| is-deleting | Whether to show delete button loading status | `Boolean` | `false` |
| 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-maxlenth | Detail maxlength | `number` | `200` |
| is-saving | Whether to show save button loading status | `boolean` | `false` |
| is-deleting | Whether to show delete button loading status | `boolean` | `false` |
| tel-validator | The method to validate tel | `(tel: string) => boolean` | - |
| validator | Custom validator | `(key, value) => string` | - | 1.3.9 |
@ -109,23 +109,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

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

@ -61,19 +61,19 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| area-list | 地区列表 | `Object` | - | - |
| address-info | 收货人信息初始值 | `Object` | `{}` | - |
| area-list | 地区列表 | `object` | - | - |
| address-info | 收货人信息初始值 | `object` | `{}` | - |
| search-result | 详细地址搜索结果 | `Array` | `[]` | - |
| 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-maxlenth | 详细地址最大长度 | `Number` | `200` | 2.0.4 |
| is-saving | 是否显示保存按钮加载动画 | `Boolean` | `false` | - |
| is-deleting | 是否显示删除按钮加载动画 | `Boolean` | `false` | - |
| 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-maxlenth | 详细地址最大长度 | `number` | `200` | 2.0.4 |
| is-saving | 是否显示保存按钮加载动画 | `boolean` | `false` | - |
| is-deleting | 是否显示删除按钮加载动画 | `boolean` | `false` | - |
| tel-validator | 手机号格式校验函数 | `string => boolean` | - | - |
| validator | 自定义校验函数 | `(key, value) => string` | - | - |
@ -110,23 +110,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` |
### 省市县列表数据格式

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

@ -69,12 +69,12 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Id of chosen address | String | - |
| v-model | Id of chosen address | string | - |
| list | Address list | Array | `[]` |
| disabled-list | Disabled address list | `Array` | `[]` |
| disabled-text | Disabled text | `String` | - |
| switchable | Whether to allow switch address | `Boolean` | `true` |
| add-button-text | Add button text | String | `Add new 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
@ -90,10 +90,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

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

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

18
src/area/README.md
View File

@ -45,15 +45,15 @@ Set `columns-num` with 2, you'll have a 2 level picker.
| Attribute | Description | Type | Default |
|------|------|------|------|
| value | the `code` of selected area | `String` | - |
| title | Toolbar title | `String` | - |
| area-list | Area data | `Object` | - |
| columns-num | level of picker | `String | Number` | `3` |
| 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` |
| 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` |
### Events

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

@ -44,15 +44,15 @@ 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` | `确认` | 1.5.3 |
| cancel-button-text | 取消按钮文字 | `String` | `取消` | 1.5.3 |
| 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` | `确认` | 1.5.3 |
| cancel-button-text | 取消按钮文字 | `string` | `取消` | 1.5.3 |
### Events
@ -72,7 +72,7 @@ Vue.use(Area);
### 省市区列表数据格式
整体是一个 Object，包含 `province_list`, `city_list`, `county_list` 三个 key。
整体是一个 object，包含 `province_list`, `city_list`, `county_list` 三个 key。
每项以省市区编码作为 key，省市区名字作为 value。编码为 6 位数字，前两位代表省份，中间两位代表城市，后两位代表区县，以 0 补足 6 位。如北京编码为 `11`，以零补足 6 位，为 `110000`。

36
src/button/README.md
View File

@ -79,24 +79,24 @@ Vue.use(Button);
| Attribute | Description | Type | Default |
|------|------|------|------|
| type | Can be set to `primary` `info` `warning` `danger` | `String` | `default` |
| size | Can be set to `large` `small` `mini` | `String` | `normal` |
| text | Text | `String` | - |
| 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` | - |
| 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

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

@ -95,25 +95,25 @@ Vue.use(Button);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| type | 类型，可选值为 `primary` `info` `warning` `danger` | `String` | `default` | 1.6.6 |
| size | 尺寸，可选值为 `large` `small` `mini` | `String` | `normal` | - |
| text | 按钮文字 | `String` | - | - |
| icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | `String` | - | 2.0.0 |
| 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` | 1.6.11 |
| loading | 是否显示为加载状态 | `Boolean` | `false` | - |
| loading-text | 加载状态提示文字 | `String` | - | 1.6.3 |
| loading-type | 加载图标类型，可选值为`spinner` | `String` | `circular` | 2.0.0 |
| loading-size | 加载图标大小 | `String` | `20px` | 1.6.7 |
| url | 跳转链接 | `String` | - | 1.6.5 |
| to | 路由跳转对象，同 vue-router 的 to 属性 | `String | Object` | - | 1.6.5 |
| replace | 跳转时是否替换当前页面历史 | `Boolean` | `false` | 1.6.5 |
| type | 类型，可选值为 `primary` `info` `warning` `danger` | `string` | `default` | 1.6.6 |
| size | 尺寸，可选值为 `large` `small` `mini` | `string` | `normal` | - |
| text | 按钮文字 | `string` | - | - |
| icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | `string` | - | 2.0.0 |
| 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` | 1.6.11 |
| loading | 是否显示为加载状态 | `boolean` | `false` | - |
| loading-text | 加载状态提示文字 | `string` | - | 1.6.3 |
| loading-type | 加载图标类型，可选值为`spinner` | `string` | `circular` | 2.0.0 |
| loading-size | 加载图标大小 | `string` | `20px` | 1.6.7 |
| url | 跳转链接 | `string` | - | 1.6.5 |
| to | 路由跳转对象，同 vue-router 的 to 属性 | `string | object` | - | 1.6.5 |
| replace | 跳转时是否替换当前页面历史 | `boolean` | `false` | 1.6.5 |
### Events

22
src/card/README.md
View File

@ -64,17 +64,17 @@ Use slot to custom content.
| Attribute | Description | Type | Default |
|------|------|------|------|
| thumb | Left thumb image URL | `String` | - |
| title | Title | `String` | - |
| desc | Description | `String` | - |
| tag | Tag | `String` | - |
| num | Number | `String | Number` | - |
| price | Price | `String | Number` | - |
| origin-price | Origin price | `String | Number` | - |
| centered | Whether content vertical centered | `Boolean` | `false` |
| currency | Currency symbol | `String` | `¥` |
| thumb-link | Thumb link URL | `String` | - |
| lazy-load | Whether to enable thumb lazy load，should register [Lazyload](#/en-US/lazyload) component | `Boolean` | `false` |
| 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

@ -66,17 +66,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` | 1.5.0 |
| 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` | 1.5.0 |
### Events

32
src/cell/README.md
View File

@ -98,27 +98,27 @@ Vue.use(Cell).use(CellGroup);
| Attribute | Description | Type | Default |
|------|------|------|------|
| 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 |
|------|------|------|------|
| 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` | - |
| 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` | - |

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

@ -104,27 +104,27 @@ Vue.use(Cell).use(CellGroup);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| title | 分组标题 | `String` | `-` | 1.6.9 |
| border | 是否显示外边框 | `Boolean` | `true` | - |
| title | 分组标题 | `string` | `-` | 1.6.9 |
| 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` | - | -|
| 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` | - | 1.6.17 |
| title-class | 左侧标题额外类名 | `any` | - | - |
| value-class | 右侧内容额外类名 | `any` | - | - |

18
src/checkbox/README.md
View File

@ -144,21 +144,21 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| 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` | - |
| 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 |
|------|------|------|------|
| v-model | Names of all checked checkboxes | `Array` | - |
| disabled | Disable all checkboxes | `Boolean` | `false` |
| max | Maximum amount of checked options | `Number` | `0`(Unlimited) |
| disabled | Disable all checkboxes | `boolean` | `false` |
| max | Maximum amount of checked options | `number` | `0`(Unlimited) |
### Checkbox Events

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

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

20
src/circle/README.md
View File

@ -58,16 +58,16 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current rate | `Number` | - |
| rate | Target rate | `Number` | `100` |
| size | Circle size | `String` | `100px` |
| color | Progress bar color | `String` | `#1989fa` |
| layer-color | Layer color | `String` | `#fff` |
| fill | Fill color | `String` | `none` |
| speed | Animate speed（rate/s）| `Number` | `0` |
| text | Text | `String` | - |
| stroke-width | Stroke width | `Number` | `40` |
| clockwise | Is clockwise | `Boolean` | `true` |
| v-model | Current rate | `number` | - |
| rate | Target rate | `number` | `100` |
| size | Circle size | `string` | `100px` |
| color | Progress bar color | `string` | `#1989fa` |
| layer-color | Layer color | `string` | `#fff` |
| fill | Fill color | `string` | `none` |
| speed | Animate speed（rate/s）| `number` | `0` |
| text | Text | `string` | - |
| stroke-width | Stroke width | `number` | `40` |
| clockwise | Is clockwise | `boolean` | `true` |
### Slots

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

@ -60,16 +60,16 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 当前进度 | `Number` | - | - |
| rate | 目标进度 | `Number` | `100` | - |
| size | 圆环直径 | `String` | `100px` | - |
| color | 进度条颜色 | `String` | `#1989fa` | - |
| 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 | 圆环直径 | `string` | `100px` | - |
| color | 进度条颜色 | `string` | `#1989fa` | - |
| 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

@ -92,16 +92,16 @@ Setting `type` to `flex` to enable flex layout
| Attribute | Description | Type | Default |
|------|------|------|------|
| type | Layout type, can be set to `flex` | `String` | - |
| gutter | Grid spacing（px） | `String | Number` | - |
| 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 |
|------|------|------|------|
| 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` |

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

@ -95,16 +95,16 @@ 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` | - |

30
src/collapse/README.md
View File

@ -77,9 +77,9 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | names of current active panels | `Array | String | Number` | - |
| accordion | Whether to be accordion mode | `Boolean` | `false` |
| border | Whether to show outer border | `Boolean` | `true` |
| v-model | names of current active panels | `Array | string | number` | - |
| accordion | Whether to be accordion mode | `boolean` | `false` |
| border | Whether to show outer border | `boolean` | `true` |
### Collapse Events
@ -91,18 +91,18 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| name | Name | `String | Number` | `index` |
| icon | Left Icon | `String` | - |
| size | Title size，can be set to `large` | `String` | - |
| title | Title | `String | Number` | - |
| value | Right text | `String | Number` | - |
| label | Description below the title | `String` | - |
| border | Whether to show inner border | `Boolean` | `true` |
| disabled | Whether to disabled collapse | `Boolean` | `false` |
| is-link | Whether to show link icon | `Boolean` | `true` |
| title-class | Title className | `String` | - |
| value-class | Value className | `String` | - |
| label-class | Label className | `String` | - |
| 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

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

@ -78,9 +78,9 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 当前展开面板的 name | `Array | String | Number` | - | - |
| accordion | 是否开启手风琴模式 | `Boolean` | `false` | - |
| border | 是否显示外边框 | `Boolean` | `true` | 1.6.9 |
| v-model | 当前展开面板的 name | `Array | string | number` | - | - |
| accordion | 是否开启手风琴模式 | `boolean` | `false` | - |
| border | 是否显示外边框 | `boolean` | `true` | 1.6.9 |
### Collapse Events
@ -92,18 +92,18 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|------|
| name | 唯一标识符，默认为索引值 | `String | Number` | `index` | - |
| icon | 标题栏左侧图标名称或图片链接，可选值见 Icon 组件 | `String` | - | - |
| size | 标题栏大小，可选值为 `large` | `String` | - | 1.6.9 |
| 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` | - | 1.6.9 |
| 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

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

@ -136,10 +136,10 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| type | Can be set to `add` `edit` | `String` | `add` |
| name | Name | `String` | - |
| tel | Phone | `String` | - |
| add-text | Add card text | `String` | `Add contact info` |
| 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
@ -151,9 +151,9 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|------|
| v-model | Id of chosen contact | `String | Number` | - |
| v-model | Id of chosen contact | `string | number` | - |
| list | Contact list | `Array` | `[]` |
| add-text | Add button text | `String` | `Add new contact` |
| add-text | Add button text | `string` | `Add new contact` |
### ContactList Events
@ -167,10 +167,10 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|------|
| contact-info | Contact Info | `Object` | `[]` |
| is-edit | Whether is editing | `Boolean` | `false` |
| is-saving | Whether to show save button loading status | `Boolean` | `false` |
| is-deleting | Whether to show delete button loading status | `Boolean` | `false` |
| 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
@ -184,6 +184,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` |

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

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

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

@ -112,10 +112,10 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|------|
| 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

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

@ -122,10 +122,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

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

@ -72,31 +72,31 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| title | Cell title | `String` | `Coupon` |
| chosen-coupon | Index of chosen coupon | `Number` | `-1` |
| title | Cell title | `string` | `Coupon` |
| chosen-coupon | Index of chosen coupon | `number` | `-1` |
| coupons | Coupon list | `Array` | `[]` |
| editable | Cell editable | `Boolean` | `true` |
| border | Whether to show innner border | `Boolean` | `true` |
| currency | Currency symbol | `String` | `¥` |
| editable | Cell editable | `boolean` | `true` |
| border | Whether to show innner border | `boolean` | `true` |
| currency | Currency symbol | `string` | `¥` |
### CouponList Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current exchange code | `String` | - |
| chosen-coupon | Index of chosen coupon | `Number` | `-1` |
| v-model | Current exchange code | `string` | - |
| chosen-coupon | Index of chosen coupon | `number` | `-1` |
| coupons | Coupon list | `Array` | `[]` |
| disabled-coupons | Disabled coupon list | `Array` | `[]` |
| 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` | `¥` |
| 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` | `¥` |
### CouponList Events
@ -109,13 +109,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` |

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

@ -72,33 +72,33 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| title | 单元格标题 | `String` | `优惠券` | - |
| chosen-coupon | 当前选中优惠券的索引 | `Number` | `-1` | - |
| title | 单元格标题 | `string` | `优惠券` | - |
| chosen-coupon | 当前选中优惠券的索引 | `number` | `-1` | - |
| coupons | 可用优惠券列表 | `Array` | `[]` | - |
| editable | 能否切换优惠券 | `Boolean` | `true` | - |
| border | 是否显示内边框 | `Boolean` | `true` | - |
| currency | 货币符号 | `String` | `¥` | - | 1.5.0 |
| editable | 能否切换优惠券 | `boolean` | `true` | - |
| border | 是否显示内边框 | `boolean` | `true` | - |
| currency | 货币符号 | `string` | `¥` | - | 1.5.0 |
### CouponList Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 当前输入的兑换码 | `String` | - | - |
| chosen-coupon | 当前选中优惠券的索引 | `Number` | `-1` | - |
| v-model | 当前输入的兑换码 | `string` | - | - |
| chosen-coupon | 当前选中优惠券的索引 | `number` | `-1` | - |
| coupons | 可用优惠券列表 | `Array` | `[]` | - |
| disabled-coupons | 不可用优惠券列表 | `Array` | `[]` | - |
| 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` | `¥` | - | 1.5.0 |
| 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` | `¥` | - | 1.5.0 |
### CouponList Events
@ -111,13 +111,13 @@ export default {
| key | 说明 | 类型 |
|------|------|------|
| 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` |

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

@ -147,21 +147,21 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|------|
| type | Can be set to `date` `time`<br> `year-month` | `String` | `datetime` |
| 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` |
| 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` |
| 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

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

@ -152,22 +152,22 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| type | 类型，可选值为 `date` <br> `time` `year-month` | `String` | `datetime` | - |
| 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` | - |
| min-hour | 可选的最小小时，针对 time 类型 | `number` | `0` | - |
| max-hour | 可选的最大小时，针对 time 类型 | `number` | `23` | - |
| min-minute | 可选的最小分钟，针对 time 类型 | `number` | `0` | - |
| max-minute | 可选的最大分钟，针对 time 类型 | `number` | `59` | - |
| filter | 选项过滤函数 | `(type, values) => values` | - | 2.0.0 |
| 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` | - |
| 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

62
src/dialog/README.md
View File

@ -117,42 +117,42 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| title | Title | `String` | - |
| message | Message | `String` | - |
| messageAlign | Message text align，can be set to `left` `right` | `String` | `center` |
| className | Custom className | `String | Array | Object` | - |
| 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` |
| 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` |
| title | Title | `string` | - |
| message | Message | `string` | - |
| messageAlign | Message text align，can be set to `left` `right` | `string` | `center` |
| className | Custom className | `string | Array | object` | - |
| 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` |
| 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` |
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| 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-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` | - |
| 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-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` | - |
### Events

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

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

6
src/divider/README.md
View File

@ -49,9 +49,9 @@ Vue.use(Divider);
| Attribute | Description | Type | Default |
|------|------|------|------|
| dashed | Whether to use dashed border | `Boolean` | `false` |
| hairline | Whether to use hairline | `Boolean` | `true` |
| content-position | Content position，can be set to `left` `right` | `String` | `center` |
| 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` |
### Cell Slots

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

@ -59,9 +59,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

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

@ -100,23 +100,23 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|------|
| active-color | Active color of title and option | `String` | `#1989fa` |
| z-index | z-index of menu item | `Number` | `10` |
| duration | Transition duration, unit second | `Number` | `0.2` |
| direction | Expand direction, can be set to `up` | `String` | `down` |
| overlay | Whether to show overlay | `Boolean` | `true` |
| close-on-click-overlay | Whether to close when click overlay | `Boolean` | `true` |
| close-on-click-outside | Whether to close when click outside | `Boolean` | `true` |
| 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` |
| 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` |
### DropdownItem Props
| Attribute | Description | Type | Default |
|------|------|------|------|------|
| value | Value of current option，can use `v-model` | `String | Number` | - |
| title | Item title | `String` | Text of selected option |
| value | Value of current option，can use `v-model` | `string | number` | - |
| title | Item title | `string` | Text of selected option |
| options | Options | `Array` | `[]` |
| disabled | Whether to disable dropdown item | `Boolean` | `false` |
| title-class | Title class | `String` | - |
| disabled | Whether to disable dropdown item | `boolean` | `false` |
| title-class | Title class | `string` | - |
### DropdownItem Events

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

@ -104,23 +104,23 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| active-color | 菜单标题和选项的选中态颜色 | `String` | `#1989fa` | - |
| z-index | 菜单栏 z-index 层级 | `Number` | `10` | - |
| duration | 动画时长，单位秒 | `Number` | `0.2` | 2.0.0 |
| 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` | 2.0.0 |
| 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` | 当前选中项文字 | - |
| value | 当前选中项对应的 value，可以通过`v-model`双向绑定 | `string | number` | - | - |
| title | 菜单项标题 | `string` | 当前选中项文字 | - |
| options | 选项数组 | `Array` | `[]` | - |
| disabled | 是否禁用菜单 | `Boolean` | `false` | - |
| title-class | 标题额外类名 | `String` | - | - |
| disabled | 是否禁用菜单 | `boolean` | `false` | - |
| title-class | 标题额外类名 | `string` | - | - |
### DropdownItem Events

42
src/field/README.md
View File

@ -123,28 +123,28 @@ Field support all native properties of input tag，such as `maxlength`、`placeh
| Attribute | Description | Type | Default |
|------|------|------|------|
| value | Field value | `String | Number` | - |
| label | Field label | `String` | - |
| type | Input type | `String` | `text` |
| size | Size，can be set to `large` | `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` |
| arrow-direction | Can be set to `left` `up` `down` | `String` | - |
| error | Whether to show error info | `Boolean` | `false` |
| error-message | Error message | `String` | `''` |
| value | Field value | `string | number` | - |
| label | Field label | `string` | - |
| type | Input type | `string` | `text` |
| size | Size，can be set to `large` | `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` |
| arrow-direction | Can be set to `left` `up` `down` | `string` | - |
| error | Whether to show error info | `boolean` | `false` |
| 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` | - |
| 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

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

@ -126,28 +126,28 @@ Field 默认支持 Input 标签所有的原生属性，比如 `maxlength`、`pla
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|------|
| label | 输入框左侧文本 | `String` | - | - |
| value | 当前输入的值 | `String | Number` | - | - |
| type | 可设置为原生类型, 如 `number` `tel` `textarea` | `String` | `text` | - |
| size | 大小，可选值为 `large` | `String` | - | 1.6.9 |
| border | 是否显示内边框 | `Boolean` | `true` | - |
| disabled | 是否禁用输入框 | `Boolean` | `false` | - |
| readonly | 是否只读 | `Boolean` | `false` | - |
| required | 是否显示表单必填星号 | `Boolean` | `false` | - |
| clearable | 是否启用清除控件 | `Boolean` | `false` | - |
| clickable | 是否开启点击反馈 | `Boolean` | `false` | 2.0.0 |
| is-link | 是否展示右侧箭头并开启点击反馈 | `Boolean` | `false` | - |
| arrow-direction | 箭头方向，可选值为 `left` `up` `down` | `String` | - | 2.0.4 |
| error | 是否将输入内容标红 | `Boolean` | `false` | - |
| error-message | 底部错误提示文案，为空时不展示 | `String` | `''` | -
| label | 输入框左侧文本 | `string` | - | - |
| value | 当前输入的值 | `string | number` | - | - |
| type | 可设置为原生类型, 如 `number` `tel` `textarea` | `string` | `text` | - |
| size | 大小，可选值为 `large` | `string` | - | 1.6.9 |
| border | 是否显示内边框 | `boolean` | `true` | - |
| disabled | 是否禁用输入框 | `boolean` | `false` | - |
| readonly | 是否只读 | `boolean` | `false` | - |
| required | 是否显示表单必填星号 | `boolean` | `false` | - |
| clearable | 是否启用清除控件 | `boolean` | `false` | - |
| clickable | 是否开启点击反馈 | `boolean` | `false` | 2.0.0 |
| is-link | 是否展示右侧箭头并开启点击反馈 | `boolean` | `false` | - |
| arrow-direction | 箭头方向，可选值为 `left` `up` `down` | `string` | - | 2.0.4 |
| error | 是否将输入内容标红 | `boolean` | `false` | - |
| error-message | 底部错误提示文案，为空时不展示 | `string` | `''` | -
| label-class | 左侧文本额外类名 | `any` | - | 2.0.0 |
| label-width | 左侧文本宽度，可指定单位，默认为 px | `String | Number` | `90px` | 1.6.17 |
| label-align | 左侧文本对齐方式，可选值为 `center` `right` | `String` | `left` | - |
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | `String` | `left` | - |
| error-message-align | 错误提示文案对齐方式，可选值为 `center` `right` | `String` | `left` | 1.6.11 |
| autosize | 自适应内容高度，只对 textarea 有效，可传入对象,<br>如 { maxHeight: 100, minHeight: 50 }，单位为 px | `Boolean | Object` | `false` | - |
| left-icon | 输入框左侧图标名称或图片链接，可选值见 Icon 组件 | `String` | - | 1.5.7 |
| right-icon | 输入框尾部图标名称或图片链接，可选值见 Icon 组件 | `String` | - | 1.5.7 |
| label-width | 左侧文本宽度，可指定单位，默认为 px | `string | number` | `90px` | 1.6.17 |
| label-align | 左侧文本对齐方式，可选值为 `center` `right` | `string` | `left` | - |
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | `string` | `left` | - |
| error-message-align | 错误提示文案对齐方式，可选值为 `center` `right` | `string` | `left` | 1.6.11 |
| autosize | 自适应内容高度，只对 textarea 有效，可传入对象,<br>如 { maxHeight: 100, minHeight: 50 }，单位为 px | `boolean | object` | `false` | - |
| left-icon | 输入框左侧图标名称或图片链接，可选值见 Icon 组件 | `string` | - | 1.5.7 |
| right-icon | 输入框尾部图标名称或图片链接，可选值见 Icon 组件 | `string` | - | 1.5.7 |
### Events

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

@ -93,32 +93,32 @@ Use `info` prop to show messages in upper right corner of icon
| Attribute | Description | Type | Default |
|------|------|------|------|
| 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 |
|------|------|------|------|
| text | Button text | `String` | - |
| icon | Icon | `String` | - |
| 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` |
| 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 |
|------|------|------|------|
| type | Button type, Can be set to `primary` `info` `warning` `danger` | `String` | `default` |
| text | Button text | `String` | - |
| primary | Is primary button (red color) | `Boolean` | `false` |
| disabled | Whether to disable button | `Boolean` | `false` |
| loading | Whether show loading status | `Boolean` | `false` |
| url | Link | `String` | - |
| to | Target route of the link, same as to of vue-router | `String | Object` | - |
| replace | If true, the navigation will not leave a history record | `Boolean` | `false` |
| type | Button type, Can be set to `primary` `info` `warning` `danger` | `string` | `default` |
| text | Button text | `string` | - |
| primary | Is primary button (red color) | `boolean` | `false` |
| disabled | Whether to disable button | `boolean` | `false` |
| loading | Whether show loading status | `boolean` | `false` |
| url | Link | `string` | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` |
### GoodsActionIcon Slots

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

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

@ -101,22 +101,22 @@ Vue.use(Grid).use(GridItem);
| Attribute | Description | Type | Default |
|------|------|------|------|------|
| column-num | Column Num | `Number` | `4` |
| gutter | Gutter | `String | Number` | `0` |
| border | Whether to show border | `Boolean` | `true` |
| center | Whether to center content | `Boolean` | `true` |
| square | Whether to be square shape | `Boolean` | `false` |
| clickable | Whether to show click feedback when clicked | `Boolean` | `false` |
| column-num | Column Num | `number` | `4` |
| gutter | Gutter | `string | number` | `0` |
| border | Whether to show border | `boolean` | `true` |
| center | Whether to center content | `boolean` | `true` |
| square | Whether to be square shape | `boolean` | `false` |
| clickable | Whether to show click feedback when clicked | `boolean` | `false` |
### GridItem Props
| Attribute | Description | Type | Default |
|------|------|------|------|------|
| 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

@ -117,22 +117,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

@ -61,12 +61,12 @@ import 'vant/lib/icon/local.css';
| Attribute | Description | Type | Default |
|------|------|------|------|
| 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

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

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

@ -90,34 +90,34 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| images | Images URL list | `Array` | `[]` |
| 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` |
| 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` |
| onClose | Triggered when close | `Function` | - |
| onChange | Triggered when current image change | `Function` | - |
| closeOnPopstate | Whether to close when popstate | `Boolean` | `false` |
| asyncClose | Whether to enable async close | `Boolean` | `false` |
| className | Custom className | `String | Array | Object` | - |
| 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` |
| closeOnPopstate | Whether to close when popstate | `boolean` | `false` |
| asyncClose | Whether to enable async close | `boolean` | `false` |
| className | Custom className | `string | Array | object` | - |
| 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 |
|------|------|------|------|
| images | Images URL list | `Array` | `[]` |
| 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` |
| async-close | Whether to enable async close | `Boolean` | `false` |
| close-on-popstate | Whether to close when popstate | `Boolean` | `false` |
| class-name | Custom className | `String | Array | Object` | - |
| 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` |
| 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` |
| async-close | Whether to enable async close | `boolean` | `false` |
| close-on-popstate | Whether to close when popstate | `boolean` | `false` |
| class-name | Custom className | `string | Array | object` | - |
| 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
@ -136,5 +136,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` |

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

@ -102,18 +102,18 @@ export default {
| 参数名 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| images | 需要预览的图片 URL 数组 | `Array` | `[]` | - |
| startPosition | 图片预览起始位置索引 | `Number` | `0` | - |
| showIndex | 是否显示页码 | `Boolean` | `true` | - |
| showIndicators | 是否显示轮播指示器 | `Boolean` | `false` | - |
| loop | 是否开启循环播放 | `Boolean` | `true` | - |
| startPosition | 图片预览起始位置索引 | `number` | `0` | - |
| showIndex | 是否显示页码 | `boolean` | `true` | - |
| showIndicators | 是否显示轮播指示器 | `boolean` | `false` | - |
| loop | 是否开启循环播放 | `boolean` | `true` | - |
| onClose | 关闭时的回调函数 | `Function` | - | - |
| onChange | 切换图片时的回调函数，回调参数为当前索引 | `Function` | - | 2.0.3 |
| asyncClose | 是否开启异步关闭 | `Boolean` | `false` | - |
| closeOnPopstate | 是否在页面回退时自动关闭 | `Boolean` | `false` | 2.0.0 |
| className | 自定义类名 | `String | Array | Object` | - | 1.5.2 |
| lazyLoad | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | `Boolean` | `false` | 1.5.3 |
| maxZoom | 手势缩放时，最大缩放比例 | `Number` | `3` | 1.6.14 |
| minZoom | 手势缩放时，最小缩放比例 | `Number` | `1/3` | 1.6.14 |
| asyncClose | 是否开启异步关闭 | `boolean` | `false` | - |
| closeOnPopstate | 是否在页面回退时自动关闭 | `boolean` | `false` | 2.0.0 |
| className | 自定义类名 | `string | Array | object` | - | 1.5.2 |
| lazyLoad | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | `boolean` | `false` | 1.5.3 |
| maxZoom | 手势缩放时，最大缩放比例 | `number` | `3` | 1.6.14 |
| minZoom | 手势缩放时，最小缩放比例 | `number` | `1/3` | 1.6.14 |
### Props
@ -122,16 +122,16 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| images | 需要预览的图片 URL 数组 | `Array` | `[]` | 1.1.16 |
| start-position | 图片预览起始位置索引 | `Number` | `0` | 1.1.16 |
| show-index | 是否显示页码 | `Boolean` | `true` | 1.3.4 |
| show-indicators | 是否显示轮播指示器 | `Boolean` | `false` | 1.3.10 |
| loop | 是否开启循环播放 | `Boolean` | `true` | 1.4.4 |
| async-close | 是否开启异步关闭 | `Boolean` | `false` | 1.4.8 |
| close-on-popstate | 是否在页面回退时自动关闭 | `Boolean` | `false` |
| class-name | 自定义类名 | `String | Array | Object` | - | 1.5.2 |
| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | `Boolean` | `false` | 1.5.3 |
| max-zoom | 手势缩放时，最大缩放比例 | `Number` | `3` | 1.6.14 |
| min-zoom | 手势缩放时，最小缩放比例 | `Number` | `1/3` | 1.6.14 |
| start-position | 图片预览起始位置索引 | `number` | `0` | 1.1.16 |
| show-index | 是否显示页码 | `boolean` | `true` | 1.3.4 |
| show-indicators | 是否显示轮播指示器 | `boolean` | `false` | 1.3.10 |
| loop | 是否开启循环播放 | `boolean` | `true` | 1.4.4 |
| async-close | 是否开启异步关闭 | `boolean` | `false` | 1.4.8 |
| close-on-popstate | 是否在页面回退时自动关闭 | `boolean` | `false` |
| class-name | 自定义类名 | `string | Array | object` | - | 1.5.2 |
| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | `boolean` | `false` | 1.5.3 |
| max-zoom | 手势缩放时，最大缩放比例 | `number` | `3` | 1.6.14 |
| min-zoom | 手势缩放时，最小缩放比例 | `number` | `1/3` | 1.6.14 |
### Events
@ -154,5 +154,5 @@ export default {
| 参数名 | 说明 | 类型 |
|------|------|------|
| url | 当前图片 URL | `String` |
| index | 当前图片的索引值 | `Number` |
| url | 当前图片 URL | `string` |
| index | 当前图片的索引值 | `number` |

12
src/image/README.md
View File

@ -54,12 +54,12 @@ Vue.use(Lazyload);
| Attribute | Description | Type | Default |
|------|------|------|------|
| src | Src | `String` | - | - |
| fit | Fit mode | `String` | `fill` | - |
| alt | Alt | `String` | - | - |
| width | Width | `String | Number` | - | - |
| height | Height | `String | Number` | - | - |
| lazy-load | Whether to enable lazy load，should register [Lazyload](#/en-US/lazyload) component | `Boolean` | `false` | - |
| src | Src | `string` | - | - |
| fit | Fit mode | `string` | `fill` | - |
| alt | Alt | `string` | - | - |
| width | Width | `string | number` | - | - |
| height | Height | `string | number` | - | - |
| lazy-load | Whether to enable lazy load，should register [Lazyload](#/en-US/lazyload) component | `boolean` | `false` | - |
### fit optional value

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

@ -80,12 +80,12 @@ Vue.use(Image);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| src | 图片链接 | `String` | - | - |
| fit | 图片填充模式 | `String` | `fill` | - |
| alt | 替代文本 | `String` | - | - |
| width | 宽度，默认单位为 px | `String | Number` | - | - |
| height | 高度，默认单位为 px | `String | Number` | - | - |
| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | `Boolean` | `false` | - |
| src | 图片链接 | `string` | - | - |
| fit | 图片填充模式 | `string` | `fill` | - |
| alt | 替代文本 | `string` | - | - |
| width | 宽度，默认单位为 px | `string | number` | - | - |
| height | 高度，默认单位为 px | `string | number` | - | - |
| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | `boolean` | `false` | - |
### 图片填充模式

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

@ -63,16 +63,16 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| index-list | Index List | `Array` | `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` |
| highlight-color | Index character highlight color | `String` | `#07c160` | - |
| 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` |
| highlight-color | Index character highlight color | `string` | `#07c160` | - |
### IndexAnchor Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| index | Index | `String | Number` | - |
| index | Index | `string | number` | - |
### IndexBar Events

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

@ -67,16 +67,16 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| index-list | 索引字符列表 | `Array` | `A-Z` | - |
| z-index | z-index 层级 | `Number` | `1` | - |
| sticky | 是否开启锚点自动吸顶 | `Boolean` | `true` | - |
| sticky-offset-top | 锚点自动吸顶时与顶部的距离 | `Number` | `0` | 2.0.7 |
| highlight-color | 索引字符高亮颜色 | `String` | `#07c160` | - |
| 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

14
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 |
|------|------|------|------|
| 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` |
| 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 | `Array` | `scroll`... |
| adapter | Dynamically modify the attribute of element | `Object` | - |
| filter | The image's listener filter | `Object` | - |
| lazyComponent | Lazyload component | `Boolean` | `false` |
| 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)

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

@ -59,13 +59,13 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| loading | 加载时的图片 | `String` | - | - |
| error | 错误时的图片 | `String` | - | - |
| preload | 预加载高度的比例 | `String` | - | - |
| attempt | 尝试次数 | `Number` | `3` | - |
| loading | 加载时的图片 | `string` | - | - |
| error | 错误时的图片 | `string` | - | - |
| preload | 预加载高度的比例 | `string` | - | - |
| attempt | 尝试次数 | `number` | `3` | - |
| listenEvents | 监听的事件 | `Array` | `scroll`等 | - |
| adapter | 适配器 | `Object` | - | - |
| filter | 图片 URL 过滤 | `Object` | - | - |
| lazyComponent | 是否能懒加载模块 | `Boolean` | `false` | - |
| adapter | 适配器 | `object` | - | - |
| filter | 图片 URL 过滤 | `object` | - | - |
| lazyComponent | 是否能懒加载模块 | `boolean` | `false` | - |
更多内容请参照：[vue-lazyload 官方文档](https://github.com/hilongjw/vue-lazyload)

18
src/list/README.md
View File

@ -101,15 +101,15 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Whether to show loading info，the `load` event will not be triggered when loading | `Boolean` | `false` |
| finished | Whether loading is finished，the `load` event will not be triggered when finished | `Boolean` | `false` |
| error | Whether loading is error，the `load` event will be triggered only when error text clicked, the `sync` modifier is needed | `Boolean` | `false` |
| offset | The load event will be triggered when the distance between the scrollbar and the bottom is less than offset | `Number` | `300` |
| loading-text | Loading text | `String` | `Loading...` |
| finished-text | Finished text | `String` | - |
| error-text | Error loaded text | `String` | - |
| immediate-check | Whether to check loading position immediately after mounted | `Boolean` | `true` |
| direction | Scroll direction，can be set to `up` | `String` | `down` |
| 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

@ -137,15 +137,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` | - | 1.5.3 |
| immediate-check | 是否在初始化时立即执行滚动位置检查 | `Boolean` | `true` | - |
| direction | 滚动触发加载的方向，可选值为`up` | `String` | `down` | 1.6.16 |
| 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` | - | 1.5.3 |
| immediate-check | 是否在初始化时立即执行滚动位置检查 | `boolean` | `true` | - |
| direction | 滚动触发加载的方向，可选值为`up` | `string` | `down` | 1.6.16 |
### Events

10
src/loading/README.md
View File

@ -42,11 +42,11 @@ Vue.use(Loading);
| Attribute | Description | Type | Default |
|------|------|------|------|
| color | Loading color | `String` | `#c9c9c9` | |
| type | Can be set to `spinner` | `String` | `circular` |
| size | Icon size | `String | Number` | `30px` |
| text-size | Text font size | `String | Number` | `14px` |
| vertical | Whether to arrange icons and text content vertically | `Boolean` | `false` |
| 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

@ -42,11 +42,11 @@ Vue.use(Loading);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| color | 颜色 | `String` | `#c9c9c9` | - |
| type | 类型，可选值为 `spinner` | `String` | `circular` | - |
| size | 加载图标大小，默认单位为`px` | `String | Number` | `30px` | - |
| text-size | 文字大小，默认单位为`px` | `String | Number` | `14px` | 2.0.0 |
| vertical | 是否垂直排列图标和文字内容 | `Boolean` | `false` | 2.0.0 |
| color | 颜色 | `string` | `#c9c9c9` | - |
| type | 类型，可选值为 `spinner` | `string` | `circular` | - |
| size | 加载图标大小，默认单位为`px` | `string | number` | `30px` | - |
| text-size | 文字大小，默认单位为`px` | `string | number` | `14px` | 2.0.0 |
| vertical | 是否垂直排列图标和文字内容 | `boolean` | `false` | 2.0.0 |
### Slots

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

@ -50,13 +50,13 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| title | Title | `String` | `''` |
| left-text | Left Text | `String` | `''` |
| right-text | Right Text | `String` | `''` |
| left-arrow | Whether to show left arrow | `Boolean` | `false` |
| fixed | Whether to fixed top | `Boolean` | `false` |
| border | Whether to show bottom border | `Boolean` | `true` |
| z-index | Z-index | `Number` | `1` |
| 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

@ -52,13 +52,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

@ -65,15 +65,15 @@ Vue.use(NoticeBar);
| Attribute | Description | Type | Default |
|------|------|------|------|
| mode | Mode, can be set to `closeable` `link` | `String` | `''` |
| text | Notice text content | `String` | `''` | - |
| delay | Animation delay (s) | `Number` | `1` |
| speed | Scroll speed (px/s) | `Number` | `50` |
| scrollable | Whether to scroll content | `Boolean` | `true` |
| wrapable | Whether to enable text wrap | `Boolean` | `false` | - |
| left-icon | Left Icon | `String` | - |
| color | Text color | `String` | `#f60` |
| background | Background color | `String` | `#fff7cc` |
| 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

@ -73,15 +73,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` | 1.6.11 |
| 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` | 1.6.11 |
| left-icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | `string` | - | - |
| color | 文本颜色 | `string` | `#f60` | - |
| background | 滚动条背景 | `string` | `#fff7cc` | - |
### Events

10
src/notify/README.md
View File

@ -53,11 +53,11 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| 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 | `String | Array | Object` | - |
| 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 | `string | Array | object` | - |
| onClick | Callback function after click | `Function` | - |
| onOpened | Callback function after opened | `Function` | - |
| onClose | Callback function after close | `Function` | - |

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

@ -53,11 +53,11 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| message | 展示文案，支持通过`\n`换行 | `String` | - | - |
| duration | 展示时长(ms)，值为 0 时，notify 不会消失 | `Number` | `3000` | - |
| color | 字体颜色 | `String` | `#fff` | - |
| background | 背景颜色 | `String` | `#f44` | - |
| className | 自定义类名 | `String | Array | Object` | - | 1.6.0 |
| message | 展示文案，支持通过`\n`换行 | `string` | - | - |
| duration | 展示时长(ms)，值为 0 时，notify 不会消失 | `number` | `3000` | - |
| color | 字体颜色 | `string` | `#fff` | - |
| background | 背景颜色 | `string` | `#f44` | - |
| className | 自定义类名 | `string | Array | object` | - | 1.6.0 |
| onClick | 点击时的回调函数 | `Function` | - | 2.0.0 |
| onOpened | 完全展示后的回调函数 | `Function` | - | 2.0.0 |
| onClose | 关闭时的回调函数 | `Function` | - | 2.0.0 |

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

@ -94,19 +94,19 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current value | `String` | - |
| show | Whether to show keyboard | `Boolean` | - |
| theme | Keyboard theme，can be set to `default` `custom` | `String` | `default` |
| title | Keyboard title | `String` | - |
| maxlength | Value maxlength | `Number | String` | - |
| 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` | - |
| 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` | - |
| 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

@ -97,19 +97,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` | 1.6.15 |
| 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` | 1.6.15 |
### Events

8
src/overlay/README.md
View File

@ -41,10 +41,10 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| 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 | `number | string` | `1` |
| duration | Animation duration | `number | string` | `0.3` |
| class-name | ClassName | `string` | - |
### Events

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

@ -45,10 +45,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 层级 | `number | string` | `1` | - |
| duration | 动画时长，单位秒 | `number | string` | `0.3` | - |
| class-name | 自定义类名 | `string` | - | - |
### Events

18
src/pagination/README.md
View File

@ -57,15 +57,15 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current page number | `Number` | - |
| mode | Mode, can be set to `simple` `multi` | `String` | `multi` |
| total-items | Total items | `Number` | `0` |
| items-per-page | Item number per page | `Number` | `10` |
| page-count | The total number of pages, if not set, will be calculated based on `total-items` and `items-per-page` | `Number` | `-` |
| prev-text | Previous text | `String` | `Previous` |
| next-text | Next text | `String` | `Next` |
| show-page-size | Count of page size to show | `Number` | `5` |
| force-ellipses | Whether to show ellipses | `Boolean` | `false` |
| 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

@ -58,15 +58,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

@ -36,10 +36,10 @@ Vue.use(Panel);
| Attribute | Description | Type | Default |
|------|------|------|------|
| 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

@ -40,10 +40,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

@ -80,12 +80,12 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| 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 | `number | string` | `0` |
### Events

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

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

20
src/picker/README.md
View File

@ -186,16 +186,16 @@ When Picker columns data is acquired asynchronously, use `loading` prop to show
| Attribute | Description | Type | Default |
|------|------|------|------|
| columns | Columns data | `Array` | `[]` |
| 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` |
| 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
Picker events will pass different parameters according to the columns are single or multiple

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

@ -194,16 +194,16 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| columns | 对象数组，配置每一列显示的数据 | `Array` | `[]` | - |
| show-toolbar | 是否显示顶部栏 | `Boolean` | `false` | - |
| toolbar-position | 顶部栏位置，可选值为`bottom` | `String` | `top` | 2.0.0 |
| 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` | 1.6.9 |
| show-toolbar | 是否显示顶部栏 | `boolean` | `false` | - |
| toolbar-position | 顶部栏位置，可选值为`bottom` | `string` | `top` | 2.0.0 |
| 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` | 1.6.9 |
### Events

24
src/popup/README.md
View File

@ -99,18 +99,18 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Whether to show popup | `Boolean` | `false` |
| overlay | Whether to show overlay | `Boolean` | `true` |
| position | Can be set to `top` `bottom` `right` `left` | `String` | `center` |
| overlay-class | Custom overlay class | `String` | - |
| overlay-style | Custom overlay style | `Object` | - |
| duration | Transition duration, unit second | `Number` | `0.3` |
| round | Whether to show round corner | `Boolean` | `false` |
| lock-scroll | Whether to lock background scroll | `Boolean` | `true` |
| lazy-render | Whether to lazy render util appeared | `Boolean` | `true` |
| close-on-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` |
| 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

@ -108,18 +108,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` | 2.0.0 |
| 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` | 2.0.0 |
| 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

@ -57,10 +57,10 @@ Use `pivot-text` to custom text，use `color` to custom bar color
| Attribute | Description | Type | Default |
|------|------|------|------|
| 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

@ -55,10 +55,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

@ -47,15 +47,15 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Loading status | `Boolean` | - |
| pulling-text | Text to show when pulling | `String` | `Pull to refresh...` |
| loosing-text | Text to show when loosing | `String` | `Loose to refresh...` |
| loading-text | Text to show when loading | `String` | `Loading...` |
| success-text | Text to show when loading success | `String` | - |
| success-duration | Success text display duration(ms) | `Number` | `500` |
| animation-duration | Animation duration | `Number` | `300` |
| head-height | 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

@ -47,15 +47,15 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 是否在加载中 | `Boolean` | - | - |
| pulling-text | 下拉过程文案 | `String` | `下拉即可刷新...` | - |
| loosing-text | 释放过程文案 | `String` | `释放即可刷新...` | - |
| loading-text | 加载过程文案 | `String` | `加载中...` | - |
| success-text | 加载成功提示文案 | `String` | - | 1.6.2 |
| success-duration | 加载成功提示时长(ms) | `Number` | `500` | 1.6.2 |
| 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` | - | 1.6.2 |
| success-duration | 加载成功提示时长(ms) | `number` | `500` | 1.6.2 |
| animation-duration | 动画时长 | `number` | `300` | - |
| head-height | 顶部内容高度 | `number` | `50` | - |
| disabled | 是否禁用下拉刷新 | `boolean` | `false` | - |
### Events

14
src/radio/README.md
View File

@ -109,19 +109,19 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| 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` | - |
| 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 |
|------|------|------|------|
| v-model | Name of checked radio | `any` | - |
| disabled | Diable all radios | `Boolean` | `false` |
| disabled | Diable all radios | `boolean` | `false` |
### Radio Events

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

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

24
src/rate/README.md
View File

@ -93,18 +93,18 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current rate | `Number` | - |
| count | Count | `Number` | `5` |
| size | Icon size| `String | Number` | `20px` |
| gutter | Icon gutter | `String | Number` | `4px` |
| color | Selected color | `String` | `#ffd21e` |
| void-color | Void color | `String` | `#c7c7c7` |
| 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

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

22
src/search/README.md
View File

@ -67,17 +67,17 @@ Search support all native properties of input tag，such as `maxlength`、`place
| Attribute | Description | Type | Default |
|------|------|------|------|
| 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

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

8
src/sidebar/README.md
View File

@ -47,7 +47,7 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Index of chosen item | `String | Number` | `0` |
| v-model | Index of chosen item | `string | number` | `0` |
### Sidebar Events
@ -59,9 +59,9 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| title | Content | `String` | `''` |
| info | Info Message | `String | Number` | `''` |
| url | Link | `String` | - |
| title | Content | `string` | `''` |
| info | Info Message | `string | number` | `''` |
| url | Link | `string` | - |
### SidebarItem Events

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

@ -51,7 +51,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 当前导航项的索引 | `String | Number` | `0` | 2.0.4 |
| v-model | 当前导航项的索引 | `string | number` | `0` | 2.0.4 |
### Sidebar Events
@ -63,11 +63,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

@ -54,12 +54,12 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| row | Row count | `Number` | `0` |
| row-width | Row width, can be array | `Number | String | Array` | `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 | Array` | `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` |

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

@ -60,12 +60,12 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| row | 段落占位图行数 | `Number` | `0` | - |
| row-width | 段落占位图宽度，可传数组来设置每一行的宽度 | `Number | String | Array` | `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 | Array` | `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` | - |

46
src/sku/README.md
View File

@ -117,36 +117,36 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Whether to show sku | `Boolean` | `false` |
| sku | Sku data | `Object` | - |
| goods | Goods info | `Object` | - |
| goods-id | Goods id | `String | Number` | - |
| hide-stock | Whether to hide stock | `Boolean` | `false` |
| hide-quota-text | Whether to hide quota 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` | - |
| hide-stock | Whether to hide stock | `boolean` | `false` |
| hide-quota-text | Whether to hide quota 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
| Event | Description | Arguments |
|------|------|------|
| add-cart | Triggered when click cart button | data: Object |
| buy-clicked | Triggered when click buy button | data: Object |
| add-cart | Triggered when click cart button | data: object |
| buy-clicked | Triggered when click buy button | data: object |
| stepper-change | Triggered when stepper value changed | value: number |
| sku-selected | Triggered when select sku | { skuValue, selectedSku, selectedSkuComb } |
| open-preview | Triggered when open image preview | data: Object |
| close-preview | Triggered when close image preview | data: Object |
| open-preview | Triggered when open image preview | data: object |
| close-preview | Triggered when close image preview | data: object |
### Methods

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

@ -119,38 +119,38 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 是否显示sku | `Boolean` | `false` | - |
| sku | 商品sku数据 | `Object` | - | - |
| goods | 商品信息 | `Object` | - | - |
| goods-id | 商品 id | `String | Number` | - | - |
| hide-stock | 是否显示商品剩余库存 | `Boolean` | `false` | - |
| hide-quota-text | 是否显示限购提示 | `Boolean` | `false` | 1.4.8 |
| 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` | - | - |
| hide-stock | 是否显示商品剩余库存 | `boolean` | `false` | - |
| hide-quota-text | 是否显示限购提示 | `boolean` | `false` | 1.4.8 |
| 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
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| add-cart | 点击添加购物车回调 | skuData: Object |
| buy-clicked | 点击购买回调 | skuData: Object |
| add-cart | 点击添加购物车回调 | skuData: object |
| buy-clicked | 点击购买回调 | skuData: object |
| stepper-change | 购买数量变化时触发 | value: number |
| sku-selected | 切换规格类目时触发 | { skuValue, selectedSku, selectedSkuComb } |
| open-preview | 打开商品图片预览时触发 | data: Object |
| close-preview | 关闭商品图片预览时触发 | data: Object |
| open-preview | 打开商品图片预览时触发 | data: object |
| close-preview | 关闭商品图片预览时触发 | data: object |
### 方法

18
src/slider/README.md
View File

@ -90,15 +90,15 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|------|
| 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 | `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` |
### Events

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

@ -92,15 +92,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` | 1.5.1 |
| inactive-color | 进度条默认颜色 | `String` | `#e5e5e5` | 1.5.1 |
| vertical | 是否垂直展示 | `Boolean` | `false` | 1.6.13 |
| 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` | 1.5.1 |
| inactive-color | 进度条默认颜色 | `string` | `#e5e5e5` | 1.5.1 |
| vertical | 是否垂直展示 | `boolean` | `false` | 1.6.13 |
### Events

20
src/stepper/README.md
View File

@ -97,16 +97,16 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current value | `String | Number` | Min value |
| min | Min value | `String | Number` | `1` |
| max | Max value | `String | Number` | - |
| step | Value change step | `String | Number` | `1` |
| integer | Whether to allow only integers | `Boolean` | `false` |
| disabled | Disable value change | `Boolean` | `false` |
| disable-input | Disable input | `Boolean` | `false` |
| async-change | Whether to enable async change | `Boolean` | `false` | - |
| input-width | Input width | `String | Number` | `32px` |
| button-size | Button size | `String | Number` | `28px` |
| v-model | Current value | `string | number` | Min value |
| min | Min value | `string | number` | `1` |
| max | Max value | `string | number` | - |
| step | Value change step | `string | number` | `1` |
| integer | Whether to allow only integers | `boolean` | `false` |
| disabled | Disable value change | `boolean` | `false` |
| disable-input | Disable input | `boolean` | `false` |
| async-change | Whether to enable async change | `boolean` | `false` | - |
| input-width | Input width | `string | number` | `32px` |
| button-size | Button size | `string | number` | `28px` |
### Events

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

@ -101,16 +101,16 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 当前输入值 | `String | Number` | 最小值 | - |
| min | 最小值 | `String | Number` | `1` | - |
| max | 最大值 | `String | Number` | - | - |
| step | 步数 | `String | Number` | `1` | - |
| integer | 是否只允许输入整数 | `Boolean` | `false` | - |
| disabled | 是否禁用步进器 | `Boolean` | `false` | - |
| disable-input | 是否禁用输入框 | `Boolean` | `false` | - |
| async-change | 是否开启异步变更，开启后需要手动控制输入值 | `Boolean` | `false` | - |
| input-width | 输入框宽度，默认单位为`px` | `String | Number` | `32px` | 1.6.13 |
| button-size | 按钮大小，默认单位为`px`，输入框高度会和按钮大小保持一致 | `String | Number` | `28px` | 2.0.5 |
| v-model | 当前输入值 | `string | number` | 最小值 | - |
| min | 最小值 | `string | number` | `1` | - |
| max | 最大值 | `string | number` | - | - |
| step | 步数 | `string | number` | `1` | - |
| integer | 是否只允许输入整数 | `boolean` | `false` | - |
| disabled | 是否禁用步进器 | `boolean` | `false` | - |
| disable-input | 是否禁用输入框 | `boolean` | `false` | - |
| async-change | 是否开启异步变更，开启后需要手动控制输入值 | `boolean` | `false` | - |
| input-width | 输入框宽度，默认单位为`px` | `string | number` | `32px` | 1.6.13 |
| button-size | 按钮大小，默认单位为`px`，输入框高度会和按钮大小保持一致 | `string | number` | `28px` | 2.0.5 |
### Events

12
src/steps/README.md
View File

@ -71,12 +71,12 @@ export default {
| Attribute | Description | Type | Default |
|------|------|------|------|
| active | Active step | `Number` | 0 |
| description | Description | `String` | - |
| direction | Can be set to `vertical` | `String` | `horizontal` |
| active-color | Active step color | `String` | `#07c160` |
| active-icon | Active icon name | `String` | `checked` |
| inactive-icon | Active icon name | `String` | - |
| active | Active step | `number` | 0 |
| description | Description | `string` | - |
| direction | Can be set to `vertical` | `string` | `horizontal` |
| active-color | Active step color | `string` | `#07c160` |
| active-icon | Active icon name | `string` | `checked` |
| inactive-icon | Active icon name | `string` | - |
### Step Slots

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

@ -75,11 +75,11 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| active | 当前步骤 | `Number` | 0 | - |
| direction | 显示方向，可选值为 `vertical` | `String` | `horizontal` | - |
| active-color | 激活状态颜色 | `String` | `#07c160` | - |
| active-icon | 激活状态底部图标，可选值见 Icon 组件 | `String` | `checked` | 1.6.9 |
| inactive-icon | 未激活状态底部图标，可选值见 Icon 组件 | `String` | - | 2.0.0 |
| active | 当前步骤 | `number` | 0 | - |
| direction | 显示方向，可选值为 `vertical` | `string` | `horizontal` | - |
| active-color | 激活状态颜色 | `string` | `#07c160` | - |
| active-icon | 激活状态底部图标，可选值见 Icon 组件 | `string` | `checked` | 1.6.9 |
| inactive-icon | 未激活状态底部图标，可选值见 Icon 组件 | `string` | - | 2.0.0 |
### Step Slots

24
src/submit-bar/README.md
View File

@ -71,18 +71,18 @@ Use slot to add custom contents.
| Attribute | Description | Type | Default |
|------|------|------|------|
| price | Price | `Number` | - |
| label | Price left label | `String` | `Total：` |
| suffix-label | Price right label | `String` | - |
| button-text | Button text | `String` | - |
| button-type | Button type | `String` | `danger` |
| tip | Tip | `String` | - |
| tip-icon | Icon | `String` | - |
| disabled | Whether to disable button | `Boolean` | `false` |
| loading | Whether to show loading icon | `Boolean` | `false` |
| currency | Currency symbol | `String` | `¥` |
| decimal-length | Number of digits to appear after the decimal point | `Number` | `2` |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation, to enable those features use `viewport-fit=cover` in the `viewport` meta tag | `Boolean` | `false` |
| price | Price | `number` | - |
| label | Price left label | `string` | `Total：` |
| suffix-label | Price right label | `string` | - |
| button-text | Button text | `string` | - |
| button-type | Button type | `string` | `danger` |
| tip | Tip | `string` | - |
| tip-icon | Icon | `string` | - |
| disabled | Whether to disable button | `boolean` | `false` |
| loading | Whether to show loading icon | `boolean` | `false` |
| currency | Currency symbol | `string` | `¥` |
| decimal-length | number of digits to appear after the decimal point | `number` | `2` |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation, to enable those features use `viewport-fit=cover` in the `viewport` meta tag | `boolean` | `false` |
### Events

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

@ -71,18 +71,18 @@ Vue.use(SubmitBar);
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| price | 价格（单位分） | `Number` | - | - |
| label | 价格左侧文案 | `String` | `合计：` | - |
| suffix-label | 价格右侧文案 | `String` | - | 2.0.0 |
| button-text | 按钮文字 | `String` | - | - |
| button-type | 按钮类型 | `String` | `danger` | - |
| tip | 提示文案 | `String` | - | - |
| tip-icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | `String` | - | - |
| disabled | 是否禁用按钮 | `Boolean` | `false` | - |
| loading | 是否显示加载中的按钮 | `Boolean` | `false` | - |
| currency | 货币符号 | `String` | `¥` | - |
| decimal-length | 价格小数点后位数 | `Number` | `2` | 1.6.15 |
| safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `Boolean` | `false` | 1.6.15 |
| price | 价格（单位分） | `number` | - | - |
| label | 价格左侧文案 | `string` | `合计：` | - |
| suffix-label | 价格右侧文案 | `string` | - | 2.0.0 |
| button-text | 按钮文字 | `string` | - | - |
| button-type | 按钮类型 | `string` | `danger` | - |
| tip | 提示文案 | `string` | - | - |
| tip-icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | `string` | - | - |
| disabled | 是否禁用按钮 | `boolean` | `false` | - |
| loading | 是否显示加载中的按钮 | `boolean` | `false` | - |
| currency | 货币符号 | `string` | `¥` | - |
| decimal-length | 价格小数点后位数 | `number` | `2` | 1.6.15 |
| safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `boolean` | `false` | 1.6.15 |
### Events

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