From b39853f1bc15551e4d98838c4984bb14c05a6a3e Mon Sep 17 00:00:00 2001 From: neverland Date: Sat, 5 May 2018 09:47:19 +0800 Subject: [PATCH] [Doc] remove Accepted Values (#990) --- docs/demos/views/tag.vue | 2 +- docs/markdown/en-US/actionsheet.md | 16 ++++----- docs/markdown/en-US/address-edit.md | 24 ++++++------- docs/markdown/en-US/address-list.md | 10 +++--- docs/markdown/en-US/area.md | 18 +++++----- docs/markdown/en-US/badge.md | 16 ++++----- docs/markdown/en-US/card.md | 18 +++++----- docs/markdown/en-US/cell-swipe.md | 10 +++--- docs/markdown/en-US/cell.md | 34 +++++++++--------- docs/markdown/en-US/circle.md | 24 ++++++------- docs/markdown/en-US/collapse.md | 16 ++++----- docs/markdown/en-US/contact.md | 20 +++++------ docs/markdown/en-US/coupon.md | 40 ++++++++++----------- docs/markdown/en-US/dialog.md | 52 +++++++++++++-------------- docs/markdown/en-US/goods-action.md | 32 ++++++++--------- docs/markdown/en-US/icon.md | 8 ++--- docs/markdown/en-US/layout.md | 16 +++++---- docs/markdown/en-US/lazyload.md | 20 +++++------ docs/markdown/en-US/list.md | 14 ++++---- docs/markdown/en-US/nav-bar.md | 17 ++++----- docs/markdown/en-US/pagination.md | 2 +- docs/markdown/en-US/panel.md | 10 +++--- docs/markdown/en-US/password-input.md | 12 +++---- docs/markdown/en-US/picker.md | 22 ++++++------ docs/markdown/en-US/progress.md | 16 ++++----- docs/markdown/en-US/pull-refresh.md | 16 ++++----- docs/markdown/en-US/radio.md | 16 ++++----- docs/markdown/en-US/search.md | 10 +++--- docs/markdown/en-US/sku.md | 36 +++++++++---------- docs/markdown/en-US/submit-bar.md | 20 +++++------ docs/markdown/en-US/swipe.md | 18 +++++----- docs/markdown/en-US/switch-cell.md | 12 +++---- docs/markdown/en-US/switch.md | 12 +++---- docs/markdown/en-US/tabbar.md | 22 ++++++------ docs/markdown/en-US/tag.md | 10 +++--- docs/markdown/en-US/toast.md | 16 ++++----- docs/markdown/en-US/tree-select.md | 10 +++--- docs/markdown/en-US/uploader.md | 16 ++++----- docs/markdown/en-US/waterfall.md | 12 +++---- docs/markdown/zh-CN/actionsheet.md | 16 ++++----- docs/markdown/zh-CN/address-edit.md | 24 ++++++------- docs/markdown/zh-CN/address-list.md | 10 +++--- docs/markdown/zh-CN/area.md | 18 +++++----- docs/markdown/zh-CN/badge.md | 16 ++++----- docs/markdown/zh-CN/card.md | 18 +++++----- docs/markdown/zh-CN/cell-swipe.md | 10 +++--- docs/markdown/zh-CN/cell.md | 34 +++++++++--------- docs/markdown/zh-CN/circle.md | 24 ++++++------- docs/markdown/zh-CN/collapse.md | 12 +++---- docs/markdown/zh-CN/contact.md | 20 +++++------ docs/markdown/zh-CN/coupon.md | 44 +++++++++++------------ docs/markdown/zh-CN/dialog.md | 50 +++++++++++++------------- docs/markdown/zh-CN/field.md | 2 +- docs/markdown/zh-CN/goods-action.md | 32 ++++++++--------- docs/markdown/zh-CN/icon.md | 8 ++--- docs/markdown/zh-CN/layout.md | 16 +++++---- docs/markdown/zh-CN/lazyload.md | 20 +++++------ docs/markdown/zh-CN/list.md | 14 ++++---- docs/markdown/zh-CN/nav-bar.md | 17 ++++----- docs/markdown/zh-CN/panel.md | 10 +++--- docs/markdown/zh-CN/password-input.md | 12 +++---- docs/markdown/zh-CN/picker.md | 22 ++++++------ docs/markdown/zh-CN/progress.md | 16 ++++----- docs/markdown/zh-CN/pull-refresh.md | 16 ++++----- docs/markdown/zh-CN/radio.md | 16 ++++----- docs/markdown/zh-CN/search.md | 8 ++--- docs/markdown/zh-CN/sku.md | 36 +++++++++---------- docs/markdown/zh-CN/submit-bar.md | 20 +++++------ docs/markdown/zh-CN/swipe.md | 18 +++++----- docs/markdown/zh-CN/switch-cell.md | 12 +++---- docs/markdown/zh-CN/switch.md | 12 +++---- docs/markdown/zh-CN/tabbar.md | 22 ++++++------ docs/markdown/zh-CN/tag.md | 16 ++++----- docs/markdown/zh-CN/toast.md | 14 ++++---- docs/markdown/zh-CN/tree-select.md | 11 +++--- docs/markdown/zh-CN/uploader.md | 16 ++++----- docs/markdown/zh-CN/waterfall.md | 12 +++---- 77 files changed, 698 insertions(+), 691 deletions(-) diff --git a/docs/demos/views/tag.vue b/docs/demos/views/tag.vue index 85999b0ff..0f98fa363 100644 --- a/docs/demos/views/tag.vue +++ b/docs/demos/views/tag.vue @@ -28,7 +28,7 @@ export default { i18n: { 'zh-CN': { title2: '空心样式', - title3: '标记样式' + title3: '圆角样式' }, 'en-US': { title2: 'Plain style', diff --git a/docs/markdown/en-US/actionsheet.md b/docs/markdown/en-US/actionsheet.md index 5654dec23..710dd2b3b 100644 --- a/docs/markdown/en-US/actionsheet.md +++ b/docs/markdown/en-US/actionsheet.md @@ -63,14 +63,14 @@ Actionsheet will get another style if there is a `title` prop. ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| actions | Options | `Array` | `[]` | - | -| title | Title | `String` | - | - | -| cancel-text | Text of cancel button | `String` | - | - | -| overlay | Whether to show overlay | `Boolean` | - | - | -| close-on-click-overlay | Whether to close when click overlay | `Boolean` | - | - | -| get-container | Return the mount node for actionsheet | `Function` | - | `() => HTMLElement` | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| actions | Options | `Array` | `[]` | +| title | Title | `String` | - | +| cancel-text | Text of cancel button | `String` | - | +| overlay | Whether to show overlay | `Boolean` | - | +| close-on-click-overlay | Whether to close when click overlay | `Boolean` | - | +| get-container | Return the mount node for actionsheet | `() => HTMLElement` | - | ### Event diff --git a/docs/markdown/en-US/address-edit.md b/docs/markdown/en-US/address-edit.md index 4efb6bc49..ad64e3dcd 100644 --- a/docs/markdown/en-US/address-edit.md +++ b/docs/markdown/en-US/address-edit.md @@ -59,18 +59,18 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| 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` | - | -| 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` | - | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| 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` | +| 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` | - | ### Event diff --git a/docs/markdown/en-US/address-list.md b/docs/markdown/en-US/address-list.md index fca849074..4846ae3d6 100644 --- a/docs/markdown/en-US/address-list.md +++ b/docs/markdown/en-US/address-list.md @@ -55,11 +55,11 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-model | Id of chosen address | String | - | - | -| list | Address list | Array | `[]` | - | -| add-button-text | Add button text | String | `Add new address` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| v-model | Id of chosen address | String | - | +| list | Address list | Array | `[]` | +| add-button-text | Add button text | String | `Add new address` | ### Event diff --git a/docs/markdown/en-US/area.md b/docs/markdown/en-US/area.md index 18f986695..7bc1185d8 100644 --- a/docs/markdown/en-US/area.md +++ b/docs/markdown/en-US/area.md @@ -39,15 +39,15 @@ Set `columns-num` with 2, you'll have a 2 level picker. ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| value | the `code` of selected area | `String` | - | - | -| title | Toolbar title | `String` | `''` | - | -| area-list | an object contains these properties: `province_list`, `city_list` and `county_list` | `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` | - | +| 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` | ### Event diff --git a/docs/markdown/en-US/badge.md b/docs/markdown/en-US/badge.md index f40989f2c..e7c2833c8 100644 --- a/docs/markdown/en-US/badge.md +++ b/docs/markdown/en-US/badge.md @@ -39,13 +39,13 @@ export default { ### BadgeGroup API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| active-key | Index of chosen badge | `String | Number` | `0` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| active-key | Index of chosen badge | `String | Number` | `0` | ### Badge API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| title | Content | `String` | `''` | - | -| info | Info Message | `String | Number` | `''` | - | -| url | Link | `String` | - | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| title | Content | `String` | `''` | +| info | Info Message | `String | Number` | `''` | +| url | Link | `String` | - | diff --git a/docs/markdown/en-US/card.md b/docs/markdown/en-US/card.md index 7b3785c7b..ab62999b6 100644 --- a/docs/markdown/en-US/card.md +++ b/docs/markdown/en-US/card.md @@ -41,15 +41,15 @@ Use `slot` to custom content. ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| thumb | Left thumb | `String` | - | - | -| title | Title | `String` | - | - | -| desc | Description | `String` | - | - | -| num | Number of goods | `String | Number` | - | - | -| price | Price of goods | `String | Number` | - | - | -| centered | Whether content vertical centered | `String` | `false` | - | -| currency | Currency symbol | `String` | `¥` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| thumb | Left thumb | `String` | - | +| title | Title | `String` | - | +| desc | Description | `String` | - | +| num | Number of goods | `String | Number` | - | +| price | Price of goods | `String | Number` | - | +| centered | Whether content vertical centered | `String` | `false` | +| currency | Currency symbol | `String` | `¥` | ### Slot diff --git a/docs/markdown/en-US/cell-swipe.md b/docs/markdown/en-US/cell-swipe.md index 0d330774f..31cc1b3ef 100644 --- a/docs/markdown/en-US/cell-swipe.md +++ b/docs/markdown/en-US/cell-swipe.md @@ -58,11 +58,11 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| left-width | Width of the left scrollable area | `Number` | `0` | - | -| right-width | Width of the right scrollable area | `Number` | `0` | - | -| on-close | Callback function before close | `Function` | - | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| left-width | Width of the left scrollable area | `Number` | `0` | +| right-width | Width of the right scrollable area | `Number` | `0` | +| on-close | Callback function before close | `Function` | - | ### Slot diff --git a/docs/markdown/en-US/cell.md b/docs/markdown/en-US/cell.md index 337adc401..cf932c5b3 100644 --- a/docs/markdown/en-US/cell.md +++ b/docs/markdown/en-US/cell.md @@ -62,26 +62,26 @@ Vue.use(Cell).use(CellGroup); ### CellGroup API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| border | Whether to show outer border | `Boolean` | `true` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| border | Whether to show outer border | `Boolean` | `true` | ### Cell API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| icon | Left Icon | `String` | - | - | -| title | Title | `String` | - | - | -| value | Right text | `String` | - | - | -| label | Description below the title | `String` | - | - | -| border | Whether to show inner border | `Boolean` | `true` | - | -| center | Whether to center content vertically | `Boolean` | `true` | - | -| 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 | `String` | `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` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| icon | Left Icon | `String` | - | +| title | Title | `String` | - | +| value | Right text | `String` | - | +| label | Description below the title | `String` | - | +| border | Whether to show inner border | `Boolean` | `true` | +| center | Whether to center content vertically | `Boolean` | `true` | +| 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 | `String` | `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` | ### Cell Event diff --git a/docs/markdown/en-US/circle.md b/docs/markdown/en-US/circle.md index 263faf5ef..9dec3de32 100644 --- a/docs/markdown/en-US/circle.md +++ b/docs/markdown/en-US/circle.md @@ -55,18 +55,18 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-model | Current rate | `Number` | - | - | -| rate | Target rate | `Number` | `100` | - | -| size | Circle size | `String` | `100px` | - | -| color | Progress bar color | `String` | `#38f` | - | -| layer-color | Layer color | `String` | `#fff` | - | -| fill | Fill color | `String` | `none` | - | -| speed | Animate speed（rate/s）| `Number` | - | - | -| text | Text | `String` | - | - | -| stroke-width | Stroke width | `Number` | `40` | - | -| clockwise | Is clockwise | `Boolean` | `true` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| v-model | Current rate | `Number` | - | +| rate | Target rate | `Number` | `100` | +| size | Circle size | `String` | `100px` | +| color | Progress bar color | `String` | `#38f` | +| layer-color | Layer color | `String` | `#fff` | +| fill | Fill color | `String` | `none` | +| speed | Animate speed（rate/s）| `Number` | - | +| text | Text | `String` | - | +| stroke-width | Stroke width | `Number` | `40` | +| clockwise | Is clockwise | `Boolean` | `true` | ### Cell Slot diff --git a/docs/markdown/en-US/collapse.md b/docs/markdown/en-US/collapse.md index b6b1123a8..635689af0 100644 --- a/docs/markdown/en-US/collapse.md +++ b/docs/markdown/en-US/collapse.md @@ -69,10 +69,10 @@ export default { ### Collapse API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-model | names of current active panels | `Array | String | Number` | - | - | -| accordion | Whether to be accordion mode | `Boolean` | `false` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| v-model | names of current active panels | `Array | String | Number` | - | +| accordion | Whether to be accordion mode | `Boolean` | `false` | ### Collapse Event @@ -82,10 +82,10 @@ export default { ### CollapseItem API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| name | Name | `String | Number` | `index` | - | -| title | Title | `String` | - | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| name | Name | `String | Number` | `index` | +| title | Title | `String` | - | ### CollapseItem Slot diff --git a/docs/markdown/en-US/contact.md b/docs/markdown/en-US/contact.md index dedabda9e..f6e769a27 100644 --- a/docs/markdown/en-US/contact.md +++ b/docs/markdown/en-US/contact.md @@ -140,11 +140,11 @@ export default { | add-text | Add card text | `String` | `Add contact info` | - | ### ContactList API -| Attribute | Description | Type | Default | Accepted Values | +| Attribute | Description | Type | Default | |-----------|-----------|-----------|-------------|-------------| -| v-model | Id of chosen contact | `String | Number` | - | - | -| list | Contact list | `Array` | `[]` | - | -| add-text | Add button text | `String` | `Add new contact` | - | +| v-model | Id of chosen contact | `String | Number` | - | +| list | Contact list | `Array` | `[]` | +| add-text | Add button text | `String` | `Add new contact` | ### ContactList Event @@ -155,13 +155,13 @@ export default { | select | Triggered when select contact | item: contact object | ### ContactEdit API -| Attribute | Description | Type | Default | Accepted Values | +| Attribute | Description | Type | Default | |-----------|-----------|-----------|-------------|-------------| -| contact-info | Contact Info | `Object` | `[]` | - | -| is-edit | Whether is editing | `Boolean` | `false` | - | -| is-saving | Whether to show save button loading status | `Boolean` | `false` | - | -| is-deleting | Whether to show delete button loading status | `Boolean` | `false` | - | -| tel-validator | The method to validate tel | `(tel: string) => boolean` | - | - | +| 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 Event diff --git a/docs/markdown/en-US/coupon.md b/docs/markdown/en-US/coupon.md index ae927e837..479de4261 100644 --- a/docs/markdown/en-US/coupon.md +++ b/docs/markdown/en-US/coupon.md @@ -67,29 +67,29 @@ export default { ### CouponCell API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| title | Cell title | `String` | `Coupon` | - | -| chosen-coupon | Index of chosen coupon | `Number` | `-1` | - | -| coupons | Coupon list | `Array` | `[]` | - | -| editable | Cell editable | `Boolean` | `true` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| title | Cell title | `String` | `Coupon` | +| chosen-coupon | Index of chosen coupon | `Number` | `-1` | +| coupons | Coupon list | `Array` | `[]` | +| editable | Cell editable | `Boolean` | `true` | ### CouponList API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-model | Current exchange code | `String` | - | - | -| chosen-coupon | Index of chosen coupon | `Number` | `-1` | - | -| coupons | Coupon list | `Array` | `[]` | - | -| disabled-coupons | Disabled voupon list | `Array` | `[]` | - | -| 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` | - | -| disabled-list-title | Disabled list title | `String` | `Unavailable` | - | -| input-placeholder | Input placeholder | `String` | `Coupon code` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| v-model | Current exchange code | `String` | - | +| chosen-coupon | Index of chosen coupon | `Number` | `-1` | +| coupons | Coupon list | `Array` | `[]` | +| disabled-coupons | Disabled voupon list | `Array` | `[]` | +| 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` | +| disabled-list-title | Disabled list title | `String` | `Unavailable` | +| input-placeholder | Input placeholder | `String` | `Coupon code` | ### CouponList Event diff --git a/docs/markdown/en-US/dialog.md b/docs/markdown/en-US/dialog.md index f2b03d6eb..75985db75 100644 --- a/docs/markdown/en-US/dialog.md +++ b/docs/markdown/en-US/dialog.md @@ -66,18 +66,18 @@ export default { ### Options -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| title | Title | `String` | - | - | -| message | Message | `String` | - | - | -| showConfirmButton | Whether to show confirm button | `Boolean` | `true` | - | -| showCancelButton | Whether to show cancel button | `Boolean` | `false` | - | -| confirmButtonText | Confirm button text | `String` | `Confirm` | - | -| cancelButtonText | Cancel button test | `String` | `Cancel` | - | -| overlay | Whether to show overlay | `Boolean` | `true` | - | -| closeOnClickOverlay | Whether to close when click overlay | `Boolean` | `false` | - | -| lockScroll | Whether to lock body scroll | `Boolean` | `true` | - | -| beforeClose | Callback before close，call done to close dialog | (action: string, done: function) => void | - | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| title | Title | `String` | - | +| message | Message | `String` | - | +| showConfirmButton | Whether to show confirm button | `Boolean` | `true` | +| showCancelButton | Whether to show cancel button | `Boolean` | `false` | +| confirmButtonText | Confirm button text | `String` | `Confirm` | +| cancelButtonText | Cancel button test | `String` | `Cancel` | +| overlay | Whether to show overlay | `Boolean` | `true` | +| closeOnClickOverlay | Whether to close when click overlay | `Boolean` | `false` | +| lockScroll | Whether to lock body scroll | `Boolean` | `true` | +| beforeClose | Callback before close，call done to close dialog | (action: string, done: function) => void | - | #### Advanced Usage If you need to render vue components within a dialog, you can use dialog component. @@ -124,20 +124,20 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-model | Whether to show dialog | `Boolean` | - | - | -| title | Title | `String` | - | - | -| message | Message | `String` | - | - | -| async-confirm | Whether to close async，The incoming function is triggered when you click confirm. | `Function` | - | - | -| show-confirm-button | Whether to show confirm button | `Boolean` | `true` | - | -| show-cancel-button | Whether to show cancel button | `Boolean` | `false` | - | -| confirm-button-text | Confirm button text | `String` | `Confirm` | - | -| cancel-button-text | Cancel button test | `String` | `Cancel` | - | -| 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，call done to close dialog | (action: string, done: function) => void | - | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| v-model | Whether to show dialog | `Boolean` | - | +| title | Title | `String` | - | +| message | Message | `String` | - | +| async-confirm | Whether to close async，The incoming function is triggered when you click confirm. | `Function` | - | +| show-confirm-button | Whether to show confirm button | `Boolean` | `true` | +| show-cancel-button | Whether to show cancel button | `Boolean` | `false` | +| confirm-button-text | Confirm button text | `String` | `Confirm` | +| cancel-button-text | Cancel button test | `String` | `Cancel` | +| 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，call done to close dialog | (action: string, done: function) => void | - | ### Event diff --git a/docs/markdown/en-US/goods-action.md b/docs/markdown/en-US/goods-action.md index 508c7359e..07d49762d 100644 --- a/docs/markdown/en-US/goods-action.md +++ b/docs/markdown/en-US/goods-action.md @@ -56,23 +56,23 @@ Use `info` prop to show messages in upper right corner of icon #### GoodsActionMiniBtn -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| text | Button text | `String` | - | - | -| icon | Icon | `String` | - | - | -| icon-class | Icon class name | `String` | `''` | - | -| 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 | `String` | `false` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| text | Button text | `String` | - | +| icon | Icon | `String` | - | +| icon-class | Icon class name | `String` | `''` | +| 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 | `String` | `false` | #### GoodsActionBigBtn -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| text | Button text | `String` | - | - | -| primary | Is primary button (red color) | `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 | `String` | `false` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| text | Button text | `String` | - | +| primary | Is primary button (red color) | `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 | `String` | `false` | diff --git a/docs/markdown/en-US/icon.md b/docs/markdown/en-US/icon.md index a8819b142..bcec57b40 100644 --- a/docs/markdown/en-US/icon.md +++ b/docs/markdown/en-US/icon.md @@ -46,10 +46,10 @@ import 'vant/lib/vant-css/icon-local.css'; ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| name | Icon name | `String` | `''` | - | -| info | Info message | `String | Number` | `''` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| name | Icon name | `String` | `''` | +| info | Info message | `String | Number` | `''` | ### Event diff --git a/docs/markdown/en-US/layout.md b/docs/markdown/en-US/layout.md index 61a8b7c1e..c79f0bd80 100644 --- a/docs/markdown/en-US/layout.md +++ b/docs/markdown/en-US/layout.md @@ -52,12 +52,14 @@ Set grid spacing using `gutter` attribute. The default value is 0 ### API #### Row -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| gutter | grid spacing（px） | `String | Number` | - | - | + +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| gutter | grid spacing（px） | `String | Number` | - | #### Column -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| span | number of column the grid spans | `String | Number` | - | - | -| offset | number of spacing on the left side of the grid | `String | Number` | - | - | + +| 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` | - | diff --git a/docs/markdown/en-US/lazyload.md b/docs/markdown/en-US/lazyload.md index 2fcc20e01..699fd023f 100644 --- a/docs/markdown/en-US/lazyload.md +++ b/docs/markdown/en-US/lazyload.md @@ -47,15 +47,15 @@ Use `v-lazy:background-image` to set background url, and declare the height of t ### Options -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| 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` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| loading | Src of the image while loading | `String` | - | +| error | Src of the image upon load fail | `String` | - | +| preload | Proportion of pre-loading height | `String` | - | +| attempt | Attempts count | `Number` | `3` | +| listenEvents | Events that you want vue listen for | `Array` | `scroll`... | +| adapter | Dynamically modify the attribute of element | `Object` | - | +| filter | The image's listener filter | `Object` | - | +| lazyComponent | Lazyload component | `Boolean` | `false` | See more：[ vue-lazyload ](https://github.com/hilongjw/vue-lazyload) diff --git a/docs/markdown/en-US/list.md b/docs/markdown/en-US/list.md index a542aaa5b..bab76a33f 100644 --- a/docs/markdown/en-US/list.md +++ b/docs/markdown/en-US/list.md @@ -51,13 +51,13 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| loading | 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` | - | -| 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...` | - | -| immediate-check | Whether to check loading position immediately after mounted | `Boolean` | `true` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| loading | 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` | +| 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...` | +| immediate-check | Whether to check loading position immediately after mounted | `Boolean` | `true` | ### Event diff --git a/docs/markdown/en-US/nav-bar.md b/docs/markdown/en-US/nav-bar.md index 8721eaa6b..fd1a3cfe5 100644 --- a/docs/markdown/en-US/nav-bar.md +++ b/docs/markdown/en-US/nav-bar.md @@ -45,14 +45,15 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| 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` | - | -| z-index | Z-index | `Number` | `1` | - | + +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| title | Title | `String` | `''` | +| left-text | Left Text | `String` | `''` | +| right-text | Right Text | `String` | `''` | +| left-arrow | Whether to show left arrow | `Boolean` | `false` | +| fixed | Whether to fixed top | `Boolean` | `false` | +| z-index | Z-index | `Number` | `1` | ### Slot diff --git a/docs/markdown/en-US/pagination.md b/docs/markdown/en-US/pagination.md index e3a504162..332913ddc 100644 --- a/docs/markdown/en-US/pagination.md +++ b/docs/markdown/en-US/pagination.md @@ -55,7 +55,7 @@ export default { | Attribute | Description | Type | Default | Accepted Values | |-----------|-----------|-----------|-------------|-------------| | v-model | Current page number | `Number` | - | - | -| mode | Mode | `String` | `multi` | `simple` | +| mode | Mode | `String` | `multi` | `simple` | | items-per-page | Item number per page | `Number` | `10` | - | | prev-text | Previous text | `String` | `Previous` | - | | next-text | Next text | `String` | `Next` | - | diff --git a/docs/markdown/en-US/panel.md b/docs/markdown/en-US/panel.md index 5dd926927..b8f77e251 100644 --- a/docs/markdown/en-US/panel.md +++ b/docs/markdown/en-US/panel.md @@ -31,11 +31,11 @@ Vue.use(Panel); ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| title | Title | `String` | - | - | -| desc | Description | `String` | - | - | -| status | Status | `String` | - | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| title | Title | `String` | - | +| desc | Description | `String` | - | +| status | Status | `String` | - | ### Slot diff --git a/docs/markdown/en-US/password-input.md b/docs/markdown/en-US/password-input.md index 11fb365af..62f31d5ae 100644 --- a/docs/markdown/en-US/password-input.md +++ b/docs/markdown/en-US/password-input.md @@ -51,12 +51,12 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| value | Password value | `String` | `''` | - | -| length | Maxlength of password | `Number` | `6` | - | -| info | Bottom info | `String` | - | - | -| error-info | Bottom error info | `String` | - | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| value | Password value | `String` | `''` | +| length | Maxlength of password | `Number` | `6` | +| info | Bottom info | `String` | - | +| error-info | Bottom error info | `String` | - | ### Event diff --git a/docs/markdown/en-US/picker.md b/docs/markdown/en-US/picker.md index 6eba21b01..36dae13a5 100644 --- a/docs/markdown/en-US/picker.md +++ b/docs/markdown/en-US/picker.md @@ -126,17 +126,17 @@ When Picker columns data is acquired asynchronously, use `loading` prop to show ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| columns | Columns data | `Array` | `[]` | - | -| show-toolbar | Whether to show toolbar | `Boolean` | `false` | - | -| 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` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| columns | Columns data | `Array` | `[]` | +| show-toolbar | Whether to show toolbar | `Boolean` | `false` | +| 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` | ### Event Picker events will pass different parameters according to the columns are single or multiple diff --git a/docs/markdown/en-US/progress.md b/docs/markdown/en-US/progress.md index 96fb0f275..950f40693 100644 --- a/docs/markdown/en-US/progress.md +++ b/docs/markdown/en-US/progress.md @@ -39,11 +39,11 @@ Use `pivot-text` to custom text，use `color` to custom bar color ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| inactive | Whether to be gray | `Boolean` | `false` | - | -| percentage | Percentage | `Number` | `false` | `0-100` | -| show-pivot | Whether to show text | `Boolean` | `true` | - | -| pivot-text | Text | `String` | percentage | - | -| color | Color | `String` | `#38f` | hexvalue | -| text-color | Text color | `String` | `#fff` | hexvalue | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| inactive | Whether to be gray | `Boolean` | `false` | +| percentage | Percentage | `Number` | `false` | +| show-pivot | Whether to show text | `Boolean` | `true` | +| pivot-text | Text | `String` | percentage | +| color | Color | `String` | `#38f` | +| text-color | Text color | `String` | `#fff` | diff --git a/docs/markdown/en-US/pull-refresh.md b/docs/markdown/en-US/pull-refresh.md index 63c709f98..dfb9d3237 100644 --- a/docs/markdown/en-US/pull-refresh.md +++ b/docs/markdown/en-US/pull-refresh.md @@ -41,14 +41,14 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| 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...` | - | -| animation-duration | Animation duration | `Number` | `300` | - | -| head-height | Height of head | `Number` | `50` | - | +| 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...` | +| animation-duration | Animation duration | `Number` | `300` | +| head-height | Height of head | `Number` | `50` | ### Event diff --git a/docs/markdown/en-US/radio.md b/docs/markdown/en-US/radio.md index 864bc819c..6a6b6d6e3 100644 --- a/docs/markdown/en-US/radio.md +++ b/docs/markdown/en-US/radio.md @@ -56,17 +56,17 @@ export default { ### Radio API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| name | Radio name | `any` | - | - | -| disabled | Whether to disable radio | `Boolean` | `false` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| name | Radio name | `any` | - | +| disabled | Whether to disable radio | `Boolean` | `false` | ### RadioGroup API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-model | Name of checked radio | `any` | - | - | -| disabled | Diable all radios | `Boolean` | `false` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| v-model | Name of checked radio | `any` | - | +| disabled | Diable all radios | `Boolean` | `false` | ### RadioGroup Event diff --git a/docs/markdown/en-US/search.md b/docs/markdown/en-US/search.md index 2051affcd..a37961f62 100644 --- a/docs/markdown/en-US/search.md +++ b/docs/markdown/en-US/search.md @@ -58,11 +58,11 @@ Use `action` slot to custom right button, `cancel` event will no longer be trigg ### API Search support all native properties of input tag，such as `maxlength`、`placeholder`、`readonly`、`autofocus` -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| placeholder | Input placeholder | `String` | - | - | -| background | Background color | `String` | `#f2f2f2` | - | -| show-action | Whether to show right button | `Boolean` | false | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| placeholder | Input placeholder | `String` | - | +| background | Background color | `String` | `#f2f2f2` | +| show-action | Whether to show right button | `Boolean` | `false` | ### Event Search support all native events of input tag，such as `focus`、`blur`、`keypress` diff --git a/docs/markdown/en-US/sku.md b/docs/markdown/en-US/sku.md index 263e8d689..7b18d1dc2 100644 --- a/docs/markdown/en-US/sku.md +++ b/docs/markdown/en-US/sku.md @@ -83,24 +83,24 @@ Vue.use(Sku); ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| 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` | - | -| show-add-cart-btn | Whether to show cart button | `Boolean` | `true` | - | -| 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 | `Function` | - | `() => HTMLElement` | +| 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` | +| show-add-cart-btn | Whether to show cart button | `Boolean` | `true` | +| 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 | `() => HTMLElement` | - | ### Event diff --git a/docs/markdown/en-US/submit-bar.md b/docs/markdown/en-US/submit-bar.md index 38e85b370..3e3b5054d 100644 --- a/docs/markdown/en-US/submit-bar.md +++ b/docs/markdown/en-US/submit-bar.md @@ -62,16 +62,16 @@ Use slot to add custom contents. ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| price | Price | `Number` | - | - | -| label | Price label | `String` | `合计：` | - | -| button-text | Button text | `String` | - | - | -| button-type | Button type | `String` | `danger` | - | -| tip | Tip | `String` | - | - | -| disabled | Whether to disable button | `Boolean` | `false` | - | -| loading | Whether to show loading icon | `Boolean` | `false` | - | -| currency | Currency symbol | `String` | `¥` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| price | Price | `Number` | - | +| label | Price label | `String` | `合计：` | +| button-text | Button text | `String` | - | +| button-type | Button type | `String` | `danger` | +| tip | Tip | `String` | - | +| disabled | Whether to disable button | `Boolean` | `false` | +| loading | Whether to show loading icon | `Boolean` | `false` | +| currency | Currency symbol | `String` | `¥` | ### Event diff --git a/docs/markdown/en-US/swipe.md b/docs/markdown/en-US/swipe.md index 52fe25f63..bbd0d7329 100644 --- a/docs/markdown/en-US/swipe.md +++ b/docs/markdown/en-US/swipe.md @@ -79,15 +79,15 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| autoplay | Autoplay interval (ms) | `Number` | - | - | -| duration | Animation duration (ms) | `Number` | `500` | - | -| loop | Whether to enable loop | `Boolean` | `true` | - | -| vertical | Vertical Scrolling | `Boolean` | `false` | - | -| touchable | Whether touchable | `Boolean` | `true` | - | -| show-indicators | Whether to show indocators | `Boolean` | `true` | - | -| initial-swipe | Index of initial swipe, start from 0 | `Number` | `0` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| autoplay | Autoplay interval (ms) | `Number` | - | +| duration | Animation duration (ms) | `Number` | `500` | +| loop | Whether to enable loop | `Boolean` | `true` | +| vertical | Vertical Scrolling | `Boolean` | `false` | +| touchable | Whether touchable | `Boolean` | `true` | +| show-indicators | Whether to show indocators | `Boolean` | `true` | +| initial-swipe | Index of initial swipe, start from 0 | `Number` | `0` | ### Event diff --git a/docs/markdown/en-US/switch-cell.md b/docs/markdown/en-US/switch-cell.md index 4f4b8c986..bbbd1eb00 100644 --- a/docs/markdown/en-US/switch-cell.md +++ b/docs/markdown/en-US/switch-cell.md @@ -50,12 +50,12 @@ use `loading` property to keep component in loading state ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-model | on-off state of the switch | `Boolean` | - | - | -| title | the leftside title | `String` | `''` | - | -| loading | whether the component is in loading state | `Boolean` | `false` | - | -| disabled | whether to disable the component | `Boolean` | `false` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| v-model | on-off state of the switch | `Boolean` | - | +| title | the leftside title | `String` | `''` | +| loading | whether the component is in loading state | `Boolean` | `false` | +| disabled | whether to disable the component | `Boolean` | `false` | ### Event diff --git a/docs/markdown/en-US/switch.md b/docs/markdown/en-US/switch.md index 9dc759142..502998362 100644 --- a/docs/markdown/en-US/switch.md +++ b/docs/markdown/en-US/switch.md @@ -67,12 +67,12 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-model | Check status of Switch | `Boolean` | `false` | - | -| loading | Whether to show loading icon | `Boolean` | `false` | - | -| disabled | Whether to disable switch | `Boolean` | `false` | - | -| size | Size of switch | `String` | `30px` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| v-model | Check status of Switch | `Boolean` | `false` | +| loading | Whether to show loading icon | `Boolean` | `false` | +| disabled | Whether to disable switch | `Boolean` | `false` | +| size | Size of switch | `String` | `30px` | ### Event diff --git a/docs/markdown/en-US/tabbar.md b/docs/markdown/en-US/tabbar.md index 831add3cd..f3ed905af 100644 --- a/docs/markdown/en-US/tabbar.md +++ b/docs/markdown/en-US/tabbar.md @@ -62,9 +62,9 @@ export default { ### Tabbar API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-model | Index of current tab | `Number` | - | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| v-model | Index of current tab | `Number` | - | ### Tabbar Event @@ -74,14 +74,14 @@ export default { ### TabbarItem API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| icon | Icon name | `String` | - | Names from Icon Component | -| dot | Whether to show red dot | `Boolean` | - | - | -| 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 | `String` | `false` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| icon | Icon name | `String` | - | +| dot | Whether to show red dot | `Boolean` | - | +| 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 | `String` | `false` | ### TabbarItem Slot diff --git a/docs/markdown/en-US/tag.md b/docs/markdown/en-US/tag.md index 755a5dae9..c80e5e30e 100644 --- a/docs/markdown/en-US/tag.md +++ b/docs/markdown/en-US/tag.md @@ -38,11 +38,11 @@ Vue.use(Tag); ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| type | Type | `String` | `''`| `primary` `success` `danger` | -| plain | Whether to be plain style | `Boolean` | `false` | - | -| mark | Wtether to be mark style | `Boolean` | `false` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| type | Type, can be set to `primary` `success` `danger` | `String` | `''`| +| plain | Whether to be plain style | `Boolean` | `false` | +| mark | Wtether to be mark style | `Boolean` | `false` | ### Slot diff --git a/docs/markdown/en-US/toast.md b/docs/markdown/en-US/toast.md index 10927d2a9..e47e3c91e 100644 --- a/docs/markdown/en-US/toast.md +++ b/docs/markdown/en-US/toast.md @@ -93,11 +93,11 @@ toast2.clear(); ### Options -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| type | Type | `String` | `text` | `loading` `success` `fail` `html` | -| message | Message | `String` | `''` | - | -| position | Position | `String` | `middle` | `top` `bottom` | -| mask | Whether to show mask | `Boolean` | `false` | - | -| forbidClick | Whether to forbid click background | `Boolean` | `false` | - | -| duration | Toast duration(ms) | `Number` | `3000` | Toast won't disappear if value is 0 | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| type | Can be set to `loading` `success` `fail` `html` | `String` | `text` | +| position | Can be set to `top` `middle` `bottom` | `String` | `middle` | +| message | Message | `String` | `''` | +| mask | Whether to show mask | `Boolean` | `false` | +| forbidClick | Whether to forbid click background | `Boolean` | `false` | +| duration | Toast duration(ms), won't disappear if value is 0 | `Number` | `3000` | \ No newline at end of file diff --git a/docs/markdown/en-US/tree-select.md b/docs/markdown/en-US/tree-select.md index 6761b547c..a9839f0e2 100644 --- a/docs/markdown/en-US/tree-select.md +++ b/docs/markdown/en-US/tree-select.md @@ -47,11 +47,11 @@ export default { #### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| items | Required datasets for the component, see Data Structure for detail. | `Array` | `[]` | - | -| main-Active-index | The index of selected parent node | `Number` | `0` | - | -| active-id | Id of selected item | `Number` | `0` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| items | Required datasets for the component, see Data Structure for detail. | `Array` | `[]` | +| main-Active-index | The index of selected parent node | `Number` | `0` | +| active-id | Id of selected item | `Number` | `0` | #### Event | Event | Description | Arguments | diff --git a/docs/markdown/en-US/uploader.md b/docs/markdown/en-US/uploader.md index d6a3a861d..90e21e1b6 100644 --- a/docs/markdown/en-US/uploader.md +++ b/docs/markdown/en-US/uploader.md @@ -40,14 +40,14 @@ You can set native properties such as `accpet`、`multiple` on Uploader, and the ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| result-type | Type of file read result | `String` | `dataUrl` | `text` | -| accept | Accepted file type | `String` | `image/*` | - | -| disabled | Whether to disabled the upload | `Boolean` | `false` | - | -| before-read | Hook before reading the file, return false to stop reading the file | `Function` | - | - | -| after-read | Hook after reading the file | `Function` | - | - | -| max-size | Max size of file | `Number` | - | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| result-type | Type of file read result, can be set to `dataUrl` `text` | `String` | `dataUrl` | +| accept | Accepted file type | `String` | `image/*` | +| disabled | Whether to disabled the upload | `Boolean` | `false` | +| before-read | Hook before reading the file, return false to stop reading the file | `Function` | - | +| after-read | Hook after reading the file | `Function` | - | +| max-size | Max size of file | `Number` | - | ### Event diff --git a/docs/markdown/en-US/waterfall.md b/docs/markdown/en-US/waterfall.md index 5a5e71700..23b9c8b00 100644 --- a/docs/markdown/en-US/waterfall.md +++ b/docs/markdown/en-US/waterfall.md @@ -69,9 +69,9 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-waterfall-lower | Function to trigger when scroll to bottom | `Function` | - | - | -| v-waterfall-upper | Function to trigger when scroll to top | `Function` | - | - | -| waterfall-disabled | Key of the property to control disable status in instance | `String` | - | - | -| waterfall-offset | Offset to trigger callback function | `Number` | `300` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| v-waterfall-lower | Function to trigger when scroll to bottom | `Function` | - | +| v-waterfall-upper | Function to trigger when scroll to top | `Function` | - | +| waterfall-disabled | Key of the property to control disable status in instance | `String` | - | +| waterfall-offset | Offset to trigger callback function | `Number` | `300` | diff --git a/docs/markdown/zh-CN/actionsheet.md b/docs/markdown/zh-CN/actionsheet.md index d42e3c1c9..f67b046ba 100644 --- a/docs/markdown/zh-CN/actionsheet.md +++ b/docs/markdown/zh-CN/actionsheet.md @@ -66,14 +66,14 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| actions | 行动按钮数组 | `Array` | `[]` | - | -| title | 标题 | `String` | - | - | -| cancel-text | 取消按钮文案 | `String` | - | - | -| overlay | 是否显示遮罩 | `Boolean` | - | - | -| close-on-click-overlay | 点击遮罩是否关闭`Actionsheet` | `Boolean` | - | - | -| get-container | 指定挂载的 HTML 节点 | `Function` | - | `() => HTMLElement` | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| actions | 行动按钮数组 | `Array` | `[]` | +| title | 标题 | `String` | - | +| cancel-text | 取消按钮文案 | `String` | - | +| overlay | 是否显示遮罩 | `Boolean` | - | +| close-on-click-overlay | 点击遮罩是否关闭`Actionsheet` | `Boolean` | - | +| get-container | 指定挂载的 HTML 节点 | `() => HTMLElement` | - | ### Event diff --git a/docs/markdown/zh-CN/address-edit.md b/docs/markdown/zh-CN/address-edit.md index b686f609e..f4afb74b9 100644 --- a/docs/markdown/zh-CN/address-edit.md +++ b/docs/markdown/zh-CN/address-edit.md @@ -57,18 +57,18 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| 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` | - | -| is-saving | 是否显示保存按钮加载动画 | `Boolean` | `false` | - | -| is-deleting | 是否显示删除按钮加载动画 | `Boolean` | `false` | - | -| tel-validator | 手机号格式校验函数 | `(tel: string) => boolean` | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| 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` | +| is-saving | 是否显示保存按钮加载动画 | `Boolean` | `false` | +| is-deleting | 是否显示删除按钮加载动画 | `Boolean` | `false` | +| tel-validator | 手机号格式校验函数 | `(tel: string) => boolean` | - | ### Event diff --git a/docs/markdown/zh-CN/address-list.md b/docs/markdown/zh-CN/address-list.md index ad5f68847..219cb8046 100644 --- a/docs/markdown/zh-CN/address-list.md +++ b/docs/markdown/zh-CN/address-list.md @@ -56,11 +56,11 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 当前选中地址的 id | String | - | - | -| list | 地址列表 | Array | `[]` | - | -| add-button-text | 底部按钮文字 | String | `新增收货地址` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 当前选中地址的 id | String | - | +| list | 地址列表 | Array | `[]` | +| add-button-text | 底部按钮文字 | String | `新增收货地址` | ### Event diff --git a/docs/markdown/zh-CN/area.md b/docs/markdown/zh-CN/area.md index f91649690..1ecd5a59f 100644 --- a/docs/markdown/zh-CN/area.md +++ b/docs/markdown/zh-CN/area.md @@ -37,15 +37,15 @@ Vue.use(Area); ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -| --- | --- | --- | --- | --- | -| 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` | - | +| 参数 | 说明 | 类型 | 默认值 | +| --- | --- | --- | --- | +| 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` | ### Event diff --git a/docs/markdown/zh-CN/badge.md b/docs/markdown/zh-CN/badge.md index 4a8e0f4ac..2bcb95a90 100644 --- a/docs/markdown/zh-CN/badge.md +++ b/docs/markdown/zh-CN/badge.md @@ -40,13 +40,13 @@ export default { ### BadgeGroup API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| active-key | 选中`badge`的索引 | `String | Number` | `0` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| active-key | 选中`badge`的索引 | `String | Number` | `0` | ### Badge API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| title | 内容 | `String` | `''` | - | -| info | 提示消息 | `String | Number` | `''` | - | -| url | 跳转链接 | `String` | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| title | 内容 | `String` | `''` | +| info | 提示消息 | `String | Number` | `''` | +| url | 跳转链接 | `String` | - | diff --git a/docs/markdown/zh-CN/card.md b/docs/markdown/zh-CN/card.md index cfdd15612..d1e9d930f 100644 --- a/docs/markdown/zh-CN/card.md +++ b/docs/markdown/zh-CN/card.md @@ -41,15 +41,15 @@ Vue.use(Card); ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| thumb | 左侧图片 | `String` | - | - | -| title | 标题 | `String` | - | - | -| desc | 描述 | `String` | - | - | -| num | 商品数量 | `String | Number` | - | - | -| price | 商品价格 | `String | Number` | - | - | -| centered | 内容是否垂直居中 | `String` | `false` | - | -| currency | 货币符号 | `String` | `¥` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| thumb | 左侧图片 | `String` | - | +| title | 标题 | `String` | - | +| desc | 描述 | `String` | - | +| num | 商品数量 | `String | Number` | - | +| price | 商品价格 | `String | Number` | - | +| centered | 内容是否垂直居中 | `String` | `false` | +| currency | 货币符号 | `String` | `¥` | ### Slot diff --git a/docs/markdown/zh-CN/cell-swipe.md b/docs/markdown/zh-CN/cell-swipe.md index 8e30f8ed6..72724c0b0 100644 --- a/docs/markdown/zh-CN/cell-swipe.md +++ b/docs/markdown/zh-CN/cell-swipe.md @@ -58,11 +58,11 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| left-width | 左侧滑动区域宽度 | `Number` | `0` | - | -| right-width | 右侧滑动区域宽度 | `Number` | `0` | - | -| on-close | 关闭时的回调函数 | `Function` | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| left-width | 左侧滑动区域宽度 | `Number` | `0` | +| right-width | 右侧滑动区域宽度 | `Number` | `0` | +| on-close | 关闭时的回调函数 | `Function` | - | ### Slot diff --git a/docs/markdown/zh-CN/cell.md b/docs/markdown/zh-CN/cell.md index c29e90478..53c23536f 100644 --- a/docs/markdown/zh-CN/cell.md +++ b/docs/markdown/zh-CN/cell.md @@ -69,26 +69,26 @@ Vue.use(Cell).use(CellGroup); ### CellGroup API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| border | 是否显示外边框 | `Boolean` | `true` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| border | 是否显示外边框 | `Boolean` | `true` | ### Cell API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| icon | 左侧图标 | `String` | - | - | -| title | 左侧标题 | `String` | - | - | -| value | 右侧内容 | `String` | - | - | -| label | 标题下方的描述信息 | `String` | - | - | -| border | 是否显示内边框 | `Boolean` | `true` | - | -| center | 是否使内容垂直居中 | `Boolean` | `false` | - | -| url | 跳转链接 | `String` | - | - | -| to | 路由跳转对象，同 `vue-router` 的 to | `String | Object` | - | - | -| replace | 跳转时是否替换当前 history | `String` | `false` | - | -| clickable | 是否开启点击反馈 | `Boolean` | `false` | - | -| is-link | 是否展示右侧箭头并开启点击反馈 | `Boolean` | `false` | - | -| required | 是否显示表单必填星号 | `Boolean` | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| icon | 左侧图标 (可选值见 Icon 组件) | `String` | - | +| title | 左侧标题 | `String` | - | +| value | 右侧内容 | `String` | - | +| label | 标题下方的描述信息 | `String` | - | +| border | 是否显示内边框 | `Boolean` | `true` | +| center | 是否使内容垂直居中 | `Boolean` | `false` | +| url | 跳转链接 | `String` | - | +| to | 路由跳转对象，同 `vue-router` 的 to | `String | Object` | - | +| replace | 跳转时是否替换当前 history | `String` | `false` | +| clickable | 是否开启点击反馈 | `Boolean` | `false` | +| is-link | 是否展示右侧箭头并开启点击反馈 | `Boolean` | `false` | +| required | 是否显示表单必填星号 | `Boolean` | `false` | ### Cell Event diff --git a/docs/markdown/zh-CN/circle.md b/docs/markdown/zh-CN/circle.md index 06166c3ba..33d65f7fe 100644 --- a/docs/markdown/zh-CN/circle.md +++ b/docs/markdown/zh-CN/circle.md @@ -56,18 +56,18 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 当前进度 | `Number` | - | - | -| rate | 目标进度 | `Number` | `100` | - | -| size | 圆环直径 | `String` | `100px` | - | -| color | 进度条颜色 | `String` | `#38f` | - | -| layer-color | 轨道颜色 | `String` | `#fff` | - | -| fill | 填充颜色 | `String` | `none` | - | -| speed | 动画速度（单位为 rate/s）| `Number` | - | - | -| text | 文字 | `String` | - | - | -| stroke-width | 进度条宽度 | `Number` | `40` | - | -| clockwise | 是否顺时针增加 | `Boolean` | `true` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 当前进度 | `Number` | - | +| rate | 目标进度 | `Number` | `100` | +| size | 圆环直径 | `String` | `100px` | +| color | 进度条颜色 | `String` | `#38f` | +| layer-color | 轨道颜色 | `String` | `#fff` | +| fill | 填充颜色 | `String` | `none` | +| speed | 动画速度（单位为 rate/s）| `Number` | - | +| text | 文字 | `String` | - | +| stroke-width | 进度条宽度 | `Number` | `40` | +| clockwise | 是否顺时针增加 | `Boolean` | `true` | ### Circle Slot diff --git a/docs/markdown/zh-CN/collapse.md b/docs/markdown/zh-CN/collapse.md index 0d03c884b..62b27e8d3 100644 --- a/docs/markdown/zh-CN/collapse.md +++ b/docs/markdown/zh-CN/collapse.md @@ -81,10 +81,10 @@ export default { ### Collapse API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | +| 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------|-------------| -| v-model | 当前展开面板的 name | `Array | String | Number` | - | - | -| accordion | 是否开启手风琴模式 | `Boolean` | `false` | - | +| v-model | 当前展开面板的 name | `Array | String | Number` | - | +| accordion | 是否开启手风琴模式 | `Boolean` | `false` | ### Collapse Event @@ -94,10 +94,10 @@ export default { ### CollapseItem API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | +| 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------|-------------| -| name | 面板唯一标识符，默认为索引值 | `String | Number` | `index` | - | -| title | 标题 | `String` | - | - | +| name | 面板唯一标识符，默认为索引值 | `String | Number` | `index` | +| title | 标题 | `String` | - | ### CollapseItem Slot diff --git a/docs/markdown/zh-CN/contact.md b/docs/markdown/zh-CN/contact.md index 1daf259d8..26bd45f20 100644 --- a/docs/markdown/zh-CN/contact.md +++ b/docs/markdown/zh-CN/contact.md @@ -140,11 +140,11 @@ export default { | add-text | 添加时的文案提示 | `String` | `添加订单联系人信息` | - | ### ContactList API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | +| 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------|-------------| -| v-model | 当前选中联系人的 id | `String | Number` | - | - | -| list | 联系人列表 | `Array` | `[]` | - | -| add-text | 新建按钮文案 | `String` | `新建联系人` | - | +| v-model | 当前选中联系人的 id | `String | Number` | - | +| list | 联系人列表 | `Array` | `[]` | +| add-text | 新建按钮文案 | `String` | `新建联系人` | ### ContactList Event @@ -156,13 +156,13 @@ export default { ### ContactEdit API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | +| 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------|-------------| -| contact-info | 联系人信息 | `Object` | `[]` | - | -| is-edit | 是否为编辑联系人 | `Boolean` | `false` | - | -| is-saving | 是否显示保存按钮加载动画 | `Boolean` | `false` | - | -| is-deleting | 是否显示删除按钮加载动画 | `Boolean` | `false` | - | -| tel-validator | 手机号格式校验函数 | `(tel: string) => boolean` | - | - | +| contact-info | 联系人信息 | `Object` | `[]` | +| is-edit | 是否为编辑联系人 | `Boolean` | `false` | +| is-saving | 是否显示保存按钮加载动画 | `Boolean` | `false` | +| is-deleting | 是否显示删除按钮加载动画 | `Boolean` | `false` | +| tel-validator | 手机号格式校验函数 | `(tel: string) => boolean` | - | ### ContactEdit Event diff --git a/docs/markdown/zh-CN/coupon.md b/docs/markdown/zh-CN/coupon.md index 4116cec09..af6f5f615 100644 --- a/docs/markdown/zh-CN/coupon.md +++ b/docs/markdown/zh-CN/coupon.md @@ -68,31 +68,31 @@ export default { ### CouponCell API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| title | 单元格标题 | `String` | `优惠券码` | - | -| chosen-coupon | 当前选中优惠券的索引 | `Number` | `-1` | - | -| coupons | 可用优惠券列表 | `Array` | `[]` | - | -| editable | 能否切换优惠券 | `Boolean` | `true` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| title | 单元格标题 | `String` | `优惠券码` | +| chosen-coupon | 当前选中优惠券的索引 | `Number` | `-1` | +| coupons | 可用优惠券列表 | `Array` | `[]` | +| editable | 能否切换优惠券 | `Boolean` | `true` | ### CouponList API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 当前输入的兑换码 | `String` | - | - | -| chosen-coupon | 当前选中优惠券的索引 | `Number` | `-1` | - | -| coupons | 可用优惠券列表 | `Array` | `[]` | - | -| disabled-coupons | 不可用优惠券列表 | `Array` | `[]` | - | -| 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` | `不使用优惠` | - | -| disabled-list-title | 不可用券列表标题 | `String` | `不可用优惠` | - | -| input-placeholder | 输入框文字提示 | `String` | `请输入优惠码` | - | -| show-exchange-bar | 是否展示兑换栏 | `Boolean` | `true` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 当前输入的兑换码 | `String` | - | +| chosen-coupon | 当前选中优惠券的索引 | `Number` | `-1` | +| coupons | 可用优惠券列表 | `Array` | `[]` | +| disabled-coupons | 不可用优惠券列表 | `Array` | `[]` | +| 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` | `不使用优惠` | +| disabled-list-title | 不可用券列表标题 | `String` | `不可用优惠` | +| input-placeholder | 输入框文字提示 | `String` | `请输入优惠码` | +| show-exchange-bar | 是否展示兑换栏 | `Boolean` | `true` | ### CouponList Event diff --git a/docs/markdown/zh-CN/dialog.md b/docs/markdown/zh-CN/dialog.md index 876e55144..9330bad98 100644 --- a/docs/markdown/zh-CN/dialog.md +++ b/docs/markdown/zh-CN/dialog.md @@ -67,18 +67,18 @@ export default { ### Options -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| title | 标题 | `String` | - | - | -| message | 内容 | `String` | - | - | -| showConfirmButton | 是否展示确认按钮 | `Boolean` | `true` | - | -| showCancelButton | 是否展示取消按钮 | `Boolean` | `false` | - | -| confirmButtonText | 确认按钮的文案 | `String` | `确认` | - | -| cancelButtonText | 取消按钮的文案 | `String` | `取消` | - | -| overlay | 是否展示蒙层 | `Boolean` | `true` | - | -| closeOnClickOverlay | 点击蒙层时是否关闭弹窗 | `Boolean` | `false` | - | -| lockScroll | 是否锁定背景滚动 | `Boolean` | `true` | - | -| beforeClose | 关闭前的回调函数，调用 done 后关闭弹窗 | (action: string, done: function) => void | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| title | 标题 | `String` | - | +| message | 内容 | `String` | - | +| showConfirmButton | 是否展示确认按钮 | `Boolean` | `true` | +| showCancelButton | 是否展示取消按钮 | `Boolean` | `false` | +| confirmButtonText | 确认按钮的文案 | `String` | `确认` | +| cancelButtonText | 取消按钮的文案 | `String` | `取消` | +| overlay | 是否展示蒙层 | `Boolean` | `true` | +| closeOnClickOverlay | 点击蒙层时是否关闭弹窗 | `Boolean` | `false` | +| lockScroll | 是否锁定背景滚动 | `Boolean` | `true` | +| beforeClose | 关闭前的回调函数，调用 done 后关闭弹窗 | (action: string, done: function) => void | - | #### 高级用法 @@ -130,19 +130,19 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 是否显示弹窗 | `Boolean` | - | - | -| title | 标题 | `String` | - | - | -| message | 内容 | `String` | - | - | -| show-confirm-button | 是否展示确认按钮 | `Boolean` | `true` | - | -| show-cancel-button | 是否展示取消按钮 | `Boolean` | `false` | - | -| confirm-button-text | 确认按钮的文案 | `String` | `确认` | - | -| cancel-button-text | 取消按钮的文案 | `String` | `取消` | - | -| overlay | 是否展示蒙层 | `Boolean` | `true` | - | -| close-on-click-overlay | 点击蒙层时是否关闭弹窗 | `Boolean` | `false` | - | -| lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` | - | -| before-close | 关闭前的回调函数，调用 done 后关闭弹窗 | (action: string, done: function) => void | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 是否显示弹窗 | `Boolean` | - | +| title | 标题 | `String` | - | +| message | 内容 | `String` | - | +| show-confirm-button | 是否展示确认按钮 | `Boolean` | `true` | +| show-cancel-button | 是否展示取消按钮 | `Boolean` | `false` | +| confirm-button-text | 确认按钮的文案 | `String` | `确认` | +| cancel-button-text | 取消按钮的文案 | `String` | `取消` | +| overlay | 是否展示蒙层 | `Boolean` | `true` | +| close-on-click-overlay | 点击蒙层时是否关闭弹窗 | `Boolean` | `false` | +| lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` | +| before-close | 关闭前的回调函数，调用 done 后关闭弹窗 | (action: string, done: function) => void | - | ### Event diff --git a/docs/markdown/zh-CN/field.md b/docs/markdown/zh-CN/field.md index 0805d8504..e6d60a5b1 100644 --- a/docs/markdown/zh-CN/field.md +++ b/docs/markdown/zh-CN/field.md @@ -122,7 +122,7 @@ Filed 默认支持 Input 标签所有的原生属性，比如 `maxlength`、`pla | error | 输入框是否有错误 | `Boolean` | `false` | - | | error-message | 输入框底部错误提示文案 | `String` | `''` | - | | autosize | 自适应内容高度，只对 textarea 有效，可传入对象，如 { maxHeight: 100, minHeight: 50 }，单位为 px | `Boolean | Object` | `false` | - | -| icon | 输入框尾部图标 | `String` | - | Icon 组件支持的类型 | +| icon | 输入框尾部图标 (可选值见 Icon 组件) | `String` | - | - | ### Event Filed 默认支持 Input 标签所有的原生事件，如 `focus`、`blur`、`keypress` 等 diff --git a/docs/markdown/zh-CN/goods-action.md b/docs/markdown/zh-CN/goods-action.md index e8370ab27..e2171dc68 100644 --- a/docs/markdown/zh-CN/goods-action.md +++ b/docs/markdown/zh-CN/goods-action.md @@ -56,23 +56,23 @@ export default { #### GoodsActionMiniBtn -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| text | 按钮文字 | `String` | - | - | -| icon | 图标 | `String` | - | Icon 组件支持的所有图标 | -| icon-class | 图标额外类名 | `String` | `''` | - | -| info | 图标右上角提示信息 | `String | Number` | - | - | -| url | 跳转链接 | `String` | - | - | -| to | 路由跳转对象，同 `vue-router` 的 to | `String | Object` | - | - | -| replace | 跳转时是否替换当前 history | `String` | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| text | 按钮文字 | `String` | - | +| icon | 图标 | `String` | - | +| icon-class | 图标额外类名 | `String` | `''` | +| info | 图标右上角提示信息 | `String | Number` | - | +| url | 跳转链接 | `String` | - | +| to | 路由跳转对象，同 `vue-router` 的 to | `String | Object` | - | +| replace | 跳转时是否替换当前 history | `String` | `false` | #### GoodsActionBigBtn -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| text | 按钮文字 | `String` | - | - | -| primary | 是否主行动按钮，主行动按钮默认为红色 | `Boolean` | `false` | - | -| url | 跳转链接 | `String` | - | - | -| to | 路由跳转对象，同 `vue-router` 的 to | `String | Object` | - | - | -| replace | 跳转时是否替换当前 history | `String` | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| text | 按钮文字 | `String` | - | +| primary | 是否主行动按钮，主行动按钮默认为红色 | `Boolean` | `false` | +| url | 跳转链接 | `String` | - | +| to | 路由跳转对象，同 `vue-router` 的 to | `String | Object` | - | +| replace | 跳转时是否替换当前 history | `String` | `false` | diff --git a/docs/markdown/zh-CN/icon.md b/docs/markdown/zh-CN/icon.md index 1d30fdee4..1b5b3e36c 100644 --- a/docs/markdown/zh-CN/icon.md +++ b/docs/markdown/zh-CN/icon.md @@ -47,10 +47,10 @@ import 'vant/lib/vant-css/icon-local.css'; ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| name | 图标名称 | `String` | `''` | - | -| info | 图标右上角文字提示 | `String | Number` | `''` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| name | 图标名称 | `String` | `''` | +| info | 图标右上角文字提示 | `String | Number` | `''` | ### Event diff --git a/docs/markdown/zh-CN/layout.md b/docs/markdown/zh-CN/layout.md index 53ab3ba28..00202e428 100644 --- a/docs/markdown/zh-CN/layout.md +++ b/docs/markdown/zh-CN/layout.md @@ -48,12 +48,14 @@ Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置 ### API #### Row -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| gutter | 列元素之间的间距（单位为px） | `String | Number` | - | - | + +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| gutter | 列元素之间的间距（单位为px） | `String | Number` | - | #### Column -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| span | 列元素宽度 | `String | Number` | - | - | -| offset | 列元素偏移距离 | `String | Number` | - | - | + +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| span | 列元素宽度 | `String | Number` | - | +| offset | 列元素偏移距离 | `String | Number` | - | diff --git a/docs/markdown/zh-CN/lazyload.md b/docs/markdown/zh-CN/lazyload.md index ec4f717fc..1c71246fc 100644 --- a/docs/markdown/zh-CN/lazyload.md +++ b/docs/markdown/zh-CN/lazyload.md @@ -53,15 +53,15 @@ export default { ### Options -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| loading | 加载时的图片 | `String` | - | - | -| error | 错误时的图片 | `String` | - | - | -| preload | 预加载高度的比例 | `String` | - | - | -| attempt | 尝试次数 | `Number` | `3` | - | -| listenEvents | 监听的事件 | `Array` | `scroll`等 | - | -| adapter | 适配器 | `Object` | - | - | -| filter | 图片url过滤 | `Object` | - | - | -| lazyComponent | 是否能懒加载模块 | `Boolean` | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| loading | 加载时的图片 | `String` | - | +| error | 错误时的图片 | `String` | - | +| preload | 预加载高度的比例 | `String` | - | +| attempt | 尝试次数 | `Number` | `3` | +| listenEvents | 监听的事件 | `Array` | `scroll`等 | +| adapter | 适配器 | `Object` | - | +| filter | 图片url过滤 | `Object` | - | +| lazyComponent | 是否能懒加载模块 | `Boolean` | `false` | 更多内容请参照：[vue-lazyload 官方文档](https://github.com/hilongjw/vue-lazyload) diff --git a/docs/markdown/zh-CN/list.md b/docs/markdown/zh-CN/list.md index 85847f1dd..6e377ecb2 100644 --- a/docs/markdown/zh-CN/list.md +++ b/docs/markdown/zh-CN/list.md @@ -51,13 +51,13 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| loading | 是否显示加载中提示，加载过程中不触发`load`事件 | `Boolean` | `false` | - | -| finished | 是否已加载完成，加载完成后不再触发`load`事件 | `Boolean` | `false` | - | -| offset | 滚动条与底部距离小于 offset 时触发`load`事件 | `Number` | `300` | - | -| loading-text | 加载中提示文案 | `String` | `加载中...` | - | -| immediate-check | 是否在初始化时立即执行滚动位置检查 | `Boolean` | `true` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| loading | 是否显示加载中提示，加载过程中不触发`load`事件 | `Boolean` | `false` | +| finished | 是否已加载完成，加载完成后不再触发`load`事件 | `Boolean` | `false` | +| offset | 滚动条与底部距离小于 offset 时触发`load`事件 | `Number` | `300` | +| loading-text | 加载中提示文案 | `String` | `加载中...` | +| immediate-check | 是否在初始化时立即执行滚动位置检查 | `Boolean` | `true` | ### Event diff --git a/docs/markdown/zh-CN/nav-bar.md b/docs/markdown/zh-CN/nav-bar.md index dc5327156..75762dd84 100644 --- a/docs/markdown/zh-CN/nav-bar.md +++ b/docs/markdown/zh-CN/nav-bar.md @@ -46,14 +46,15 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| title | 标题 | `String` | `''` | - | -| left-text | 左侧文案 | `String` | `''` | - | -| right-text | 右侧文案 | `String` | `''` | - | -| left-arrow | 是否显示左侧箭头 | `Boolean` | `false` | - | -| fixed | 是否固定在顶部 | `Boolean` | `false` | - | -| z-index | 元素 z-index | `Number` | `1` | - | + +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| title | 标题 | `String` | `''` | +| left-text | 左侧文案 | `String` | `''` | +| right-text | 右侧文案 | `String` | `''` | +| left-arrow | 是否显示左侧箭头 | `Boolean` | `false` | +| fixed | 是否固定在顶部 | `Boolean` | `false` | +| z-index | 元素 z-index | `Number` | `1` | ### Slot diff --git a/docs/markdown/zh-CN/panel.md b/docs/markdown/zh-CN/panel.md index 029e909c1..767ffed28 100644 --- a/docs/markdown/zh-CN/panel.md +++ b/docs/markdown/zh-CN/panel.md @@ -33,11 +33,11 @@ Vue.use(Panel); ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| title | 标题 | `String` | - | - | -| desc | 描述 | `String` | - | - | -| status | 状态 | `String` | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| title | 标题 | `String` | - | +| desc | 描述 | `String` | - | +| status | 状态 | `String` | - | ### Slot diff --git a/docs/markdown/zh-CN/password-input.md b/docs/markdown/zh-CN/password-input.md index 1b1e9ecd0..03fdf7500 100644 --- a/docs/markdown/zh-CN/password-input.md +++ b/docs/markdown/zh-CN/password-input.md @@ -51,12 +51,12 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| value | 密码值 | `String` | `''` | - | -| length | 密码最大长度 | `Number` | `6` | - | -| info | 输入框下方提示 | `String` | - | - | -| error-info | 输入框下方错误提示 | `String` | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| value | 密码值 | `String` | `''` | +| length | 密码最大长度 | `Number` | `6` | +| info | 输入框下方提示 | `String` | - | +| error-info | 输入框下方错误提示 | `String` | - | ### Event diff --git a/docs/markdown/zh-CN/picker.md b/docs/markdown/zh-CN/picker.md index 87bbe9388..9526ad278 100644 --- a/docs/markdown/zh-CN/picker.md +++ b/docs/markdown/zh-CN/picker.md @@ -128,17 +128,17 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| columns | 对象数组，配置每一列显示的数据 | `Array` | `[]` | - | -| show-toolbar | 是否显示顶部栏 | `Boolean` | `false` | - | -| 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` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| columns | 对象数组，配置每一列显示的数据 | `Array` | `[]` | +| show-toolbar | 是否显示顶部栏 | `Boolean` | `false` | +| 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` | ### Event Picker 组件的事件会根据 columns 是单列或多列返回不同的参数 diff --git a/docs/markdown/zh-CN/progress.md b/docs/markdown/zh-CN/progress.md index 9e8120b8e..8d22e3f9d 100644 --- a/docs/markdown/zh-CN/progress.md +++ b/docs/markdown/zh-CN/progress.md @@ -41,11 +41,11 @@ Vue.use(Progress); ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| inactive | 是否置灰 | `Boolean` | `false` | - | -| percentage | 进度百分比 | `Number` | `false` | `0-100` | -| show-pivot | 是否显示进度文字 | `Boolean` | `true` | - | -| pivot-text | 文字显示 | `String` | 百分比文字 | - | -| color | 进度条颜色 | `String` | `#38f` | hexvalue | -| text-color | 进度条文字颜色 | `String` | `#fff` | hexvalue | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| inactive | 是否置灰 | `Boolean` | `false` | +| percentage | 进度百分比 | `Number` | `false` | +| show-pivot | 是否显示进度文字 | `Boolean` | `true` | +| pivot-text | 文字显示 | `String` | 百分比文字 | +| color | 进度条颜色 | `String` | `#38f` | +| text-color | 进度条文字颜色 | `String` | `#fff` | diff --git a/docs/markdown/zh-CN/pull-refresh.md b/docs/markdown/zh-CN/pull-refresh.md index b5d9ba316..93f808651 100644 --- a/docs/markdown/zh-CN/pull-refresh.md +++ b/docs/markdown/zh-CN/pull-refresh.md @@ -41,14 +41,14 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 是否在加载中 | `Boolean` | - | - | -| pulling-text | 下拉过程中顶部文案 | `String` | `下拉即可刷新...` | - | -| loosing-text | 释放过程中顶部文案 | `String` | `释放即可刷新...` | - | -| loading-text | 加载过程中顶部文案 | `String` | `加载中...` | - | -| animation-duration | 动画时长 | `Number` | `300` | - | -| head-height | 顶部内容高度 | `Number` | `50` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 是否在加载中 | `Boolean` | - | +| pulling-text | 下拉过程中顶部文案 | `String` | `下拉即可刷新...` | +| loosing-text | 释放过程中顶部文案 | `String` | `释放即可刷新...` | +| loading-text | 加载过程中顶部文案 | `String` | `加载中...` | +| animation-duration | 动画时长 | `Number` | `300` | +| head-height | 顶部内容高度 | `Number` | `50` | ### Event diff --git a/docs/markdown/zh-CN/radio.md b/docs/markdown/zh-CN/radio.md index c0f6a545f..f436c2901 100644 --- a/docs/markdown/zh-CN/radio.md +++ b/docs/markdown/zh-CN/radio.md @@ -58,17 +58,17 @@ export default { ### Radio API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| name | 唯一标识符 | 任意类型 | - | - | -| disabled | 是否为禁用状态 | `Boolean` | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| name | 唯一标识符 | 任意类型 | - | +| disabled | 是否为禁用状态 | `Boolean` | `false` | ### RadioGroup API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 当前选中项的 name | 任意类型 | - | - | -| disabled | 是否禁用所有单选框 | `Boolean` | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 当前选中项的 name | 任意类型 | - | +| disabled | 是否禁用所有单选框 | `Boolean` | `false` | ### RadioGroup Event diff --git a/docs/markdown/zh-CN/search.md b/docs/markdown/zh-CN/search.md index cf72388e8..82e59f4ba 100644 --- a/docs/markdown/zh-CN/search.md +++ b/docs/markdown/zh-CN/search.md @@ -49,10 +49,10 @@ Tips: 在 `van-search` 外层增加 form 标签，并且 action 不为空，即 ### API Search 默认支持 Input 标签所有的原生属性，比如 `maxlength`、`placeholder`、`readony`、`autofocus` 等 -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| background | 搜索框背景色 | `String` | `#f2f2f2` | 所有浏览器支持的颜色描述 | -| show-action | 是否在搜索框右侧显示取消按钮 | `Boolean` | false | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| background | 搜索框背景色 | `String` | `#f2f2f2` | +| show-action | 是否在搜索框右侧显示取消按钮 | `Boolean` | `false` | ### Event Search 默认支持 Input 标签所有的原生事件，如 `focus`、`blur`、`keypress` 等 diff --git a/docs/markdown/zh-CN/sku.md b/docs/markdown/zh-CN/sku.md index 14407ee7b..c18d09c36 100644 --- a/docs/markdown/zh-CN/sku.md +++ b/docs/markdown/zh-CN/sku.md @@ -84,24 +84,24 @@ Vue.use(Sku); ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 是否显示sku | `Boolean` | `false` | - | -| sku | 商品sku数据 | `Object` | - | - | -| goods | 商品信息 | `Object` | - | - | -| goods-id | 商品id | `String | Number` | - | - | -| hide-stock | 是否显示商品剩余库存 | `Boolean` | `false` | - | -| show-add-cart-btn | 是否显示加入购物车按钮 | `Boolean` | `true` | - | -| 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 | 是否禁用sku中stepper的input框 | `Boolean` | `false` | - | -| close-on-click-overlay | 点击popup的overlay后是否关闭弹窗 | `Boolean` | `false` | - | -| stepper-title | 数量选择组件左侧文案 | `String` | `购买数量` | - | -| custom-stepper-config | 步进器相关自定义配置 | `Object` | `{}` | - | -| message-config | 留言相关配置 | `Object` | `{}` | - | -| get-container | 指定挂载的 HTML 节点 | `Function` | - | `() => HTMLElement` | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 是否显示sku | `Boolean` | `false` | +| sku | 商品sku数据 | `Object` | - | +| goods | 商品信息 | `Object` | - | +| goods-id | 商品id | `String | Number` | - | +| hide-stock | 是否显示商品剩余库存 | `Boolean` | `false` | +| show-add-cart-btn | 是否显示加入购物车按钮 | `Boolean` | `true` | +| 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 | 是否禁用sku中stepper的input框 | `Boolean` | `false` | +| close-on-click-overlay | 点击popup的overlay后是否关闭弹窗 | `Boolean` | `false` | +| stepper-title | 数量选择组件左侧文案 | `String` | `购买数量` | +| custom-stepper-config | 步进器相关自定义配置 | `Object` | `{}` | +| message-config | 留言相关配置 | `Object` | `{}` | +| get-container | 指定挂载的 HTML 节点 | `() => HTMLElement` | - | ### Event diff --git a/docs/markdown/zh-CN/submit-bar.md b/docs/markdown/zh-CN/submit-bar.md index e7643abbd..01ac1952c 100644 --- a/docs/markdown/zh-CN/submit-bar.md +++ b/docs/markdown/zh-CN/submit-bar.md @@ -62,16 +62,16 @@ Vue.use(SubmitBar); ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| price | 价格（单位分） | `Number` | - | - | -| label | 价格文案 | `String` | `合计：` | - | -| button-text | 按钮文字 | `String` | - | - | -| button-type | 按钮类型 | `String` | `danger` | - | -| tip | 提示文案 | `String` | - | - | -| disabled | 是否禁用按钮 | `Boolean` | `false` | - | -| loading | 是否显示加载中的按钮 | `Boolean` | `false` | - | -| currency | 货币符号 | `String` | `¥` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| price | 价格（单位分） | `Number` | - | +| label | 价格文案 | `String` | `合计：` | +| button-text | 按钮文字 | `String` | - | +| button-type | 按钮类型 | `String` | `danger` | +| tip | 提示文案 | `String` | - | +| disabled | 是否禁用按钮 | `Boolean` | `false` | +| loading | 是否显示加载中的按钮 | `Boolean` | `false` | +| currency | 货币符号 | `String` | `¥` | ### Event diff --git a/docs/markdown/zh-CN/swipe.md b/docs/markdown/zh-CN/swipe.md index c18cae630..bcbdcdd7d 100644 --- a/docs/markdown/zh-CN/swipe.md +++ b/docs/markdown/zh-CN/swipe.md @@ -79,15 +79,15 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| autoplay | 自动轮播间隔，单位为 ms | `Number` | - | - | -| duration | 动画时长，单位为 ms | `Number` | `500` | - | -| loop | 是否开启循环播放 | `Boolean` | `true` | - | -| vertical | 是否为纵向滚动 | `Boolean` | `false` | - | -| touchable | 是否可以通过手势滑动 | `Boolean` | `true` | - | -| show-indicators | 是否显示指示器 | `Boolean` | `true` | - | -| initial-swipe | 初始位置，从 0 开始算 | `Number` | `0` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| autoplay | 自动轮播间隔，单位为 ms | `Number` | - | +| duration | 动画时长，单位为 ms | `Number` | `500` | +| loop | 是否开启循环播放 | `Boolean` | `true` | +| vertical | 是否为纵向滚动 | `Boolean` | `false` | +| touchable | 是否可以通过手势滑动 | `Boolean` | `true` | +| show-indicators | 是否显示指示器 | `Boolean` | `true` | +| initial-swipe | 初始位置，从 0 开始算 | `Number` | `0` | ### 事件 diff --git a/docs/markdown/zh-CN/switch-cell.md b/docs/markdown/zh-CN/switch-cell.md index 61aefdaea..4fcd0b042 100644 --- a/docs/markdown/zh-CN/switch-cell.md +++ b/docs/markdown/zh-CN/switch-cell.md @@ -50,12 +50,12 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 开关状态 | `Boolean` | - | - | -| title | 左侧标题 | `String` | `''` | - | -| loading | 是否为加载状态 | `Boolean` | `false` | - | -| disabled | 是否为禁用状态 | `Boolean` | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 开关状态 | `Boolean` | - | +| title | 左侧标题 | `String` | `''` | +| loading | 是否为加载状态 | `Boolean` | `false` | +| disabled | 是否为禁用状态 | `Boolean` | `false` | ### Event diff --git a/docs/markdown/zh-CN/switch.md b/docs/markdown/zh-CN/switch.md index 8693c0d3b..1ce04176e 100644 --- a/docs/markdown/zh-CN/switch.md +++ b/docs/markdown/zh-CN/switch.md @@ -63,12 +63,12 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 开关选中状态 | `Boolean` | `false` | - | -| loading | 是否为加载状态 | `Boolean` | `false` | - | -| disabled | 是否为禁用状态 | `Boolean` | `false` | - | -| size | 开关尺寸 | `String` | `30px` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 开关选中状态 | `Boolean` | `false` | +| loading | 是否为加载状态 | `Boolean` | `false` | +| disabled | 是否为禁用状态 | `Boolean` | `false` | +| size | 开关尺寸 | `String` | `30px` | ### Event diff --git a/docs/markdown/zh-CN/tabbar.md b/docs/markdown/zh-CN/tabbar.md index 59fdc9c2e..dd20c9e28 100644 --- a/docs/markdown/zh-CN/tabbar.md +++ b/docs/markdown/zh-CN/tabbar.md @@ -66,9 +66,9 @@ export default { ### Tabbar API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 当前选中标签的索引 | `Number` | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 当前选中标签的索引 | `Number` | - | ### Tabbar Event @@ -78,14 +78,14 @@ export default { ### TabbarItem API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| icon | 图标名称 | `String` | - | Icon 组件中可用的类型 | -| dot | 是否显示小红点 | `Boolean` | - | - | -| info | 图标右上角提示信息 | `String | Number` | - | - | -| url | 跳转链接 | `String` | - | - | -| to | 路由跳转对象，同 `vue-router` 的 to | `String | Object` | - | - | -| replace | 跳转时是否替换当前 history | `String` | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-----------| +| icon | 图标名称 (可选值见 Icon 组件) | `String` | - | +| dot | 是否显示小红点 | `Boolean` | - | +| info | 图标右上角提示信息 | `String | Number` | - | +| url | 跳转链接 | `String` | - | +| to | 路由跳转对象，同 `vue-router` 的 to | `String | Object` | - | +| replace | 跳转时是否替换当前 history | `String` | `false` | ### TabbarItem Slot diff --git a/docs/markdown/zh-CN/tag.md b/docs/markdown/zh-CN/tag.md index f505ba812..81758b30b 100644 --- a/docs/markdown/zh-CN/tag.md +++ b/docs/markdown/zh-CN/tag.md @@ -29,8 +29,8 @@ Vue.use(Tag); 标签 ``` -#### 标记样式 -通过`mark`设置为标记样式 +#### 圆角样式 +通过`mark`设置为圆角样式 ```html 标签 @@ -41,14 +41,14 @@ Vue.use(Tag); ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| type | 类型 | `String` | `''`| `primary` `success` `danger` | -| plain | 是否为空心样式 | `Boolean` | `false` | - | -| mark | 是否为标记样式 | `Boolean` | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| type | 类型，可选值为`primary` `success` `danger` | `String` | `''`| +| plain | 是否为空心样式 | `Boolean` | `false` | +| mark | 是否为圆角样式 | `Boolean` | `false` | ### Slot | 名称 | 说明 | |-----------|-----------| -| - | 自定义 Tag 显示内容 | +| default | 自定义 Tag 显示内容 | diff --git a/docs/markdown/zh-CN/toast.md b/docs/markdown/zh-CN/toast.md index a6955a265..5793c2d8a 100644 --- a/docs/markdown/zh-CN/toast.md +++ b/docs/markdown/zh-CN/toast.md @@ -94,11 +94,11 @@ toast2.clear(); ### Options -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| type | 提示类型 | `String` | `text` | `loading` `success` `fail` `html` | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| type | 提示类型，可选值为 `loading` `success` `fail` `html` | `String` | `text` | +| position | 位置，可选值为 `top` `middle` `bottom` | `String` | `middle` | | message | 内容 | `String` | `''` | - | -| position | 位置 | `String` | `middle` | `top` `bottom` | -| mask | 是否显示背景蒙层 | `Boolean` | `false` | - | -| forbidClick | 禁止背景点击 | `Boolean` | `false` | - | -| duration | 时长(ms) | `Number` | `3000` | 值为 0 时，toast 不会消失 | +| mask | 是否显示背景蒙层 | `Boolean` | `false` | +| forbidClick | 是否禁止背景点击 | `Boolean` | `false` | +| duration | 展示时长(ms)，值为 0 时，toast 不会消失 | `Number` | `3000` | diff --git a/docs/markdown/zh-CN/tree-select.md b/docs/markdown/zh-CN/tree-select.md index b0bce8e14..35d6162fd 100644 --- a/docs/markdown/zh-CN/tree-select.md +++ b/docs/markdown/zh-CN/tree-select.md @@ -48,13 +48,14 @@ export default { #### 传入参数 -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| items | 分类显示所需的数据，具体数据结构可看 数据结构 | `Array` | `[]` | - | -| main-active-index | 左侧导航高亮的索引 | `Number` | `0` | - | -| active-id | 右侧选择项，高亮的数据id | `Number` | `0` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| items | 分类显示所需的数据，具体数据结构可看 数据结构 | `Array` | `[]` | +| main-active-index | 左侧导航高亮的索引 | `Number` | `0` | +| active-id | 右侧选择项，高亮的数据id | `Number` | `0` | #### 事件 + | 事件名 | 说明 | 参数 | |-----------|-----------|-----------| | navclick | 左侧导航点击时，触发的事件 | index：被点击的导航的索引 | diff --git a/docs/markdown/zh-CN/uploader.md b/docs/markdown/zh-CN/uploader.md index eb1892c52..f413b3806 100644 --- a/docs/markdown/zh-CN/uploader.md +++ b/docs/markdown/zh-CN/uploader.md @@ -38,14 +38,14 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| result-type | 文件读取结果类型 | `String` | `dataUrl` | `text` | -| accept | 接受的文件类型 | `String` | `image/*` | - | -| disabled | 是否禁用图片上传 | `Boolean` | `false` | - | -| before-read | 读取前的回调函数，返回 false 可终止文件读取 | `Function` | - | - | -| after-read | 读取完成后的回调函数 | `Function` | - | - | -| max-size | 文件大小限制，单位为 byte | `Number` | - | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| result-type | 文件读取结果类型，可选值为 `dataUrl` `test` | `String` | `dataUrl` | +| accept | 接受的文件类型 | `String` | `image/*` | +| disabled | 是否禁用图片上传 | `Boolean` | `false` | +| before-read | 读取前的回调函数，返回 false 可终止文件读取 | `Function` | - | +| after-read | 读取完成后的回调函数 | `Function` | - | +| max-size | 文件大小限制，单位为 byte | `Number` | - | ### Event diff --git a/docs/markdown/zh-CN/waterfall.md b/docs/markdown/zh-CN/waterfall.md index a6bd9075f..de2b1cce4 100644 --- a/docs/markdown/zh-CN/waterfall.md +++ b/docs/markdown/zh-CN/waterfall.md @@ -73,9 +73,9 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-waterfall-lower | 滚动到底部, 触发执行的函数 | `Function` | - | - | -| v-waterfall-upper | 滚动到顶部, 触发执行的函数 | `Function` | - | - | -| waterfall-disabled | 在 vue 对象中表示是否禁止瀑布流触发的 key 值 | `String` | - | - | -| waterfall-offset | 触发瀑布流加载的阈值 | `Number` | `300` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-waterfall-lower | 滚动到底部, 触发执行的函数 | `Function` | - | +| v-waterfall-upper | 滚动到顶部, 触发执行的函数 | `Function` | - | +| waterfall-disabled | 在 vue 对象中表示是否禁止瀑布流触发的 key 值 | `String` | - | +| waterfall-offset | 触发瀑布流加载的阈值 | `Number` | `300` |