[Doc] remove Accepted Values (#990)

This commit is contained in:
neverland 2018-05-05 09:47:19 +08:00 committed by GitHub
parent ac00ca6f79
commit b39853f1bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
77 changed files with 698 additions and 691 deletions

View File

@ -28,7 +28,7 @@ export default {
i18n: { i18n: {
'zh-CN': { 'zh-CN': {
title2: '空心样式', title2: '空心样式',
title3: '标记样式' title3: '圆角样式'
}, },
'en-US': { 'en-US': {
title2: 'Plain style', title2: 'Plain style',

View File

@ -63,14 +63,14 @@ Actionsheet will get another style if there is a `title` prop.
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| actions | Options | `Array` | `[]` | - | | actions | Options | `Array` | `[]` |
| title | Title | `String` | - | - | | title | Title | `String` | - |
| cancel-text | Text of cancel button | `String` | - | - | | cancel-text | Text of cancel button | `String` | - |
| overlay | Whether to show overlay | `Boolean` | - | - | | overlay | Whether to show overlay | `Boolean` | - |
| close-on-click-overlay | Whether to close when click overlay | `Boolean` | - | - | | close-on-click-overlay | Whether to close when click overlay | `Boolean` | - |
| get-container | Return the mount node for actionsheet | `Function` | - | `() => HTMLElement` | | get-container | Return the mount node for actionsheet | `() => HTMLElement` | - |
### Event ### Event

View File

@ -59,18 +59,18 @@ export default {
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| area-list | Area List | `Object` | - | - | | area-list | Area List | `Object` | - |
| address-info | Address Info | `Object` | `{}` | - | | address-info | Address Info | `Object` | `{}` |
| search-result | Address search result | `Array` | `[]` | - | | search-result | Address search result | `Array` | `[]` |
| show-postal | Whether to show postal field | `Boolean` | `false` | - | | show-postal | Whether to show postal field | `Boolean` | `false` |
| show-delete | Whether to show delete button | `Boolean` | `false` | - | | show-delete | Whether to show delete button | `Boolean` | `false` |
| show-set-default | Whether to show default address switch | `Boolean` | `false` | - | | show-set-default | Whether to show default address switch | `Boolean` | `false` |
| show-search-result | Whether to show address search result | `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-saving | Whether to show save button loading status | `Boolean` | `false` |
| is-deleting | Whether to show delete button loading status | `Boolean` | `false` | - | | is-deleting | Whether to show delete button loading status | `Boolean` | `false` |
| tel-validator | The method to validate tel | `(tel: string) => boolean` | - | - | | tel-validator | The method to validate tel | `(tel: string) => boolean` | - |
### Event ### Event

View File

@ -55,11 +55,11 @@ export default {
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | Id of chosen address | String | - | - | | v-model | Id of chosen address | String | - |
| list | Address list | Array | `[]` | - | | list | Address list | Array | `[]` |
| add-button-text | Add button text | String | `Add new address` | - | | add-button-text | Add button text | String | `Add new address` |
### Event ### Event

View File

@ -39,15 +39,15 @@ Set `columns-num` with 2, you'll have a 2 level picker.
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| value | the `code` of selected area | `String` | - | - | | value | the `code` of selected area | `String` | - |
| title | Toolbar title | `String` | `''` | - | | title | Toolbar title | `String` | - |
| area-list | an object contains these properties: `province_list`, `city_list` and `county_list` | `Object` | - | - | | area-list | Area data | `Object` | - |
| columns-num | level of picker | `String`,`Number` | 3 | - | | columns-num | level of picker | `String | Number` | `3` |
| item-height | Option height | `Number` | `44` | - | | item-height | Option height | `Number` | `44` |
| loading | Whether to show loading prompt | `Boolean` | `false` | - | | loading | Whether to show loading prompt | `Boolean` | `false` |
| visible-item-count | Count of visible columns | `Number` | `5` | - | | visible-item-count | Count of visible columns | `Number` | `5` |
### Event ### Event

View File

@ -39,13 +39,13 @@ export default {
### BadgeGroup API ### BadgeGroup API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| active-key | Index of chosen badge | `String | Number` | `0` | - | | active-key | Index of chosen badge | `String | Number` | `0` |
### Badge API ### Badge API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| title | Content | `String` | `''` | - | | title | Content | `String` | `''` |
| info | Info Message | `String | Number` | `''` | - | | info | Info Message | `String | Number` | `''` |
| url | Link | `String` | - | - | | url | Link | `String` | - |

View File

@ -41,15 +41,15 @@ Use `slot` to custom content.
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| thumb | Left thumb | `String` | - | - | | thumb | Left thumb | `String` | - |
| title | Title | `String` | - | - | | title | Title | `String` | - |
| desc | Description | `String` | - | - | | desc | Description | `String` | - |
| num | Number of goods | `String | Number` | - | - | | num | Number of goods | `String | Number` | - |
| price | Price of goods | `String | Number` | - | - | | price | Price of goods | `String | Number` | - |
| centered | Whether content vertical centered | `String` | `false` | - | | centered | Whether content vertical centered | `String` | `false` |
| currency | Currency symbol | `String` | `¥` | - | | currency | Currency symbol | `String` | `¥` |
### Slot ### Slot

View File

@ -58,11 +58,11 @@ export default {
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| left-width | Width of the left scrollable area | `Number` | `0` | - | | left-width | Width of the left scrollable area | `Number` | `0` |
| right-width | Width of the right scrollable area | `Number` | `0` | - | | right-width | Width of the right scrollable area | `Number` | `0` |
| on-close | Callback function before close | `Function` | - | - | | on-close | Callback function before close | `Function` | - |
### Slot ### Slot

View File

@ -62,26 +62,26 @@ Vue.use(Cell).use(CellGroup);
### CellGroup API ### CellGroup API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| border | Whether to show outer border | `Boolean` | `true` | - | | border | Whether to show outer border | `Boolean` | `true` |
### Cell API ### Cell API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| icon | Left Icon | `String` | - | - | | icon | Left Icon | `String` | - |
| title | Title | `String` | - | - | | title | Title | `String` | - |
| value | Right text | `String` | - | - | | value | Right text | `String` | - |
| label | Description below the title | `String` | - | - | | label | Description below the title | `String` | - |
| border | Whether to show inner border | `Boolean` | `true` | - | | border | Whether to show inner border | `Boolean` | `true` |
| center | Whether to center content vertically | `Boolean` | `true` | - | | center | Whether to center content vertically | `Boolean` | `true` |
| url | Link | `String` | - | - | | url | Link | `String` | - |
| to | Target route of the link, same as to of `vue-router` | `String | Object` | - | - | | 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` | - | | replace | If true, the navigation will not leave a history record | `String` | `false` |
| clickable | Whether to show click feedback when clicked | `Boolean` | `false` | - | | clickable | Whether to show click feedback when clicked | `Boolean` | `false` |
| is-link | Whether to show link icon | `Boolean` | `false` | - | | is-link | Whether to show link icon | `Boolean` | `false` |
| required | Whether to show required mark | `Boolean` | `false` | - | | required | Whether to show required mark | `Boolean` | `false` |
### Cell Event ### Cell Event

View File

@ -55,18 +55,18 @@ export default {
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | Current rate | `Number` | - | - | | v-model | Current rate | `Number` | - |
| rate | Target rate | `Number` | `100` | - | | rate | Target rate | `Number` | `100` |
| size | Circle size | `String` | `100px` | - | | size | Circle size | `String` | `100px` |
| color | Progress bar color | `String` | `#38f` | - | | color | Progress bar color | `String` | `#38f` |
| layer-color | Layer color | `String` | `#fff` | - | | layer-color | Layer color | `String` | `#fff` |
| fill | Fill color | `String` | `none` | - | | fill | Fill color | `String` | `none` |
| speed | Animate speedrate/s| `Number` | - | - | | speed | Animate speedrate/s| `Number` | - |
| text | Text | `String` | - | - | | text | Text | `String` | - |
| stroke-width | Stroke width | `Number` | `40` | - | | stroke-width | Stroke width | `Number` | `40` |
| clockwise | Is clockwise | `Boolean` | `true` | - | | clockwise | Is clockwise | `Boolean` | `true` |
### Cell Slot ### Cell Slot

View File

@ -69,10 +69,10 @@ export default {
### Collapse API ### Collapse API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | names of current active panels | `Array | String | Number` | - | - | | v-model | names of current active panels | `Array | String | Number` | - |
| accordion | Whether to be accordion mode | `Boolean` | `false` | - | | accordion | Whether to be accordion mode | `Boolean` | `false` |
### Collapse Event ### Collapse Event
@ -82,10 +82,10 @@ export default {
### CollapseItem API ### CollapseItem API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| name | Name | `String | Number` | `index` | - | | name | Name | `String | Number` | `index` |
| title | Title | `String` | - | - | | title | Title | `String` | - |
### CollapseItem Slot ### CollapseItem Slot

View File

@ -140,11 +140,11 @@ export default {
| add-text | Add card text | `String` | `Add contact info` | - | | add-text | Add card text | `String` | `Add contact info` | - |
### ContactList API ### ContactList API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|-------------|
| v-model | Id of chosen contact | `String | Number` | - | - | | v-model | Id of chosen contact | `String | Number` | - |
| list | Contact list | `Array` | `[]` | - | | list | Contact list | `Array` | `[]` |
| add-text | Add button text | `String` | `Add new contact` | - | | add-text | Add button text | `String` | `Add new contact` |
### ContactList Event ### ContactList Event
@ -155,13 +155,13 @@ export default {
| select | Triggered when select contact | item: contact object | | select | Triggered when select contact | item: contact object |
### ContactEdit API ### ContactEdit API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|-------------|
| contact-info | Contact Info | `Object` | `[]` | - | | contact-info | Contact Info | `Object` | `[]` |
| is-edit | Whether is editing | `Boolean` | `false` | - | | is-edit | Whether is editing | `Boolean` | `false` |
| is-saving | Whether to show save button loading status | `Boolean` | `false` | - | | is-saving | Whether to show save button loading status | `Boolean` | `false` |
| is-deleting | Whether to show delete button loading status | `Boolean` | `false` | - | | is-deleting | Whether to show delete button loading status | `Boolean` | `false` |
| tel-validator | The method to validate tel | `(tel: string) => boolean` | - | - | | tel-validator | The method to validate tel | `(tel: string) => boolean` | - |
### ContactEdit Event ### ContactEdit Event

View File

@ -67,29 +67,29 @@ export default {
### CouponCell API ### CouponCell API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| title | Cell title | `String` | `Coupon` | - | | title | Cell title | `String` | `Coupon` |
| chosen-coupon | Index of chosen coupon | `Number` | `-1` | - | | chosen-coupon | Index of chosen coupon | `Number` | `-1` |
| coupons | Coupon list | `Array` | `[]` | - | | coupons | Coupon list | `Array` | `[]` |
| editable | Cell editable | `Boolean` | `true` | - | | editable | Cell editable | `Boolean` | `true` |
### CouponList API ### CouponList API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | Current exchange code | `String` | - | - | | v-model | Current exchange code | `String` | - |
| chosen-coupon | Index of chosen coupon | `Number` | `-1` | - | | chosen-coupon | Index of chosen coupon | `Number` | `-1` |
| coupons | Coupon list | `Array` | `[]` | - | | coupons | Coupon list | `Array` | `[]` |
| disabled-coupons | Disabled voupon list | `Array` | `[]` | - | | disabled-coupons | Disabled voupon list | `Array` | `[]` |
| exchange-button-text | Exchange button text | `String` | `Exchange` | - | | exchange-button-text | Exchange button text | `String` | `Exchange` |
| exchange-button-loading | Whether to show loading in exchange button | `Boolean` | `false` | - | | exchange-button-loading | Whether to show loading in exchange button | `Boolean` | `false` |
| exchange-button-disabled | Whether to disable 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` | - | | exchange-min-length | Min length to enable exchange button | `Number` | `1` |
| displayed-coupon-index | Index of displayed coupon | `Number` | - | - | | displayed-coupon-index | Index of displayed coupon | `Number` | - |
| close-button-text | Close button text | `String` | `Close` | - | | close-button-text | Close button text | `String` | `Close` |
| disabled-list-title | Disabled list title | `String` | `Unavailable` | - | | disabled-list-title | Disabled list title | `String` | `Unavailable` |
| input-placeholder | Input placeholder | `String` | `Coupon code` | - | | input-placeholder | Input placeholder | `String` | `Coupon code` |
### CouponList Event ### CouponList Event

View File

@ -66,18 +66,18 @@ export default {
### Options ### Options
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| title | Title | `String` | - | - | | title | Title | `String` | - |
| message | Message | `String` | - | - | | message | Message | `String` | - |
| showConfirmButton | Whether to show confirm button | `Boolean` | `true` | - | | showConfirmButton | Whether to show confirm button | `Boolean` | `true` |
| showCancelButton | Whether to show cancel button | `Boolean` | `false` | - | | showCancelButton | Whether to show cancel button | `Boolean` | `false` |
| confirmButtonText | Confirm button text | `String` | `Confirm` | - | | confirmButtonText | Confirm button text | `String` | `Confirm` |
| cancelButtonText | Cancel button test | `String` | `Cancel` | - | | cancelButtonText | Cancel button test | `String` | `Cancel` |
| overlay | Whether to show overlay | `Boolean` | `true` | - | | overlay | Whether to show overlay | `Boolean` | `true` |
| closeOnClickOverlay | Whether to close when click overlay | `Boolean` | `false` | - | | closeOnClickOverlay | Whether to close when click overlay | `Boolean` | `false` |
| lockScroll | Whether to lock body scroll | `Boolean` | `true` | - | | lockScroll | Whether to lock body scroll | `Boolean` | `true` |
| beforeClose | Callback before closecall done to close dialog | (action: string, done: function) => void | - | - | | beforeClose | Callback before closecall done to close dialog | (action: string, done: function) => void | - |
#### Advanced Usage #### Advanced Usage
If you need to render vue components within a dialog, you can use dialog component. If you need to render vue components within a dialog, you can use dialog component.
@ -124,20 +124,20 @@ export default {
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | Whether to show dialog | `Boolean` | - | - | | v-model | Whether to show dialog | `Boolean` | - |
| title | Title | `String` | - | - | | title | Title | `String` | - |
| message | Message | `String` | - | - | | message | Message | `String` | - |
| async-confirm | Whether to close asyncThe incoming function is triggered when you click confirm. | `Function` | - | - | | async-confirm | Whether to close asyncThe incoming function is triggered when you click confirm. | `Function` | - |
| show-confirm-button | Whether to show confirm button | `Boolean` | `true` | - | | show-confirm-button | Whether to show confirm button | `Boolean` | `true` |
| show-cancel-button | Whether to show cancel button | `Boolean` | `false` | - | | show-cancel-button | Whether to show cancel button | `Boolean` | `false` |
| confirm-button-text | Confirm button text | `String` | `Confirm` | - | | confirm-button-text | Confirm button text | `String` | `Confirm` |
| cancel-button-text | Cancel button test | `String` | `Cancel` | - | | cancel-button-text | Cancel button test | `String` | `Cancel` |
| overlay | Whether to show overlay | `Boolean` | `true` | - | | overlay | Whether to show overlay | `Boolean` | `true` |
| close-on-click-overlay | Whether to close when click overlay | `Boolean` | `false` | - | | close-on-click-overlay | Whether to close when click overlay | `Boolean` | `false` |
| lock-scroll | Whether to lock background scroll | `Boolean` | `true` | - | | lock-scroll | Whether to lock background scroll | `Boolean` | `true` |
| before-close | Callback before closecall done to close dialog | (action: string, done: function) => void | - | - | | before-close | Callback before closecall done to close dialog | (action: string, done: function) => void | - |
### Event ### Event

View File

@ -56,23 +56,23 @@ Use `info` prop to show messages in upper right corner of icon
#### GoodsActionMiniBtn #### GoodsActionMiniBtn
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| text | Button text | `String` | - | - | | text | Button text | `String` | - |
| icon | Icon | `String` | - | - | | icon | Icon | `String` | - |
| icon-class | Icon class name | `String` | `''` | - | | icon-class | Icon class name | `String` | `''` |
| info | Info message | `String | Number` | - | - | | info | Info message | `String | Number` | - |
| url | Link | `String` | - | - | | url | Link | `String` | - |
| to | Target route of the link, same as to of `vue-router` | `String | Object` | - | - | | 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` | - | | replace | If true, the navigation will not leave a history record | `String` | `false` |
#### GoodsActionBigBtn #### GoodsActionBigBtn
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| text | Button text | `String` | - | - | | text | Button text | `String` | - |
| primary | Is primary button (red color) | `Boolean` | `false` | - | | primary | Is primary button (red color) | `Boolean` | `false` |
| url | Link | `String` | - | - | | url | Link | `String` | - |
| to | Target route of the link, same as to of `vue-router` | `String | Object` | - | - | | 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` | - | | replace | If true, the navigation will not leave a history record | `String` | `false` |

View File

@ -46,10 +46,10 @@ import 'vant/lib/vant-css/icon-local.css';
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| name | Icon name | `String` | `''` | - | | name | Icon name | `String` | `''` |
| info | Info message | `String | Number` | `''` | - | | info | Info message | `String | Number` | `''` |
### Event ### Event

View File

@ -52,12 +52,14 @@ Set grid spacing using `gutter` attribute. The default value is 0
### API ### API
#### Row #### Row
| Attribute | Description | Type | Default | Accepted Values |
|-----------|-----------|-----------|-------------|-------------| | Attribute | Description | Type | Default |
| gutter | grid spacingpx | `String | Number` | - | - | |-----------|-----------|-----------|-------------|
| gutter | grid spacingpx | `String | Number` | - |
#### Column #### Column
| Attribute | Description | Type | Default | Accepted Values |
|-----------|-----------|-----------|-------------|-------------| | 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` | - | - | | span | number of column the grid spans | `String | Number` | - |
| offset | number of spacing on the left side of the grid | `String | Number` | - |

View File

@ -47,15 +47,15 @@ Use `v-lazy:background-image` to set background url, and declare the height of t
### Options ### Options
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| loading | Src of the image while loading | `String` | - | - | | loading | Src of the image while loading | `String` | - |
| error | Src of the image upon load fail | `String` | - | - | | error | Src of the image upon load fail | `String` | - |
| preload | Proportion of pre-loading height | `String` | - | - | | preload | Proportion of pre-loading height | `String` | - |
| attempt | Attempts count | `Number` | `3` | - | | attempt | Attempts count | `Number` | `3` |
| listenEvents | Events that you want vue listen for | `Array` | `scroll`... | - | | listenEvents | Events that you want vue listen for | `Array` | `scroll`... |
| adapter | Dynamically modify the attribute of element | `Object` | - | - | | adapter | Dynamically modify the attribute of element | `Object` | - |
| filter | The image's listener filter | `Object` | - | - | | filter | The image's listener filter | `Object` | - |
| lazyComponent | Lazyload component | `Boolean` | `false` | - | | lazyComponent | Lazyload component | `Boolean` | `false` |
See more[ vue-lazyload ](https://github.com/hilongjw/vue-lazyload) See more[ vue-lazyload ](https://github.com/hilongjw/vue-lazyload)

View File

@ -51,13 +51,13 @@ export default {
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| loading | Whether to show loading infothe `load` event will not be triggered when loading | `Boolean` | `false` | - | | loading | Whether to show loading infothe `load` event will not be triggered when loading | `Boolean` | `false` |
| finished | Whether loading is finishedthe `load` event will not be triggered when finished | `Boolean` | `false` | - | | finished | Whether loading is finishedthe `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` | - | | 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...` | - | | loading-text | Loading text | `String` | `Loading...` |
| immediate-check | Whether to check loading position immediately after mounted | `Boolean` | `true` | - | | immediate-check | Whether to check loading position immediately after mounted | `Boolean` | `true` |
### Event ### Event

View File

@ -45,14 +45,15 @@ export default {
### API ### API
| Attribute | Description | Type | Default | Accepted Values |
|-----------|-----------|-----------|-------------|-------------| | Attribute | Description | Type | Default |
| title | Title | `String` | `''` | - | |-----------|-----------|-----------|-------------|
| left-text | Left Text | `String` | `''` | - | | title | Title | `String` | `''` |
| right-text | Right Text | `String` | `''` | - | | left-text | Left Text | `String` | `''` |
| left-arrow | Whether to show left arrow | `Boolean` | `false` | - | | right-text | Right Text | `String` | `''` |
| fixed | Whether to fixed top | `Boolean` | `false` | - | | left-arrow | Whether to show left arrow | `Boolean` | `false` |
| z-index | Z-index | `Number` | `1` | - | | fixed | Whether to fixed top | `Boolean` | `false` |
| z-index | Z-index | `Number` | `1` |
### Slot ### Slot

View File

@ -31,11 +31,11 @@ Vue.use(Panel);
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| title | Title | `String` | - | - | | title | Title | `String` | - |
| desc | Description | `String` | - | - | | desc | Description | `String` | - |
| status | Status | `String` | - | - | | status | Status | `String` | - |
### Slot ### Slot

View File

@ -51,12 +51,12 @@ export default {
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| value | Password value | `String` | `''` | - | | value | Password value | `String` | `''` |
| length | Maxlength of password | `Number` | `6` | - | | length | Maxlength of password | `Number` | `6` |
| info | Bottom info | `String` | - | - | | info | Bottom info | `String` | - |
| error-info | Bottom error info | `String` | - | - | | error-info | Bottom error info | `String` | - |
### Event ### Event

View File

@ -126,17 +126,17 @@ When Picker columns data is acquired asynchronously, use `loading` prop to show
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| columns | Columns data | `Array` | `[]` | - | | columns | Columns data | `Array` | `[]` |
| show-toolbar | Whether to show toolbar | `Boolean` | `false` | - | | show-toolbar | Whether to show toolbar | `Boolean` | `false` |
| title | Toolbar title | `String` | `''` | - | | title | Toolbar title | `String` | `''` |
| loading | Whether to show loading prompt | `Boolean` | `false` | - | | loading | Whether to show loading prompt | `Boolean` | `false` |
| value-key | Key of option text | `String` | `text` | - | | value-key | Key of option text | `String` | `text` |
| item-height | Option height | `Number` | `44` | - | | item-height | Option height | `Number` | `44` |
| confirm-button-text | Text of confirm button | `String` | `Confirm` | - | | confirm-button-text | Text of confirm button | `String` | `Confirm` |
| cancel-button-text | Text of cancel button | `String` | `Cancel` | - | | cancel-button-text | Text of cancel button | `String` | `Cancel` |
| visible-item-count | Count of visible columns | `Number` | `5` | - | | visible-item-count | Count of visible columns | `Number` | `5` |
### Event ### Event
Picker events will pass different parameters according to the columns are single or multiple Picker events will pass different parameters according to the columns are single or multiple

View File

@ -39,11 +39,11 @@ Use `pivot-text` to custom textuse `color` to custom bar color
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| inactive | Whether to be gray | `Boolean` | `false` | - | | inactive | Whether to be gray | `Boolean` | `false` |
| percentage | Percentage | `Number` | `false` | `0-100` | | percentage | Percentage | `Number` | `false` |
| show-pivot | Whether to show text | `Boolean` | `true` | - | | show-pivot | Whether to show text | `Boolean` | `true` |
| pivot-text | Text | `String` | percentage | - | | pivot-text | Text | `String` | percentage |
| color | Color | `String` | `#38f` | hexvalue | | color | Color | `String` | `#38f` |
| text-color | Text color | `String` | `#fff` | hexvalue | | text-color | Text color | `String` | `#fff` |

View File

@ -41,14 +41,14 @@ export default {
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | Loading status | `Boolean` | - | - | | v-model | Loading status | `Boolean` | - |
| pulling-text | Text to show when pulling | `String` | `Pull to refresh...` | - | | pulling-text | Text to show when pulling | `String` | `Pull to refresh...` |
| loosing-text | Text to show when loosing | `String` | `Loose to refresh...` | - | | loosing-text | Text to show when loosing | `String` | `Loose to refresh...` |
| loading-text | Text to show when loading | `String` | `Loading...` | - | | loading-text | Text to show when loading | `String` | `Loading...` |
| animation-duration | Animation duration | `Number` | `300` | - | | animation-duration | Animation duration | `Number` | `300` |
| head-height | Height of head | `Number` | `50` | - | | head-height | Height of head | `Number` | `50` |
### Event ### Event

View File

@ -56,17 +56,17 @@ export default {
### Radio API ### Radio API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| name | Radio name | `any` | - | - | | name | Radio name | `any` | - |
| disabled | Whether to disable radio | `Boolean` | `false` | - | | disabled | Whether to disable radio | `Boolean` | `false` |
### RadioGroup API ### RadioGroup API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | Name of checked radio | `any` | - | - | | v-model | Name of checked radio | `any` | - |
| disabled | Diable all radios | `Boolean` | `false` | - | | disabled | Diable all radios | `Boolean` | `false` |
### RadioGroup Event ### RadioGroup Event

View File

@ -58,11 +58,11 @@ Use `action` slot to custom right button, `cancel` event will no longer be trigg
### API ### API
Search support all native properties of input tagsuch as `maxlength``placeholder``readonly``autofocus` Search support all native properties of input tagsuch as `maxlength``placeholder``readonly``autofocus`
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| placeholder | Input placeholder | `String` | - | - | | placeholder | Input placeholder | `String` | - |
| background | Background color | `String` | `#f2f2f2` | - | | background | Background color | `String` | `#f2f2f2` |
| show-action | Whether to show right button | `Boolean` | false | - | | show-action | Whether to show right button | `Boolean` | `false` |
### Event ### Event
Search support all native events of input tagsuch as `focus``blur``keypress` Search support all native events of input tagsuch as `focus``blur``keypress`

View File

@ -83,24 +83,24 @@ Vue.use(Sku);
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | Whether to show sku | `Boolean` | `false` | - | | v-model | Whether to show sku | `Boolean` | `false` |
| sku | Sku data | `Object` | - | - | | sku | Sku data | `Object` | - |
| goods | Goods info | `Object` | - | - | | goods | Goods info | `Object` | - |
| goods-id | Goods id | `String | Number` | - | - | | goods-id | Goods id | `String | Number` | - |
| hide-stock | Whether to hide stock | `Boolean` | `false` | - | | hide-stock | Whether to hide stock | `Boolean` | `false` |
| show-add-cart-btn | Whether to show cart button | `Boolean` | `true` | - | | show-add-cart-btn | Whether to show cart button | `Boolean` | `true` |
| quota | Quota (0 as no limit) | `Number` | `0` | - | | quota | Quota (0 as no limit) | `Number` | `0` |
| quota-used | Used quota | `Number` | `0` | - | | quota-used | Used quota | `Number` | `0` |
| reset-stepper-on-hide | Whether to reset stepper when hide | `Boolean` | `false` | - | | 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` | - | | reset-selected-sku-on-hide | Whether to reset selected sku when hide | `Boolean` | `false` |
| disable-stepper-input | Whether to disable stepper input | `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` | - | | close-on-click-overlay | Whether to close sku popup when click overlay | `Boolean` | `false` |
| stepper-title | Quantity title | `String` | `Quantity` | - | | stepper-title | Quantity title | `String` | `Quantity` |
| custom-stepper-config | Custom stepper related config | `Object` | `{}` | - | | custom-stepper-config | Custom stepper related config | `Object` | `{}` |
| message-config | Message related config | `Object` | `{}` | - | | message-config | Message related config | `Object` | `{}` |
| get-container | Return the mount node for sku | `Function` | - | `() => HTMLElement` | | get-container | Return the mount node for sku | `() => HTMLElement` | - |
### Event ### Event

View File

@ -62,16 +62,16 @@ Use slot to add custom contents.
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| price | Price | `Number` | - | - | | price | Price | `Number` | - |
| label | Price label | `String` | `合计:` | - | | label | Price label | `String` | `合计:` |
| button-text | Button text | `String` | - | - | | button-text | Button text | `String` | - |
| button-type | Button type | `String` | `danger` | - | | button-type | Button type | `String` | `danger` |
| tip | Tip | `String` | - | - | | tip | Tip | `String` | - |
| disabled | Whether to disable button | `Boolean` | `false` | - | | disabled | Whether to disable button | `Boolean` | `false` |
| loading | Whether to show loading icon | `Boolean` | `false` | - | | loading | Whether to show loading icon | `Boolean` | `false` |
| currency | Currency symbol | `String` | `¥` | - | | currency | Currency symbol | `String` | `¥` |
### Event ### Event

View File

@ -79,15 +79,15 @@ export default {
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| autoplay | Autoplay interval (ms) | `Number` | - | - | | autoplay | Autoplay interval (ms) | `Number` | - |
| duration | Animation duration (ms) | `Number` | `500` | - | | duration | Animation duration (ms) | `Number` | `500` |
| loop | Whether to enable loop | `Boolean` | `true` | - | | loop | Whether to enable loop | `Boolean` | `true` |
| vertical | Vertical Scrolling | `Boolean` | `false` | - | | vertical | Vertical Scrolling | `Boolean` | `false` |
| touchable | Whether touchable | `Boolean` | `true` | - | | touchable | Whether touchable | `Boolean` | `true` |
| show-indicators | Whether to show indocators | `Boolean` | `true` | - | | show-indicators | Whether to show indocators | `Boolean` | `true` |
| initial-swipe | Index of initial swipe, start from 0 | `Number` | `0` | - | | initial-swipe | Index of initial swipe, start from 0 | `Number` | `0` |
### Event ### Event

View File

@ -50,12 +50,12 @@ use `loading` property to keep component in loading state
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | on-off state of the switch | `Boolean` | - | - | | v-model | on-off state of the switch | `Boolean` | - |
| title | the leftside title | `String` | `''` | - | | title | the leftside title | `String` | `''` |
| loading | whether the component is in loading state | `Boolean` | `false` | - | | loading | whether the component is in loading state | `Boolean` | `false` |
| disabled | whether to disable the component | `Boolean` | `false` | - | | disabled | whether to disable the component | `Boolean` | `false` |
### Event ### Event

View File

@ -67,12 +67,12 @@ export default {
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | Check status of Switch | `Boolean` | `false` | - | | v-model | Check status of Switch | `Boolean` | `false` |
| loading | Whether to show loading icon | `Boolean` | `false` | - | | loading | Whether to show loading icon | `Boolean` | `false` |
| disabled | Whether to disable switch | `Boolean` | `false` | - | | disabled | Whether to disable switch | `Boolean` | `false` |
| size | Size of switch | `String` | `30px` | - | | size | Size of switch | `String` | `30px` |
### Event ### Event

View File

@ -62,9 +62,9 @@ export default {
### Tabbar API ### Tabbar API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | Index of current tab | `Number` | - | - | | v-model | Index of current tab | `Number` | - |
### Tabbar Event ### Tabbar Event
@ -74,14 +74,14 @@ export default {
### TabbarItem API ### TabbarItem API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| icon | Icon name | `String` | - | Names from Icon Component | | icon | Icon name | `String` | - |
| dot | Whether to show red dot | `Boolean` | - | - | | dot | Whether to show red dot | `Boolean` | - |
| info | Info message | `String | Number` | - | - | | info | Info message | `String | Number` | - |
| url | Link | `String` | - | - | | url | Link | `String` | - |
| to | Target route of the link, same as to of `vue-router` | `String | Object` | - | - | | 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` | - | | replace | If true, the navigation will not leave a history record | `String` | `false` |
### TabbarItem Slot ### TabbarItem Slot

View File

@ -38,11 +38,11 @@ Vue.use(Tag);
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| type | Type | `String` | `''`| `primary` `success` `danger` | | type | Type, can be set to `primary` `success` `danger` | `String` | `''`|
| plain | Whether to be plain style | `Boolean` | `false` | - | | plain | Whether to be plain style | `Boolean` | `false` |
| mark | Wtether to be mark style | `Boolean` | `false` | - | | mark | Wtether to be mark style | `Boolean` | `false` |
### Slot ### Slot

View File

@ -93,11 +93,11 @@ toast2.clear();
### Options ### Options
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| type | Type | `String` | `text` | `loading` `success` `fail` `html` | | type | Can be set to `loading` `success` `fail` `html` | `String` | `text` |
| message | Message | `String` | `''` | - | | position | Can be set to `top` `middle` `bottom` | `String` | `middle` |
| position | Position | `String` | `middle` | `top` `bottom` | | message | Message | `String` | `''` |
| mask | Whether to show mask | `Boolean` | `false` | - | | mask | Whether to show mask | `Boolean` | `false` |
| forbidClick | Whether to forbid click background | `Boolean` | `false` | - | | forbidClick | Whether to forbid click background | `Boolean` | `false` |
| duration | Toast duration(ms) | `Number` | `3000` | Toast won't disappear if value is 0 | | duration | Toast duration(ms), won't disappear if value is 0 | `Number` | `3000` |

View File

@ -47,11 +47,11 @@ export default {
#### API #### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| items | Required datasets for the component, see Data Structure for detail. | `Array` | `[]` | - | | items | Required datasets for the component, see Data Structure for detail. | `Array` | `[]` |
| main-Active-index | The index of selected parent node | `Number` | `0` | - | | main-Active-index | The index of selected parent node | `Number` | `0` |
| active-id | Id of selected item | `Number` | `0` | - | | active-id | Id of selected item | `Number` | `0` |
#### Event #### Event
| Event | Description | Arguments | | Event | Description | Arguments |

View File

@ -40,14 +40,14 @@ You can set native properties such as `accpet`、`multiple` on Uploader, and the
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| result-type | Type of file read result | `String` | `dataUrl` | `text` | | result-type | Type of file read result, can be set to `dataUrl` `text` | `String` | `dataUrl` |
| accept | Accepted file type | `String` | `image/*` | - | | accept | Accepted file type | `String` | `image/*` |
| disabled | Whether to disabled the upload | `Boolean` | `false` | - | | disabled | Whether to disabled the upload | `Boolean` | `false` |
| before-read | Hook before reading the file, return false to stop reading the file | `Function` | - | - | | before-read | Hook before reading the file, return false to stop reading the file | `Function` | - |
| after-read | Hook after reading the file | `Function` | - | - | | after-read | Hook after reading the file | `Function` | - |
| max-size | Max size of file | `Number` | - | - | | max-size | Max size of file | `Number` | - |
### Event ### Event

View File

@ -69,9 +69,9 @@ export default {
### API ### API
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-waterfall-lower | Function to trigger when scroll to bottom | `Function` | - | - | | v-waterfall-lower | Function to trigger when scroll to bottom | `Function` | - |
| v-waterfall-upper | Function to trigger when scroll to top | `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-disabled | Key of the property to control disable status in instance | `String` | - |
| waterfall-offset | Offset to trigger callback function | `Number` | `300` | - | | waterfall-offset | Offset to trigger callback function | `Number` | `300` |

View File

@ -66,14 +66,14 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| actions | 行动按钮数组 | `Array` | `[]` | - | | actions | 行动按钮数组 | `Array` | `[]` |
| title | 标题 | `String` | - | - | | title | 标题 | `String` | - |
| cancel-text | 取消按钮文案 | `String` | - | - | | cancel-text | 取消按钮文案 | `String` | - |
| overlay | 是否显示遮罩 | `Boolean` | - | - | | overlay | 是否显示遮罩 | `Boolean` | - |
| close-on-click-overlay | 点击遮罩是否关闭`Actionsheet` | `Boolean` | - | - | | close-on-click-overlay | 点击遮罩是否关闭`Actionsheet` | `Boolean` | - |
| get-container | 指定挂载的 HTML 节点 | `Function` | - | `() => HTMLElement` | | get-container | 指定挂载的 HTML 节点 | `() => HTMLElement` | - |
### Event ### Event

View File

@ -57,18 +57,18 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| area-list | 地区列表 | `Object` | - | - | | area-list | 地区列表 | `Object` | - |
| address-info | 收货人信息 | `Object` | `{}` | - | | address-info | 收货人信息 | `Object` | `{}` |
| search-result | 详细地址搜索结果 | `Array` | `[]` | - | | search-result | 详细地址搜索结果 | `Array` | `[]` |
| show-postal | 是否显示邮政编码 | `Boolean` | `false` | - | | show-postal | 是否显示邮政编码 | `Boolean` | `false` |
| show-delete | 是否显示删除按钮 | `Boolean` | `false` | - | | show-delete | 是否显示删除按钮 | `Boolean` | `false` |
| show-set-default | 是否显示默认地址栏 | `Boolean` | `false` | - | | show-set-default | 是否显示默认地址栏 | `Boolean` | `false` |
| show-search-result | 是否显示搜索结果 | `Boolean` | `false` | - | | show-search-result | 是否显示搜索结果 | `Boolean` | `false` |
| is-saving | 是否显示保存按钮加载动画 | `Boolean` | `false` | - | | is-saving | 是否显示保存按钮加载动画 | `Boolean` | `false` |
| is-deleting | 是否显示删除按钮加载动画 | `Boolean` | `false` | - | | is-deleting | 是否显示删除按钮加载动画 | `Boolean` | `false` |
| tel-validator | 手机号格式校验函数 | `(tel: string) => boolean` | - | - | | tel-validator | 手机号格式校验函数 | `(tel: string) => boolean` | - |
### Event ### Event

View File

@ -56,11 +56,11 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | 当前选中地址的 id | String | - | - | | v-model | 当前选中地址的 id | String | - |
| list | 地址列表 | Array | `[]` | - | | list | 地址列表 | Array | `[]` |
| add-button-text | 底部按钮文字 | String | `新增收货地址` | - | | add-button-text | 底部按钮文字 | String | `新增收货地址` |
### Event ### Event

View File

@ -37,15 +37,15 @@ Vue.use(Area);
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- |
| value | 当前选中的省市区`code` | `String` | - | - | | value | 当前选中的省市区`code` | `String` | - |
| title | 顶部栏标题 | `String` | `''` | - | | title | 顶部栏标题 | `String` | - |
| area-list | 省市县数据,格式见下方 | `Object` | - | - | | area-list | 省市县数据,格式见下方 | `Object` | - |
| columns-num | 省市县显示列数3-省市县2-省市1-省 | `String`,`Number` | `3` | - | | columns-num | 省市县显示列数3-省市县2-省市1-省 | `String | Number` | `3` |
| loading | 是否显示加载状态 | `Boolean` | `false` | - | | loading | 是否显示加载状态 | `Boolean` | `false` |
| item-height | 选项高度 | `Number` | `44` | - | | item-height | 选项高度 | `Number` | `44` |
| visible-item-count | 可见的选项个数 | `Number` | `5` | - | | visible-item-count | 可见的选项个数 | `Number` | `5` |
### Event ### Event

View File

@ -40,13 +40,13 @@ export default {
### BadgeGroup API ### BadgeGroup API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| active-key | 选中`badge`的索引 | `String | Number` | `0` | - | | active-key | 选中`badge`的索引 | `String | Number` | `0` |
### Badge API ### Badge API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| title | 内容 | `String` | `''` | - | | title | 内容 | `String` | `''` |
| info | 提示消息 | `String | Number` | `''` | - | | info | 提示消息 | `String | Number` | `''` |
| url | 跳转链接 | `String` | - | - | | url | 跳转链接 | `String` | - |

View File

@ -41,15 +41,15 @@ Vue.use(Card);
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| thumb | 左侧图片 | `String` | - | - | | thumb | 左侧图片 | `String` | - |
| title | 标题 | `String` | - | - | | title | 标题 | `String` | - |
| desc | 描述 | `String` | - | - | | desc | 描述 | `String` | - |
| num | 商品数量 | `String | Number` | - | - | | num | 商品数量 | `String | Number` | - |
| price | 商品价格 | `String | Number` | - | - | | price | 商品价格 | `String | Number` | - |
| centered | 内容是否垂直居中 | `String` | `false` | - | | centered | 内容是否垂直居中 | `String` | `false` |
| currency | 货币符号 | `String` | `¥` | - | | currency | 货币符号 | `String` | `¥` |
### Slot ### Slot

View File

@ -58,11 +58,11 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| left-width | 左侧滑动区域宽度 | `Number` | `0` | - | | left-width | 左侧滑动区域宽度 | `Number` | `0` |
| right-width | 右侧滑动区域宽度 | `Number` | `0` | - | | right-width | 右侧滑动区域宽度 | `Number` | `0` |
| on-close | 关闭时的回调函数 | `Function` | - | - | | on-close | 关闭时的回调函数 | `Function` | - |
### Slot ### Slot

View File

@ -69,26 +69,26 @@ Vue.use(Cell).use(CellGroup);
### CellGroup API ### CellGroup API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| border | 是否显示外边框 | `Boolean` | `true` | - | | border | 是否显示外边框 | `Boolean` | `true` |
### Cell API ### Cell API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| icon | 左侧图标 | `String` | - | - | | icon | 左侧图标 (可选值见 Icon 组件) | `String` | - |
| title | 左侧标题 | `String` | - | - | | title | 左侧标题 | `String` | - |
| value | 右侧内容 | `String` | - | - | | value | 右侧内容 | `String` | - |
| label | 标题下方的描述信息 | `String` | - | - | | label | 标题下方的描述信息 | `String` | - |
| border | 是否显示内边框 | `Boolean` | `true` | - | | border | 是否显示内边框 | `Boolean` | `true` |
| center | 是否使内容垂直居中 | `Boolean` | `false` | - | | center | 是否使内容垂直居中 | `Boolean` | `false` |
| url | 跳转链接 | `String` | - | - | | url | 跳转链接 | `String` | - |
| to | 路由跳转对象,同 `vue-router` 的 to | `String | Object` | - | - | | to | 路由跳转对象,同 `vue-router` 的 to | `String | Object` | - |
| replace | 跳转时是否替换当前 history | `String` | `false` | - | | replace | 跳转时是否替换当前 history | `String` | `false` |
| clickable | 是否开启点击反馈 | `Boolean` | `false` | - | | clickable | 是否开启点击反馈 | `Boolean` | `false` |
| is-link | 是否展示右侧箭头并开启点击反馈 | `Boolean` | `false` | - | | is-link | 是否展示右侧箭头并开启点击反馈 | `Boolean` | `false` |
| required | 是否显示表单必填星号 | `Boolean` | `false` | - | | required | 是否显示表单必填星号 | `Boolean` | `false` |
### Cell Event ### Cell Event

View File

@ -56,18 +56,18 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | 当前进度 | `Number` | - | - | | v-model | 当前进度 | `Number` | - |
| rate | 目标进度 | `Number` | `100` | - | | rate | 目标进度 | `Number` | `100` |
| size | 圆环直径 | `String` | `100px` | - | | size | 圆环直径 | `String` | `100px` |
| color | 进度条颜色 | `String` | `#38f` | - | | color | 进度条颜色 | `String` | `#38f` |
| layer-color | 轨道颜色 | `String` | `#fff` | - | | layer-color | 轨道颜色 | `String` | `#fff` |
| fill | 填充颜色 | `String` | `none` | - | | fill | 填充颜色 | `String` | `none` |
| speed | 动画速度(单位为 rate/s| `Number` | - | - | | speed | 动画速度(单位为 rate/s| `Number` | - |
| text | 文字 | `String` | - | - | | text | 文字 | `String` | - |
| stroke-width | 进度条宽度 | `Number` | `40` | - | | stroke-width | 进度条宽度 | `Number` | `40` |
| clockwise | 是否顺时针增加 | `Boolean` | `true` | - | | clockwise | 是否顺时针增加 | `Boolean` | `true` |
### Circle Slot ### Circle Slot

View File

@ -81,10 +81,10 @@ export default {
### Collapse API ### Collapse API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|-------------|
| v-model | 当前展开面板的 name | `Array | String | Number` | - | - | | v-model | 当前展开面板的 name | `Array | String | Number` | - |
| accordion | 是否开启手风琴模式 | `Boolean` | `false` | - | | accordion | 是否开启手风琴模式 | `Boolean` | `false` |
### Collapse Event ### Collapse Event
@ -94,10 +94,10 @@ export default {
### CollapseItem API ### CollapseItem API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|-------------|
| name | 面板唯一标识符,默认为索引值 | `String | Number` | `index` | - | | name | 面板唯一标识符,默认为索引值 | `String | Number` | `index` |
| title | 标题 | `String` | - | - | | title | 标题 | `String` | - |
### CollapseItem Slot ### CollapseItem Slot

View File

@ -140,11 +140,11 @@ export default {
| add-text | 添加时的文案提示 | `String` | `添加订单联系人信息` | - | | add-text | 添加时的文案提示 | `String` | `添加订单联系人信息` | - |
### ContactList API ### ContactList API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|-------------|
| v-model | 当前选中联系人的 id | `String | Number` | - | - | | v-model | 当前选中联系人的 id | `String | Number` | - |
| list | 联系人列表 | `Array` | `[]` | - | | list | 联系人列表 | `Array` | `[]` |
| add-text | 新建按钮文案 | `String` | `新建联系人` | - | | add-text | 新建按钮文案 | `String` | `新建联系人` |
### ContactList Event ### ContactList Event
@ -156,13 +156,13 @@ export default {
### ContactEdit API ### ContactEdit API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|-------------|
| contact-info | 联系人信息 | `Object` | `[]` | - | | contact-info | 联系人信息 | `Object` | `[]` |
| is-edit | 是否为编辑联系人 | `Boolean` | `false` | - | | is-edit | 是否为编辑联系人 | `Boolean` | `false` |
| is-saving | 是否显示保存按钮加载动画 | `Boolean` | `false` | - | | is-saving | 是否显示保存按钮加载动画 | `Boolean` | `false` |
| is-deleting | 是否显示删除按钮加载动画 | `Boolean` | `false` | - | | is-deleting | 是否显示删除按钮加载动画 | `Boolean` | `false` |
| tel-validator | 手机号格式校验函数 | `(tel: string) => boolean` | - | - | | tel-validator | 手机号格式校验函数 | `(tel: string) => boolean` | - |
### ContactEdit Event ### ContactEdit Event

View File

@ -68,31 +68,31 @@ export default {
### CouponCell API ### CouponCell API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| title | 单元格标题 | `String` | `优惠券码` | - | | title | 单元格标题 | `String` | `优惠券码` |
| chosen-coupon | 当前选中优惠券的索引 | `Number` | `-1` | - | | chosen-coupon | 当前选中优惠券的索引 | `Number` | `-1` |
| coupons | 可用优惠券列表 | `Array` | `[]` | - | | coupons | 可用优惠券列表 | `Array` | `[]` |
| editable | 能否切换优惠券 | `Boolean` | `true` | - | | editable | 能否切换优惠券 | `Boolean` | `true` |
### CouponList API ### CouponList API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | 当前输入的兑换码 | `String` | - | - | | v-model | 当前输入的兑换码 | `String` | - |
| chosen-coupon | 当前选中优惠券的索引 | `Number` | `-1` | - | | chosen-coupon | 当前选中优惠券的索引 | `Number` | `-1` |
| coupons | 可用优惠券列表 | `Array` | `[]` | - | | coupons | 可用优惠券列表 | `Array` | `[]` |
| disabled-coupons | 不可用优惠券列表 | `Array` | `[]` | - | | disabled-coupons | 不可用优惠券列表 | `Array` | `[]` |
| exchange-button-text | 兑换按钮文字 | `String` | `兑换` | - | | exchange-button-text | 兑换按钮文字 | `String` | `兑换` |
| exchange-button-loading | 是否在兑换按钮上显示加载动画 | `Boolean` | `false` | - | | exchange-button-loading | 是否在兑换按钮上显示加载动画 | `Boolean` | `false` |
| exchange-button-disabled | 是否禁用兑换按钮 | `Boolean` | `false` | - | | exchange-button-disabled | 是否禁用兑换按钮 | `Boolean` | `false` |
| exchange-min-length | 兑换码最小长度 | `Number` | `1` | - | | exchange-min-length | 兑换码最小长度 | `Number` | `1` |
| displayed-coupon-index | 滚动至特定优惠券位置 | `Number` | - | - | | displayed-coupon-index | 滚动至特定优惠券位置 | `Number` | - |
| show-close-button | 是否显示列表底部按钮 | `Boolean` | `true` | - | | show-close-button | 是否显示列表底部按钮 | `Boolean` | `true` |
| close-button-text | 列表底部按钮文字 | `String` | `不使用优惠` | - | | close-button-text | 列表底部按钮文字 | `String` | `不使用优惠` |
| disabled-list-title | 不可用券列表标题 | `String` | `不可用优惠` | - | | disabled-list-title | 不可用券列表标题 | `String` | `不可用优惠` |
| input-placeholder | 输入框文字提示 | `String` | `请输入优惠码` | - | | input-placeholder | 输入框文字提示 | `String` | `请输入优惠码` |
| show-exchange-bar | 是否展示兑换栏 | `Boolean` | `true` | - | | show-exchange-bar | 是否展示兑换栏 | `Boolean` | `true` |
### CouponList Event ### CouponList Event

View File

@ -67,18 +67,18 @@ export default {
### Options ### Options
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| title | 标题 | `String` | - | - | | title | 标题 | `String` | - |
| message | 内容 | `String` | - | - | | message | 内容 | `String` | - |
| showConfirmButton | 是否展示确认按钮 | `Boolean` | `true` | - | | showConfirmButton | 是否展示确认按钮 | `Boolean` | `true` |
| showCancelButton | 是否展示取消按钮 | `Boolean` | `false` | - | | showCancelButton | 是否展示取消按钮 | `Boolean` | `false` |
| confirmButtonText | 确认按钮的文案 | `String` | `确认` | - | | confirmButtonText | 确认按钮的文案 | `String` | `确认` |
| cancelButtonText | 取消按钮的文案 | `String` | `取消` | - | | cancelButtonText | 取消按钮的文案 | `String` | `取消` |
| overlay | 是否展示蒙层 | `Boolean` | `true` | - | | overlay | 是否展示蒙层 | `Boolean` | `true` |
| closeOnClickOverlay | 点击蒙层时是否关闭弹窗 | `Boolean` | `false` | - | | closeOnClickOverlay | 点击蒙层时是否关闭弹窗 | `Boolean` | `false` |
| lockScroll | 是否锁定背景滚动 | `Boolean` | `true` | - | | lockScroll | 是否锁定背景滚动 | `Boolean` | `true` |
| beforeClose | 关闭前的回调函数,调用 done 后关闭弹窗 | (action: string, done: function) => void | - | - | | beforeClose | 关闭前的回调函数,调用 done 后关闭弹窗 | (action: string, done: function) => void | - |
#### 高级用法 #### 高级用法
@ -130,19 +130,19 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | 是否显示弹窗 | `Boolean` | - | - | | v-model | 是否显示弹窗 | `Boolean` | - |
| title | 标题 | `String` | - | - | | title | 标题 | `String` | - |
| message | 内容 | `String` | - | - | | message | 内容 | `String` | - |
| show-confirm-button | 是否展示确认按钮 | `Boolean` | `true` | - | | show-confirm-button | 是否展示确认按钮 | `Boolean` | `true` |
| show-cancel-button | 是否展示取消按钮 | `Boolean` | `false` | - | | show-cancel-button | 是否展示取消按钮 | `Boolean` | `false` |
| confirm-button-text | 确认按钮的文案 | `String` | `确认` | - | | confirm-button-text | 确认按钮的文案 | `String` | `确认` |
| cancel-button-text | 取消按钮的文案 | `String` | `取消` | - | | cancel-button-text | 取消按钮的文案 | `String` | `取消` |
| overlay | 是否展示蒙层 | `Boolean` | `true` | - | | overlay | 是否展示蒙层 | `Boolean` | `true` |
| close-on-click-overlay | 点击蒙层时是否关闭弹窗 | `Boolean` | `false` | - | | close-on-click-overlay | 点击蒙层时是否关闭弹窗 | `Boolean` | `false` |
| lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` | - | | lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` |
| before-close | 关闭前的回调函数,调用 done 后关闭弹窗 | (action: string, done: function) => void | - | - | | before-close | 关闭前的回调函数,调用 done 后关闭弹窗 | (action: string, done: function) => void | - |
### Event ### Event

View File

@ -122,7 +122,7 @@ Filed 默认支持 Input 标签所有的原生属性,比如 `maxlength`、`pla
| error | 输入框是否有错误 | `Boolean` | `false` | - | | error | 输入框是否有错误 | `Boolean` | `false` | - |
| error-message | 输入框底部错误提示文案 | `String` | `''` | - | | error-message | 输入框底部错误提示文案 | `String` | `''` | - |
| autosize | 自适应内容高度,只对 textarea 有效,可传入对象,如 { maxHeight: 100, minHeight: 50 },单位为 px | `Boolean | Object` | `false` | - | | autosize | 自适应内容高度,只对 textarea 有效,可传入对象,如 { maxHeight: 100, minHeight: 50 },单位为 px | `Boolean | Object` | `false` | - |
| icon | 输入框尾部图标 | `String` | - | Icon 组件支持的类型 | | icon | 输入框尾部图标 (可选值见 Icon 组件) | `String` | - | - |
### Event ### Event
Filed 默认支持 Input 标签所有的原生事件,如 `focus``blur``keypress` Filed 默认支持 Input 标签所有的原生事件,如 `focus``blur``keypress`

View File

@ -56,23 +56,23 @@ export default {
#### GoodsActionMiniBtn #### GoodsActionMiniBtn
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| text | 按钮文字 | `String` | - | - | | text | 按钮文字 | `String` | - |
| icon | 图标 | `String` | - | Icon 组件支持的所有图标 | | icon | 图标 | `String` | - |
| icon-class | 图标额外类名 | `String` | `''` | - | | icon-class | 图标额外类名 | `String` | `''` |
| info | 图标右上角提示信息 | `String | Number` | - | - | | info | 图标右上角提示信息 | `String | Number` | - |
| url | 跳转链接 | `String` | - | - | | url | 跳转链接 | `String` | - |
| to | 路由跳转对象,同 `vue-router` 的 to | `String | Object` | - | - | | to | 路由跳转对象,同 `vue-router` 的 to | `String | Object` | - |
| replace | 跳转时是否替换当前 history | `String` | `false` | - | | replace | 跳转时是否替换当前 history | `String` | `false` |
#### GoodsActionBigBtn #### GoodsActionBigBtn
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| text | 按钮文字 | `String` | - | - | | text | 按钮文字 | `String` | - |
| primary | 是否主行动按钮,主行动按钮默认为红色 | `Boolean` | `false` | - | | primary | 是否主行动按钮,主行动按钮默认为红色 | `Boolean` | `false` |
| url | 跳转链接 | `String` | - | - | | url | 跳转链接 | `String` | - |
| to | 路由跳转对象,同 `vue-router` 的 to | `String | Object` | - | - | | to | 路由跳转对象,同 `vue-router` 的 to | `String | Object` | - |
| replace | 跳转时是否替换当前 history | `String` | `false` | - | | replace | 跳转时是否替换当前 history | `String` | `false` |

View File

@ -47,10 +47,10 @@ import 'vant/lib/vant-css/icon-local.css';
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| name | 图标名称 | `String` | `''` | - | | name | 图标名称 | `String` | `''` |
| info | 图标右上角文字提示 | `String | Number` | `''` | - | | info | 图标右上角文字提示 | `String | Number` | `''` |
### Event ### Event

View File

@ -48,12 +48,14 @@ Layout 组件提供了`24列栅格`,通过在`Col`上添加`span`属性设置
### API ### API
#### Row #### Row
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
|-----------|-----------|-----------|-------------|-------------| | 参数 | 说明 | 类型 | 默认值 |
| gutter | 列元素之间的间距单位为px | `String | Number` | - | - | |-----------|-----------|-----------|-------------|
| gutter | 列元素之间的间距单位为px | `String | Number` | - |
#### Column #### Column
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
|-----------|-----------|-----------|-------------|-------------| | 参数 | 说明 | 类型 | 默认值 |
| span | 列元素宽度 | `String | Number` | - | - | |-----------|-----------|-----------|-------------|
| offset | 列元素偏移距离 | `String | Number` | - | - | | span | 列元素宽度 | `String | Number` | - |
| offset | 列元素偏移距离 | `String | Number` | - |

View File

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

View File

@ -51,13 +51,13 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| loading | 是否显示加载中提示,加载过程中不触发`load`事件 | `Boolean` | `false` | - | | loading | 是否显示加载中提示,加载过程中不触发`load`事件 | `Boolean` | `false` |
| finished | 是否已加载完成,加载完成后不再触发`load`事件 | `Boolean` | `false` | - | | finished | 是否已加载完成,加载完成后不再触发`load`事件 | `Boolean` | `false` |
| offset | 滚动条与底部距离小于 offset 时触发`load`事件 | `Number` | `300` | - | | offset | 滚动条与底部距离小于 offset 时触发`load`事件 | `Number` | `300` |
| loading-text | 加载中提示文案 | `String` | `加载中...` | - | | loading-text | 加载中提示文案 | `String` | `加载中...` |
| immediate-check | 是否在初始化时立即执行滚动位置检查 | `Boolean` | `true` | - | | immediate-check | 是否在初始化时立即执行滚动位置检查 | `Boolean` | `true` |
### Event ### Event

View File

@ -46,14 +46,15 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
|-----------|-----------|-----------|-------------|-------------| | 参数 | 说明 | 类型 | 默认值 |
| title | 标题 | `String` | `''` | - | |-----------|-----------|-----------|-------------|
| left-text | 左侧文案 | `String` | `''` | - | | title | 标题 | `String` | `''` |
| right-text | 右侧文案 | `String` | `''` | - | | left-text | 左侧文案 | `String` | `''` |
| left-arrow | 是否显示左侧箭头 | `Boolean` | `false` | - | | right-text | 右侧文案 | `String` | `''` |
| fixed | 是否固定在顶部 | `Boolean` | `false` | - | | left-arrow | 是否显示左侧箭头 | `Boolean` | `false` |
| z-index | 元素 z-index | `Number` | `1` | - | | fixed | 是否固定在顶部 | `Boolean` | `false` |
| z-index | 元素 z-index | `Number` | `1` |
### Slot ### Slot

View File

@ -33,11 +33,11 @@ Vue.use(Panel);
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| title | 标题 | `String` | - | - | | title | 标题 | `String` | - |
| desc | 描述 | `String` | - | - | | desc | 描述 | `String` | - |
| status | 状态 | `String` | - | - | | status | 状态 | `String` | - |
### Slot ### Slot

View File

@ -51,12 +51,12 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| value | 密码值 | `String` | `''` | - | | value | 密码值 | `String` | `''` |
| length | 密码最大长度 | `Number` | `6` | - | | length | 密码最大长度 | `Number` | `6` |
| info | 输入框下方提示 | `String` | - | - | | info | 输入框下方提示 | `String` | - |
| error-info | 输入框下方错误提示 | `String` | - | - | | error-info | 输入框下方错误提示 | `String` | - |
### Event ### Event

View File

@ -128,17 +128,17 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| columns | 对象数组,配置每一列显示的数据 | `Array` | `[]` | - | | columns | 对象数组,配置每一列显示的数据 | `Array` | `[]` |
| show-toolbar | 是否显示顶部栏 | `Boolean` | `false` | - | | show-toolbar | 是否显示顶部栏 | `Boolean` | `false` |
| title | 顶部栏标题 | `String` | `''` | - | | title | 顶部栏标题 | `String` | `''` |
| loading | 是否显示加载状态 | `Boolean` | `false` | - | | loading | 是否显示加载状态 | `Boolean` | `false` |
| value-key | 选项对象中,文字对应的 key | `String` | `text` | - | | value-key | 选项对象中,文字对应的 key | `String` | `text` |
| item-height | 选项高度 | `Number` | `44` | - | | item-height | 选项高度 | `Number` | `44` |
| confirm-button-text | 确认按钮文字 | `String` | `确认` | - | | confirm-button-text | 确认按钮文字 | `String` | `确认` |
| cancel-button-text | 取消按钮文字 | `String` | `取消` | - | | cancel-button-text | 取消按钮文字 | `String` | `取消` |
| visible-item-count | 可见的选项个数 | `Number` | `5` | - | | visible-item-count | 可见的选项个数 | `Number` | `5` |
### Event ### Event
Picker 组件的事件会根据 columns 是单列或多列返回不同的参数 Picker 组件的事件会根据 columns 是单列或多列返回不同的参数

View File

@ -41,11 +41,11 @@ Vue.use(Progress);
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| inactive | 是否置灰 | `Boolean` | `false` | - | | inactive | 是否置灰 | `Boolean` | `false` |
| percentage | 进度百分比 | `Number` | `false` | `0-100` | | percentage | 进度百分比 | `Number` | `false` |
| show-pivot | 是否显示进度文字 | `Boolean` | `true` | - | | show-pivot | 是否显示进度文字 | `Boolean` | `true` |
| pivot-text | 文字显示 | `String` | 百分比文字 | - | | pivot-text | 文字显示 | `String` | 百分比文字 |
| color | 进度条颜色 | `String` | `#38f` | hexvalue | | color | 进度条颜色 | `String` | `#38f` |
| text-color | 进度条文字颜色 | `String` | `#fff` | hexvalue | | text-color | 进度条文字颜色 | `String` | `#fff` |

View File

@ -41,14 +41,14 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | 是否在加载中 | `Boolean` | - | - | | v-model | 是否在加载中 | `Boolean` | - |
| pulling-text | 下拉过程中顶部文案 | `String` | `下拉即可刷新...` | - | | pulling-text | 下拉过程中顶部文案 | `String` | `下拉即可刷新...` |
| loosing-text | 释放过程中顶部文案 | `String` | `释放即可刷新...` | - | | loosing-text | 释放过程中顶部文案 | `String` | `释放即可刷新...` |
| loading-text | 加载过程中顶部文案 | `String` | `加载中...` | - | | loading-text | 加载过程中顶部文案 | `String` | `加载中...` |
| animation-duration | 动画时长 | `Number` | `300` | - | | animation-duration | 动画时长 | `Number` | `300` |
| head-height | 顶部内容高度 | `Number` | `50` | - | | head-height | 顶部内容高度 | `Number` | `50` |
### Event ### Event

View File

@ -58,17 +58,17 @@ export default {
### Radio API ### Radio API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| name | 唯一标识符 | 任意类型 | - | - | | name | 唯一标识符 | 任意类型 | - |
| disabled | 是否为禁用状态 | `Boolean` | `false` | - | | disabled | 是否为禁用状态 | `Boolean` | `false` |
### RadioGroup API ### RadioGroup API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | 当前选中项的 name | 任意类型 | - | - | | v-model | 当前选中项的 name | 任意类型 | - |
| disabled | 是否禁用所有单选框 | `Boolean` | `false` | - | | disabled | 是否禁用所有单选框 | `Boolean` | `false` |
### RadioGroup Event ### RadioGroup Event

View File

@ -49,10 +49,10 @@ Tips: 在 `van-search` 外层增加 form 标签,并且 action 不为空,即
### API ### API
Search 默认支持 Input 标签所有的原生属性,比如 `maxlength``placeholder``readony``autofocus` Search 默认支持 Input 标签所有的原生属性,比如 `maxlength``placeholder``readony``autofocus`
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| background | 搜索框背景色 | `String` | `#f2f2f2` | 所有浏览器支持的颜色描述 | | background | 搜索框背景色 | `String` | `#f2f2f2` |
| show-action | 是否在搜索框右侧显示取消按钮 | `Boolean` | false | - | | show-action | 是否在搜索框右侧显示取消按钮 | `Boolean` | `false` |
### Event ### Event
Search 默认支持 Input 标签所有的原生事件,如 `focus``blur``keypress` Search 默认支持 Input 标签所有的原生事件,如 `focus``blur``keypress`

View File

@ -84,24 +84,24 @@ Vue.use(Sku);
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | 是否显示sku | `Boolean` | `false` | - | | v-model | 是否显示sku | `Boolean` | `false` |
| sku | 商品sku数据 | `Object` | - | - | | sku | 商品sku数据 | `Object` | - |
| goods | 商品信息 | `Object` | - | - | | goods | 商品信息 | `Object` | - |
| goods-id | 商品id | `String | Number` | - | - | | goods-id | 商品id | `String | Number` | - |
| hide-stock | 是否显示商品剩余库存 | `Boolean` | `false` | - | | hide-stock | 是否显示商品剩余库存 | `Boolean` | `false` |
| show-add-cart-btn | 是否显示加入购物车按钮 | `Boolean` | `true` | - | | show-add-cart-btn | 是否显示加入购物车按钮 | `Boolean` | `true` |
| quota | 限购数(0表示不限购) | `Number` | `0` | - | | quota | 限购数(0表示不限购) | `Number` | `0` |
| quota-used | 已经购买过的数量 | `Number` | `0` | - | | quota-used | 已经购买过的数量 | `Number` | `0` |
| reset-stepper-on-hide | 窗口隐藏时重置选择的商品数量 | `Boolean` | `false` | - | | reset-stepper-on-hide | 窗口隐藏时重置选择的商品数量 | `Boolean` | `false` |
| reset-selected-sku-on-hide | 窗口隐藏时重置已选择的sku | `Boolean` | `false` | - | | reset-selected-sku-on-hide | 窗口隐藏时重置已选择的sku | `Boolean` | `false` |
| disable-stepper-input | 是否禁用sku中stepper的input框 | `Boolean` | `false` | - | | disable-stepper-input | 是否禁用sku中stepper的input框 | `Boolean` | `false` |
| close-on-click-overlay | 点击popup的overlay后是否关闭弹窗 | `Boolean` | `false` | - | | close-on-click-overlay | 点击popup的overlay后是否关闭弹窗 | `Boolean` | `false` |
| stepper-title | 数量选择组件左侧文案 | `String` | `购买数量` | - | | stepper-title | 数量选择组件左侧文案 | `String` | `购买数量` |
| custom-stepper-config | 步进器相关自定义配置 | `Object` | `{}` | - | | custom-stepper-config | 步进器相关自定义配置 | `Object` | `{}` |
| message-config | 留言相关配置 | `Object` | `{}` | - | | message-config | 留言相关配置 | `Object` | `{}` |
| get-container | 指定挂载的 HTML 节点 | `Function` | - | `() => HTMLElement` | | get-container | 指定挂载的 HTML 节点 | `() => HTMLElement` | - |
### Event ### Event

View File

@ -62,16 +62,16 @@ Vue.use(SubmitBar);
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| price | 价格(单位分) | `Number` | - | - | | price | 价格(单位分) | `Number` | - |
| label | 价格文案 | `String` | `合计:` | - | | label | 价格文案 | `String` | `合计:` |
| button-text | 按钮文字 | `String` | - | - | | button-text | 按钮文字 | `String` | - |
| button-type | 按钮类型 | `String` | `danger` | - | | button-type | 按钮类型 | `String` | `danger` |
| tip | 提示文案 | `String` | - | - | | tip | 提示文案 | `String` | - |
| disabled | 是否禁用按钮 | `Boolean` | `false` | - | | disabled | 是否禁用按钮 | `Boolean` | `false` |
| loading | 是否显示加载中的按钮 | `Boolean` | `false` | - | | loading | 是否显示加载中的按钮 | `Boolean` | `false` |
| currency | 货币符号 | `String` | `¥` | - | | currency | 货币符号 | `String` | `¥` |
### Event ### Event

View File

@ -79,15 +79,15 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| autoplay | 自动轮播间隔,单位为 ms | `Number` | - | - | | autoplay | 自动轮播间隔,单位为 ms | `Number` | - |
| duration | 动画时长,单位为 ms | `Number` | `500` | - | | duration | 动画时长,单位为 ms | `Number` | `500` |
| loop | 是否开启循环播放 | `Boolean` | `true` | - | | loop | 是否开启循环播放 | `Boolean` | `true` |
| vertical | 是否为纵向滚动 | `Boolean` | `false` | - | | vertical | 是否为纵向滚动 | `Boolean` | `false` |
| touchable | 是否可以通过手势滑动 | `Boolean` | `true` | - | | touchable | 是否可以通过手势滑动 | `Boolean` | `true` |
| show-indicators | 是否显示指示器 | `Boolean` | `true` | - | | show-indicators | 是否显示指示器 | `Boolean` | `true` |
| initial-swipe | 初始位置,从 0 开始算 | `Number` | `0` | - | | initial-swipe | 初始位置,从 0 开始算 | `Number` | `0` |
### 事件 ### 事件

View File

@ -50,12 +50,12 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | 开关状态 | `Boolean` | - | - | | v-model | 开关状态 | `Boolean` | - |
| title | 左侧标题 | `String` | `''` | - | | title | 左侧标题 | `String` | `''` |
| loading | 是否为加载状态 | `Boolean` | `false` | - | | loading | 是否为加载状态 | `Boolean` | `false` |
| disabled | 是否为禁用状态 | `Boolean` | `false` | - | | disabled | 是否为禁用状态 | `Boolean` | `false` |
### Event ### Event

View File

@ -63,12 +63,12 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | 开关选中状态 | `Boolean` | `false` | - | | v-model | 开关选中状态 | `Boolean` | `false` |
| loading | 是否为加载状态 | `Boolean` | `false` | - | | loading | 是否为加载状态 | `Boolean` | `false` |
| disabled | 是否为禁用状态 | `Boolean` | `false` | - | | disabled | 是否为禁用状态 | `Boolean` | `false` |
| size | 开关尺寸 | `String` | `30px` | - | | size | 开关尺寸 | `String` | `30px` |
### Event ### Event

View File

@ -66,9 +66,9 @@ export default {
### Tabbar API ### Tabbar API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| v-model | 当前选中标签的索引 | `Number` | - | - | | v-model | 当前选中标签的索引 | `Number` | - |
### Tabbar Event ### Tabbar Event
@ -78,14 +78,14 @@ export default {
### TabbarItem API ### TabbarItem API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-----------|
| icon | 图标名称 | `String` | - | Icon 组件中可用的类型 | | icon | 图标名称 (可选值见 Icon 组件) | `String` | - |
| dot | 是否显示小红点 | `Boolean` | - | - | | dot | 是否显示小红点 | `Boolean` | - |
| info | 图标右上角提示信息 | `String | Number` | - | - | | info | 图标右上角提示信息 | `String | Number` | - |
| url | 跳转链接 | `String` | - | - | | url | 跳转链接 | `String` | - |
| to | 路由跳转对象,同 `vue-router` 的 to | `String | Object` | - | - | | to | 路由跳转对象,同 `vue-router` 的 to | `String | Object` | - |
| replace | 跳转时是否替换当前 history | `String` | `false` | - | | replace | 跳转时是否替换当前 history | `String` | `false` |
### TabbarItem Slot ### TabbarItem Slot

View File

@ -29,8 +29,8 @@ Vue.use(Tag);
<van-tag plain type="success">标签</van-tag> <van-tag plain type="success">标签</van-tag>
``` ```
#### 标记样式 #### 圆角样式
通过`mark`设置为标记样式 通过`mark`设置为圆角样式
```html ```html
<van-tag mark>标签</van-tag> <van-tag mark>标签</van-tag>
@ -41,14 +41,14 @@ Vue.use(Tag);
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| type | 类型 | `String` | `''`| `primary` `success` `danger` | | type | 类型,可选值为`primary` `success` `danger` | `String` | `''`|
| plain | 是否为空心样式 | `Boolean` | `false` | - | | plain | 是否为空心样式 | `Boolean` | `false` |
| mark | 是否为标记样式 | `Boolean` | `false` | - | | mark | 是否为圆角样式 | `Boolean` | `false` |
### Slot ### Slot
| 名称 | 说明 | | 名称 | 说明 |
|-----------|-----------| |-----------|-----------|
| - | 自定义 Tag 显示内容 | | default | 自定义 Tag 显示内容 |

View File

@ -94,11 +94,11 @@ toast2.clear();
### Options ### Options
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| type | 提示类型 | `String` | `text` | `loading` `success` `fail` `html` | | type | 提示类型,可选值为 `loading` `success` `fail` `html` | `String` | `text` |
| position | 位置,可选值为 `top` `middle` `bottom` | `String` | `middle` |
| message | 内容 | `String` | `''` | - | | message | 内容 | `String` | `''` | - |
| position | 位置 | `String` | `middle` | `top` `bottom` | | mask | 是否显示背景蒙层 | `Boolean` | `false` |
| mask | 是否显示背景蒙层 | `Boolean` | `false` | - | | forbidClick | 是否禁止背景点击 | `Boolean` | `false` |
| forbidClick | 禁止背景点击 | `Boolean` | `false` | - | | duration | 展示时长(ms),值为 0 时toast 不会消失 | `Number` | `3000` |
| duration | 时长(ms) | `Number` | `3000` | 值为 0 时toast 不会消失 |

View File

@ -48,13 +48,14 @@ export default {
#### 传入参数 #### 传入参数
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| items | 分类显示所需的数据,具体数据结构可看 数据结构 | `Array` | `[]` | - | | items | 分类显示所需的数据,具体数据结构可看 数据结构 | `Array` | `[]` |
| main-active-index | 左侧导航高亮的索引 | `Number` | `0` | - | | main-active-index | 左侧导航高亮的索引 | `Number` | `0` |
| active-id | 右侧选择项高亮的数据id | `Number` | `0` | - | | active-id | 右侧选择项高亮的数据id | `Number` | `0` |
#### 事件 #### 事件
| 事件名 | 说明 | 参数 | | 事件名 | 说明 | 参数 |
|-----------|-----------|-----------| |-----------|-----------|-----------|
| navclick | 左侧导航点击时,触发的事件 | index被点击的导航的索引 | | navclick | 左侧导航点击时,触发的事件 | index被点击的导航的索引 |

View File

@ -38,14 +38,14 @@ export default {
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 | | 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|
| result-type | 文件读取结果类型 | `String` | `dataUrl` | `text` | | result-type | 文件读取结果类型,可选值为 `dataUrl` `test` | `String` | `dataUrl` |
| accept | 接受的文件类型 | `String` | `image/*` | - | | accept | 接受的文件类型 | `String` | `image/*` |
| disabled | 是否禁用图片上传 | `Boolean` | `false` | - | | disabled | 是否禁用图片上传 | `Boolean` | `false` |
| before-read | 读取前的回调函数,返回 false 可终止文件读取 | `Function` | - | - | | before-read | 读取前的回调函数,返回 false 可终止文件读取 | `Function` | - |
| after-read | 读取完成后的回调函数 | `Function` | - | - | | after-read | 读取完成后的回调函数 | `Function` | - |
| max-size | 文件大小限制,单位为 byte | `Number` | - | - | | max-size | 文件大小限制,单位为 byte | `Number` | - |
### Event ### Event

View File

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