From 6b563b2e5ad8d8cec01874baeae019d6ac9b9d9a Mon Sep 17 00:00:00 2001 From: neverland Date: Tue, 26 Dec 2017 12:39:52 +0800 Subject: [PATCH] [Doc] update code style (#484) --- docs/demos/views/address-edit.vue | 6 ++-- docs/demos/views/cell.vue | 4 +-- docs/demos/views/search.vue | 4 +-- docs/demos/views/stepper.vue | 2 +- docs/markdown/en-US/actionsheet.md | 6 ++-- docs/markdown/en-US/address-edit.md | 26 ++++++++-------- docs/markdown/en-US/address-list.md | 2 +- docs/markdown/en-US/area.md | 16 +++++----- docs/markdown/en-US/badge.md | 14 ++++----- docs/markdown/en-US/button.md | 10 +++--- docs/markdown/en-US/cell.md | 14 ++++----- docs/markdown/en-US/contact.md | 16 +++++----- docs/markdown/en-US/coupon.md | 24 +++++++-------- docs/markdown/en-US/datetime-picker.md | 18 +++++------ docs/markdown/en-US/field.md | 16 +++++----- docs/markdown/en-US/goods-action.md | 2 +- docs/markdown/en-US/lazyload.md | 4 +-- docs/markdown/en-US/nav-bar.md | 14 ++++----- docs/markdown/en-US/notice-bar.md | 4 +-- docs/markdown/en-US/number-keyboard.md | 30 +++++++++--------- docs/markdown/en-US/pagination.md | 26 ++++++++-------- docs/markdown/en-US/password-input.md | 2 +- docs/markdown/en-US/picker.md | 10 +++--- docs/markdown/en-US/popup.md | 10 +++--- docs/markdown/en-US/progress.md | 14 ++++----- docs/markdown/en-US/pull-refresh.md | 10 +++--- docs/markdown/en-US/search.md | 13 ++++---- docs/markdown/en-US/sku.md | 42 +++++++++++++------------- docs/markdown/en-US/stepper.md | 12 ++++---- docs/markdown/en-US/steps.md | 6 ++-- docs/markdown/en-US/submit-bar.md | 12 ++++---- docs/markdown/en-US/swipe.md | 4 +-- docs/markdown/en-US/tab.md | 4 +-- docs/markdown/en-US/tree-select.md | 8 ++--- docs/markdown/en-US/uploader.md | 12 ++++---- docs/markdown/en-US/waterfall.md | 5 +-- docs/markdown/zh-CN/actionsheet.md | 6 ++-- docs/markdown/zh-CN/address-edit.md | 28 ++++++++--------- docs/markdown/zh-CN/address-list.md | 2 +- docs/markdown/zh-CN/area.md | 30 +++++++++--------- docs/markdown/zh-CN/badge.md | 14 ++++----- docs/markdown/zh-CN/button.md | 10 +++--- docs/markdown/zh-CN/cell.md | 16 +++++----- docs/markdown/zh-CN/contact.md | 16 +++++----- docs/markdown/zh-CN/coupon.md | 28 ++++++++--------- docs/markdown/zh-CN/datetime-picker.md | 30 +++++++++--------- docs/markdown/zh-CN/field.md | 16 +++++----- docs/markdown/zh-CN/goods-action.md | 2 +- docs/markdown/zh-CN/lazyload.md | 6 ++-- docs/markdown/zh-CN/nav-bar.md | 14 ++++----- docs/markdown/zh-CN/notice-bar.md | 4 +-- docs/markdown/zh-CN/number-keyboard.md | 30 +++++++++--------- docs/markdown/zh-CN/pagination.md | 24 +++++++-------- docs/markdown/zh-CN/password-input.md | 2 +- docs/markdown/zh-CN/picker.md | 10 +++--- docs/markdown/zh-CN/popup.md | 10 +++--- docs/markdown/zh-CN/progress.md | 14 ++++----- docs/markdown/zh-CN/pull-refresh.md | 10 +++--- docs/markdown/zh-CN/search.md | 13 ++++---- docs/markdown/zh-CN/sku.md | 42 +++++++++++++------------- docs/markdown/zh-CN/stepper.md | 14 ++++++--- docs/markdown/zh-CN/steps.md | 6 ++-- docs/markdown/zh-CN/submit-bar.md | 12 ++++---- docs/markdown/zh-CN/swipe.md | 4 +-- docs/markdown/zh-CN/tab.md | 4 +-- docs/markdown/zh-CN/tree-select.md | 6 ++-- docs/markdown/zh-CN/uploader.md | 12 ++++---- docs/markdown/zh-CN/waterfall.md | 5 +-- 68 files changed, 431 insertions(+), 431 deletions(-) diff --git a/docs/demos/views/address-edit.vue b/docs/demos/views/address-edit.vue index 5bbc78968..0a7ad7ba4 100644 --- a/docs/demos/views/address-edit.vue +++ b/docs/demos/views/address-edit.vue @@ -3,9 +3,9 @@ - + diff --git a/docs/demos/views/search.vue b/docs/demos/views/search.vue index a99ef21f2..b6f8847ea 100644 --- a/docs/demos/views/search.vue +++ b/docs/demos/views/search.vue @@ -9,7 +9,7 @@ @@ -19,7 +19,7 @@
{{ $t('search') }}
diff --git a/docs/demos/views/stepper.vue b/docs/demos/views/stepper.vue index 6e659d051..a6a636033 100644 --- a/docs/demos/views/stepper.vue +++ b/docs/demos/views/stepper.vue @@ -9,7 +9,7 @@ - + diff --git a/docs/markdown/en-US/actionsheet.md b/docs/markdown/en-US/actionsheet.md index f45886fc1..4bc0502c5 100644 --- a/docs/markdown/en-US/actionsheet.md +++ b/docs/markdown/en-US/actionsheet.md @@ -40,7 +40,7 @@ export default { #### Actionsheet with cancel button ```html - + ``` #### Actionsheet with title @@ -58,9 +58,9 @@ Actionsheet will get another style if there is a `title` prop. |-----------|-----------|-----------|-------------|-------------| | actions | Options | `Array` | `[]` | - | | title | Title | `String` | - | - | -| cancelText | Text of cancel button | `String` | - | - | +| cancel-text | Text of cancel button | `String` | - | - | | overlay | Whether to show overlay | `Boolean` | - | - | -| closeOnClickOverlay | Whether to close when click overlay | `Boolean` | - | - | +| close-on-click-overlay | Whether to close when click overlay | `Boolean` | - | - | ### Data struct of actions diff --git a/docs/markdown/en-US/address-edit.md b/docs/markdown/en-US/address-edit.md index a810fc014..de13214e4 100644 --- a/docs/markdown/en-US/address-edit.md +++ b/docs/markdown/en-US/address-edit.md @@ -14,11 +14,11 @@ Vue.use(AddressEdit); ```html + ``` #### Initial Value @@ -23,16 +23,16 @@ To initailize `Area` component, `areaList` property is required. Data structure To have a selected value，simply pass the `code` of target area to `value` property. ```html - + ``` #### Columns Number -`columnsNum` property is able to config number of columns to be displayed. This component has 3 columns corresponding to a 3 level picker by default. -Set `columnsNum` with 2, you'll have a 2 level picker. +`columns-num` property is used to config number of columns to be displayed. This component has 3 columns corresponding to a 3 level picker by default. +Set `columns-num` with 2, you'll have a 2 level picker. ```html - + ``` @@ -42,8 +42,8 @@ Set `columnsNum` with 2, you'll have a 2 level picker. |-----------|-----------|-----------|-------------|-------------| | value | the `code` of selected area | `String` | - | - | | title | Toolbar title | `String` | `''` | - | -| areaList | an object contains these properties: `province_list`, `city_list` and `county_list` | `Object` | - | - | -| columnsNum | level of picker | `String`,`Number` | 3 | - | +| area-list | an object contains these properties: `province_list`, `city_list` and `county_list` | `Object` | - | - | +| columns-num | level of picker | `String`,`Number` | 3 | - | ### Event diff --git a/docs/markdown/en-US/badge.md b/docs/markdown/en-US/badge.md index b6e09d133..635279761 100644 --- a/docs/markdown/en-US/badge.md +++ b/docs/markdown/en-US/badge.md @@ -10,14 +10,14 @@ Vue.use(Badge); ### Usage #### Basic Usage -Use `activeKey` prop to set index of chosen 'badge' +Use `active-key` prop to set index of chosen 'badge' ```html - - - - - + + + + + ``` @@ -40,7 +40,7 @@ export default { | Attribute | Description | Type | Default | Accepted Values | |-----------|-----------|-----------|-------------|-------------| -| activeKey | Index of chosen badge | `String | Number` | `0` | - | +| active-key | Index of chosen badge | `String | Number` | `0` | - | ### Badge API | Attribute | Description | Type | Default | Accepted Values | diff --git a/docs/markdown/en-US/button.md b/docs/markdown/en-US/button.md index 5b6845047..1270847bd 100644 --- a/docs/markdown/en-US/button.md +++ b/docs/markdown/en-US/button.md @@ -51,14 +51,14 @@ Use `tag` prop to custom button tag #### Action Button ```html -Button +Button - Button + Button - Button + Button ``` @@ -70,8 +70,8 @@ Use `tag` prop to custom button tag | type | Type | `String` | `default` | `primary` `danger` | | size | Size | `String` | `normal` | `large` `small` `mini` | | tag | Tag | `String` | `button` | - | -| nativeType | Native Type Attribute | `String` | `''` | - | +| native-type | Native Type Attribute | `String` | `''` | - | | diabled | Whether disable button | `Boolean` | `false` | - | | loading | Whether show loading status | `Boolean` | `false` | - | | block | Whether to set display block | `Boolean` | `false` | - | -| bottomAction | Whether to be action button | `Boolean` | `false` | - | +| bottom-action | Whether to be action button | `Boolean` | `false` | - | diff --git a/docs/markdown/en-US/cell.md b/docs/markdown/en-US/cell.md index 82df278d6..4e1b5b8e9 100644 --- a/docs/markdown/en-US/cell.md +++ b/docs/markdown/en-US/cell.md @@ -39,8 +39,8 @@ Vue.use(CellGroup); ```html - - + + ``` @@ -48,17 +48,15 @@ Vue.use(CellGroup); ```html - + - + - + ``` @@ -80,7 +78,7 @@ Vue.use(CellGroup); | 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` | - | -| isLink | Whether to show link icon | `Boolean` | `false` | - | +| is-link | Whether to show link icon | `Boolean` | `false` | - | | required | Whether to show required mark | `Boolean` | `false` | - | ### Slot diff --git a/docs/markdown/en-US/contact.md b/docs/markdown/en-US/contact.md index 2e1466669..5afccebb8 100644 --- a/docs/markdown/en-US/contact.md +++ b/docs/markdown/en-US/contact.md @@ -37,8 +37,8 @@ Vue.use(ContactEdit); @@ -134,16 +134,16 @@ export default { | Attribute | Description | Type | Default | Accepted Values | |-----------|-----------|-----------|-------------|-------------| | type | Type | `String` | `add` | `edit` | -| addText | Add card text | `String` | `Add contact info` | - | | name | Name | `String` | - | - | | tel | Phone | `String` | - | - | +| add-text | Add card text | `String` | `Add contact info` | - | ### ContactList API | Attribute | Description | Type | Default | Accepted Values | |-----------|-----------|-----------|-------------|-------------| | v-model | Id of chosen contact | `String | Number` | - | - | -| addText | Add button text | `String` | `Add new contact` | - | | list | Contact list | `Array` | `[]` | - | +| add-text | Add button text | `String` | `Add new contact` | - | ### ContactList Event @@ -156,10 +156,10 @@ export default { ### ContactEdit API | Attribute | Description | Type | Default | Accepted Values | |-----------|-----------|-----------|-------------|-------------| -| contactInfo | Contact Info | `Object` | `[]` | - | -| isEdit | Whether is editing | `Boolean` | `false` | - | -| isSaving | Whether to show save button loading status | `Boolean` | `false` | - | -| isDeleting | Whether to show delete button loading status | `Boolean` | `false` | - | +| contact-info | Contact Info | `Object` | `[]` | - | +| is-edit | Whether is editing | `Boolean` | `false` | - | +| is-saving | Whether to show save button loading status | `Boolean` | `false` | - | +| is-deleting | Whether to show delete button loading status | `Boolean` | `false` | - | ### ContactEdit Event diff --git a/docs/markdown/en-US/coupon.md b/docs/markdown/en-US/coupon.md index 036d5b579..36e477e74 100644 --- a/docs/markdown/en-US/coupon.md +++ b/docs/markdown/en-US/coupon.md @@ -16,7 +16,7 @@ Vue.use(CouponList); @@ -24,8 +24,8 @@ Vue.use(CouponList); @@ -71,7 +71,7 @@ export default { | Attribute | Description | Type | Default | Accepted Values | |-----------|-----------|-----------|-------------|-------------| | title | Cell title | `String` | `Coupon` | - | -| chosenCoupon | Index of chosen coupon | `Number` | `-1` | - | +| chosen-coupon | Index of chosen coupon | `Number` | `-1` | - | | coupons | Coupon list | `Array` | `[]` | - | | editable | Cell editable | `Boolean` | `true` | - | @@ -79,15 +79,15 @@ export default { | Attribute | Description | Type | Default | Accepted Values | |-----------|-----------|-----------|-------------|-------------| -| chosenCoupon | Index of chosen coupon | `Number` | `-1` | - | +| chosen-coupon | Index of chosen coupon | `Number` | `-1` | - | | coupons | Coupon list | `Array` | `[]` | - | -| disabledCoupons | Disabled voupon list | `Array` | `[]` | - | -| exchangeButtonText | Exchange button text | `String` | `Exchange` | - | -| exchangeButtonDisabled | Whether to disable exchange button | `Boolean` | `false` | - | -| displayedCouponIndex | Index of displayed coupon | `Number` | - | - | -| closeButtonText | Close button text | `String` | `Close` | - | -| disabledListTitle | Disabled list title | `String` | `Unavailable` | - | -| inputPlaceholder | Input placeholder | `String` | `Coupon code` | - | +| disabled-coupons | Disabled voupon list | `Array` | `[]` | - | +| exchange-button-text | Exchange button text | `String` | `Exchange` | - | +| exchange-button-disabled | Whether to disable exchange button | `Boolean` | `false` | - | +| 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/datetime-picker.md b/docs/markdown/en-US/datetime-picker.md index b5c6ce06f..caac7f017 100644 --- a/docs/markdown/en-US/datetime-picker.md +++ b/docs/markdown/en-US/datetime-picker.md @@ -15,10 +15,10 @@ Vue.use(DatetimePicker); ``` @@ -65,11 +65,11 @@ export default { | Attribute | Description | Type | Default | Accepted Values | |-----------|-----------|-----------|-------------|-------------| | type | Picker type | `String` | 'datetime' | 'date', 'time' | -| minDate | Min date | `Date` | Ten years ago on January 1 | - | -| maxDate | Max date | `Date` | Ten years later on December 31 | - | -| minHour | Min hour | `Number` | `0` | - | -| maxHour | Max hour | `Number` | `23` | - | -| visibileColumnCount | Count of columns to show | `Number` | `5` | - | +| min-date | Min date | `Date` | Ten years ago on January 1 | - | +| max-date | Max date | `Date` | Ten years later on December 31 | - | +| min-hour | Min hour | `Number` | `0` | - | +| max-hour | Max hour | `Number` | `23` | - | +| visibile-column-count | Count of columns to show | `Number` | `5` | - | ### Event diff --git a/docs/markdown/en-US/field.md b/docs/markdown/en-US/field.md index 63e1c44e6..27ce1eaa7 100644 --- a/docs/markdown/en-US/field.md +++ b/docs/markdown/en-US/field.md @@ -14,7 +14,7 @@ The value of filed is bound with v-model. ```html - + ``` @@ -30,16 +30,15 @@ Use `type` prop to custom diffrent type fileds. placeholder="Username" required @click-icon="username = ''" - > - + /> - + required + /> ``` @@ -47,7 +46,7 @@ Use `type` prop to custom diffrent type fileds. ```html - + ``` @@ -55,7 +54,7 @@ Use `type` prop to custom diffrent type fileds. ```html - + ``` @@ -71,8 +70,7 @@ Textarea Filed can be auto resize when has `autosize` prop placeholder="Message" rows="1" autosize - > - + /> ``` diff --git a/docs/markdown/en-US/goods-action.md b/docs/markdown/en-US/goods-action.md index 8954eeebd..f85148200 100644 --- a/docs/markdown/en-US/goods-action.md +++ b/docs/markdown/en-US/goods-action.md @@ -59,7 +59,7 @@ Use `info` prop to show messages in upper right corner of icon |-----------|-----------|-----------|-------------|-------------| | text | Button text | `String` | - | - | | icon | Icon | `String` | - | - | -| iconClass | Icon class name | `String` | `''` | - | +| icon-class | Icon class name | `String` | `''` | - | | info | Info message | `String` | - | - | | url | Link | `String` | - | - | | to | Target route of the link, same as to of `vue-router` | `String | Object` | - | - | diff --git a/docs/markdown/en-US/lazyload.md b/docs/markdown/en-US/lazyload.md index 707fd9d79..2fcc20e01 100644 --- a/docs/markdown/en-US/lazyload.md +++ b/docs/markdown/en-US/lazyload.md @@ -14,7 +14,7 @@ Vue.use(Lazyload, options); #### Basic Usage ```html - + ``` ```javascript @@ -41,7 +41,7 @@ Use `v-lazy:background-image` to set background url, and declare the height of t ```html - + ``` diff --git a/docs/markdown/en-US/nav-bar.md b/docs/markdown/en-US/nav-bar.md index 77ba3ab64..aaf2948ee 100644 --- a/docs/markdown/en-US/nav-bar.md +++ b/docs/markdown/en-US/nav-bar.md @@ -14,9 +14,9 @@ Vue.use(NavBar); ```html @@ -38,7 +38,7 @@ export default { #### Advanced Usage ```html - + ``` @@ -48,9 +48,9 @@ export default { | Attribute | Description | Type | Default | Accepted Values | |-----------|-----------|-----------|-------------|-------------| | title | Title | `String` | `''` | - | -| leftText | Left Text | `String` | `''` | - | -| rightText | Right Text | `String` | `''` | - | -| leftArrow | Whether to show left arrow | `Boolean` | `false` | - | +| 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` | - | ### Slot diff --git a/docs/markdown/en-US/notice-bar.md b/docs/markdown/en-US/notice-bar.md index eea3d9f51..f4dff671c 100644 --- a/docs/markdown/en-US/notice-bar.md +++ b/docs/markdown/en-US/notice-bar.md @@ -14,7 +14,7 @@ Vue.use(NoticeBar); ```html ``` @@ -46,7 +46,7 @@ Vue.use(NoticeBar); | delay | Animation delay (s) | Number | `1` | - | | speed | Scroll speed (px) | Number | `50` | - | | scrollable | Whether to scroll content | Boolean | `true` | - | -| leftIcon | Image url of left icon | String | - | - | +| left-icon | Image url of left icon | String | - | - | | color | Text color | String | `#f60` | - | | background | Background color | String | `#fff7cc` | - | diff --git a/docs/markdown/en-US/number-keyboard.md b/docs/markdown/en-US/number-keyboard.md index 0870d8b13..0a2c901b8 100644 --- a/docs/markdown/en-US/number-keyboard.md +++ b/docs/markdown/en-US/number-keyboard.md @@ -12,15 +12,15 @@ Vue.use(NumberKeyboard); #### Default Style ```html - + Show Keyboard @@ -30,7 +30,7 @@ Vue.use(NumberKeyboard); export default { data() { return { - showKeyboard: true + show: true } }, @@ -49,11 +49,11 @@ export default { ```html @@ -66,12 +66,12 @@ export default { | show | Whether to show keyboard | `Boolean` | - | - | | theme | Keyboard theme | `String` | `Default` | `Custom` | | title | Keyboard title | `String` | - | - | -| zIndex | Keyboard z-index | `Number` | `100` | - | -| extraKey | Content of bottom left key | `String` | `''` | - | -| closeButtonText | Close button text | `String` | `-` | - | | transition | Whether to show transition animation | `Boolean` | `true` | - | -| showDeleteKey | Whether to show delete button | `Boolean` | `true` | - | -| hideOnClickOutside | Whether to hide keyboard when click outside | `Boolean` | `true` | - | +| z-index | Keyboard z-index | `Number` | `100` | - | +| extra-key | Content of bottom left key | `String` | `''` | - | +| close-button-text | Close button text | `String` | `-` | - | +| show-delete-key | Whether to show delete button | `Boolean` | `true` | - | +| hide-on-click-outside | Whether to hide keyboard when click outside | `Boolean` | `true` | - | ### Event diff --git a/docs/markdown/en-US/pagination.md b/docs/markdown/en-US/pagination.md index 78487ac33..d08b4cc1a 100644 --- a/docs/markdown/en-US/pagination.md +++ b/docs/markdown/en-US/pagination.md @@ -14,8 +14,8 @@ Vue.use(Pagination); ```html ``` @@ -34,7 +34,7 @@ export default { ```html ``` @@ -44,9 +44,9 @@ export default { ```html ``` @@ -54,13 +54,13 @@ export default { | Attribute | Description | Type | Default | Accepted Values | |-----------|-----------|-----------|-------------|-------------| -| v-model | pageModel | `Object` | - | - | -| mode | mode | `String` | `multi` | `simple` | -| itemsPerPage | itemsPerPage | `Number` | `10` | - | -| prevText | previousText | `String` | `Previous` | - | -| nextText | nextText | `String` | `Next` | - | -| showPageSize | showPageSize | `Number` | `5` | - | -| forceEllipses | ellipses | `Boolean` | `false` | - | +| v-model | Current page number | `Number` | - | - | +| 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` | - | +| show-page-size | Count of page size to show | `Number` | `5` | - | +| force-ellipses | Whether to show ellipses | `Boolean` | `false` | - | ### Event diff --git a/docs/markdown/en-US/password-input.md b/docs/markdown/en-US/password-input.md index 25eda7b11..184cd28ea 100644 --- a/docs/markdown/en-US/password-input.md +++ b/docs/markdown/en-US/password-input.md @@ -57,7 +57,7 @@ export default { | value | Password value | `String` | `''` | - | | length | Maxlength of password | `Number` | `6` | - | | info | Bottom info | `String` | - | - | -| errorInfo | Bottom error 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 824419592..50a5214bd 100644 --- a/docs/markdown/en-US/picker.md +++ b/docs/markdown/en-US/picker.md @@ -52,7 +52,7 @@ export default { ```html - - + + + ``` ### API @@ -43,7 +43,7 @@ Use `pivotText` to custom text，use `color` to custom bar color |-----------|-----------|-----------|-------------|-------------| | inactive | Whether to be gray | `Boolean` | `false` | - | | percentage | Percentage | `Number` | `false` | `0-100` | -| showPivot | Whether to show text | `Boolean` | `true` | - | -| pivotText | Text | `String` | percentage | - | +| show-pivot | Whether to show text | `Boolean` | `true` | - | +| pivot-text | Text | `String` | percentage | - | | color | Color | `String` | `#38f` | hexvalue | -| textColor | Text color | `String` | `#fff` | hexvalue | +| text-color | Text color | `String` | `#fff` | hexvalue | diff --git a/docs/markdown/en-US/pull-refresh.md b/docs/markdown/en-US/pull-refresh.md index b0bf9e500..73181fa05 100644 --- a/docs/markdown/en-US/pull-refresh.md +++ b/docs/markdown/en-US/pull-refresh.md @@ -49,11 +49,11 @@ export default { | Attribute | Description | Type | Default | Accepted Values | |-----------|-----------|-----------|-------------|-------------| | v-model | Loading status | `Boolean` | - | - | -| pullingText | Text to show when pulling | `String` | `下拉即可刷新...` | - | -| loosingText | Text to show when loosing | `String` | `释放即可刷新...` | - | -| loadingText | Text to show when loading | `String` | `加载中...` | - | -| animationDuration | Animation duration | `Number` | `300` | - | -| headHeight | Height of head | `Number` | `50` | - | +| pulling-text | Text to show when pulling | `String` | `下拉即可刷新...` | - | +| loosing-text | Text to show when loosing | `String` | `释放即可刷新...` | - | +| loading-text | Text to show when loading | `String` | `加载中...` | - | +| animation-duration | Animation duration | `Number` | `300` | - | +| head-height | Height of head | `Number` | `50` | - | ### Slot diff --git a/docs/markdown/en-US/search.md b/docs/markdown/en-US/search.md index aa9cb62ec..1a81f1656 100644 --- a/docs/markdown/en-US/search.md +++ b/docs/markdown/en-US/search.md @@ -35,10 +35,10 @@ Tips: There will be a search button on the keyboard when Search is inside a form - + @cancel="onCancel" + /> ``` @@ -48,8 +48,9 @@ Use `action` slot to custom right button, `cancel` event will no longer be trigg ```html + show-action + @search="onSearch" +>
Search
 ``` @@ -61,7 +62,7 @@ Search support all native properties of input tag，such as `maxlength`、`place |-----------|-----------|-----------|-------------|-------------| | placeholder | Input placeholder | `String` | - | - | | background | Background color | `String` | `#f2f2f2` | - | -| showAction | Whether to show right button | `Boolean` | false | - | +| 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 af10ffce4..c93a12596 100644 --- a/docs/markdown/en-US/sku.md +++ b/docs/markdown/en-US/sku.md @@ -15,12 +15,12 @@ Vue.use(Sku); v-model="showBase" :sku="sku" :goods="goods" - :goodsId="goodsId" - :hideStock="sku.hide_stock" + :goods-id="goodsId" + :hide-stock="sku.hide_stock" :quota="quota" - :quotaUsed="quotaUsed" - :resetStepperOnHide="resetStepperOnHide" - :disableStepperInput="disableStepperInput" + :quota-used="quotaUsed" + :reset-stepper-on-hide="resetStepperOnHide" + :disable-stepper-input="disableStepperInput" @buy-clicked="handleBuyClicked" @add-cart="handleAddCartClicked" /> @@ -31,16 +31,16 @@ Vue.use(Sku); ```html @@ -49,9 +49,9 @@ Vue.use(Sku); @@ -64,14 +64,14 @@ Vue.use(Sku); | v-model | Whether to show sku | `Boolean` | `false` | - | | sku | Sku data | `Object` | - | - | | goods | Goods info | `Object` | - | - | -| goodsId | Goods id | `String | Number` | - | - | -| hideStock | Whether to hide stock | `Boolean` | `false` | - | -| showAddCartBtn | Whether to show cart button | `Boolean` | `true` | - | +| 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` | - | -| quotaUsed | Used quota | `Number` | `0` | - | -| resetStepperOnHide | Whether to reset stepper when hide | `Boolean` | `false` | - | -| disableStepperInput | Whether to disable stepper input | `Boolean` | `false` | - | -| stepperTitle | Quantity title | `String` | `Quantity` | - | +| quota-used | Used quota | `Number` | `0` | - | +| reset-stepper-on-hide | Whether to reset stepper when hide | `Boolean` | `false` | - | +| disable-stepper-input | Whether to disable stepper input | `Boolean` | `false` | - | +| stepper-title | Quantity title | `String` | `Quantity` | - | ### Event diff --git a/docs/markdown/en-US/stepper.md b/docs/markdown/en-US/stepper.md index d60b9e2c7..17db87693 100644 --- a/docs/markdown/en-US/stepper.md +++ b/docs/markdown/en-US/stepper.md @@ -36,10 +36,10 @@ export default { ```html ``` @@ -49,10 +49,10 @@ export default { |-----------|-----------|-----------|-------------|-------------| | min | Min value | `String | Number` | `1` | - | | max | Max value | `String | Number` | - | - | -| defaultValue | Default value | `String | Number` | `1` | - | +| default-value | Default value | `String | Number` | `1` | - | | step | Value change step | `String | Number` | `1` | - | | disabled | Disable value change | `Boolean` | `false` | - | -| disableInput | Disable input | `Boolean` | `false` | - | +| disable-input | Disable input | `Boolean` | `false` | - | ### Event diff --git a/docs/markdown/en-US/steps.md b/docs/markdown/en-US/steps.md index 6efa07aa0..ab2a4609f 100644 --- a/docs/markdown/en-US/steps.md +++ b/docs/markdown/en-US/steps.md @@ -50,7 +50,7 @@ export default { #### Vertical Steps ```html - +

【City】Status1

2016-07-12 12:40

@@ -72,11 +72,11 @@ export default { |-----------|-----------|-----------|-------------|-------------| | active | Active step | `Number` | 0 | - | | icon | Action step icon | `String` | - | - | -| iconClass | Icon class | `String` | - | - | +| icon-class | Icon class | `String` | - | - | | title | Title | `String` | - | - | | description | Description | `String` | - | - | | direction | Direction | `String` | `horizontal` | `vertical` | -| activeColor | Active step color | `String` | `#06bf04` | - | +| active-color | Active step color | `String` | `#06bf04` | - | ### Steps Slot diff --git a/docs/markdown/en-US/submit-bar.md b/docs/markdown/en-US/submit-bar.md index e809bfa6e..31725ef0a 100644 --- a/docs/markdown/en-US/submit-bar.md +++ b/docs/markdown/en-US/submit-bar.md @@ -14,7 +14,7 @@ Vue.use(SubmitBar); ```html ``` @@ -26,7 +26,7 @@ Vue.use(SubmitBar); @@ -39,7 +39,7 @@ Vue.use(SubmitBar); ``` @@ -50,7 +50,7 @@ Use slot to add custom contents. ```html Check @@ -66,8 +66,8 @@ Use slot to add custom contents. |-----------|-----------|-----------|-------------|-------------| | price | Price | `Number` | - | - | | label | Price label | `String` | `合计：` | - | -| buttonText | Button text | `String` | - | - | -| buttonType | Button type | `String` | `danger` | - | +| 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` | - | diff --git a/docs/markdown/en-US/swipe.md b/docs/markdown/en-US/swipe.md index 9780029f6..eddcd012b 100644 --- a/docs/markdown/en-US/swipe.md +++ b/docs/markdown/en-US/swipe.md @@ -52,8 +52,8 @@ export default { |-----------|-----------|-----------|-------------|-------------| | autoplay | Autoplay interval (ms) | `Number` | - | - | | duration | Animation duration (ms) | `Number` | `500` | - | -| showIndicators | Whether to show indocators | `Boolean` | `true` | - | -| initialSwipe | Index of initial swipe, start from 0 | `Number` | `0` | - | +| 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/tab.md b/docs/markdown/en-US/tab.md index c35a2b064..ee90602cd 100644 --- a/docs/markdown/en-US/tab.md +++ b/docs/markdown/en-US/tab.md @@ -34,7 +34,7 @@ export default { #### Swipe Tabs -By default more than 4 tabs, you can scroll through the tabs. You can set `swipeThreshold` attribute to customize threshold number. +By default more than 4 tabs, you can scroll through the tabs. You can set `swipe-threshold` attribute to customize threshold number. ```html @@ -118,7 +118,7 @@ In sticky mode, the tab will be fixed to top when scroll to top | type | There are two style tabs, set this attribute to change tab style | `String` | `line` | `card` | | active | Index of active tab | `String` `Number` | `0` | - | | duration | Toggle tab's animation time | `Number` | `0.2` | - | - | -| swipeThreshold | Set swipe tabs threshold | `Number` | `4` | - | - | +| swipe-threshold | Set swipe tabs threshold | `Number` | `4` | - | - | ### Tab API diff --git a/docs/markdown/en-US/tree-select.md b/docs/markdown/en-US/tree-select.md index accabe80d..eb3cde5d8 100644 --- a/docs/markdown/en-US/tree-select.md +++ b/docs/markdown/en-US/tree-select.md @@ -45,13 +45,13 @@ export default { ### API -#### Properties +#### API -| Attribute | Description | Type | Default | 必须 | +| Attribute | Description | Type | Default | Accepted Values | |-----------|-----------|-----------|-------------|-------------| | items | Required datasets for the component, see Data Structure for detail. | `Array` | `[]` | - | -| mainActiveIndex | The index of selected parent node | `Number` | `0` | - | -| activeId | Id of selected item | `Number` | `0` | - | +| main-Active-index | The index of selected parent node | `Number` | `0` | - | +| active-id | Id of selected item | `Number` | `0` | - | #### Event | Event | Description | Attribute | diff --git a/docs/markdown/en-US/uploader.md b/docs/markdown/en-US/uploader.md index 5b8cb8f75..49d7c26e2 100644 --- a/docs/markdown/en-US/uploader.md +++ b/docs/markdown/en-US/uploader.md @@ -13,7 +13,7 @@ Vue.use(Uploader); ```html
- +
@@ -22,7 +22,7 @@ Vue.use(Uploader); ```javascript export default { methods: { - logContent(file) { + onRead(file) { console.log(file) } } @@ -33,7 +33,7 @@ export default { You can set native properties such as `accpet`、`multiple` on Uploader, and the input will automatically inherits the attribute. ```html - + ``` @@ -42,10 +42,10 @@ You can set native properties such as `accpet`、`multiple` on Uploader, and the | Attribute | Description | Type | Default | Accepted Values | |-----------|-----------|-----------|-------------|-------------| -| resultType | The way to read the file, read as base64; read as text | `String` | `dataUrl` | `text` | +| result-type | The way to read the file, read as base64; read as text | `String` | `dataUrl` | `text` | | disable | Whether to disable the upload, set to true during the image upload to prevent users from clicking this component to upload pictures | `Boolean` | `false` | - | -| beforeRead | Hook before reading the file, the first parameter is the selected file, return false to stop reading the file | `Function` | - | - | -| afterRead | Hook after reading the file, parameter format: { file ,content } | `Function` | - | - | +| before-read | Hook before reading the file, the first parameter is the selected file, return false to stop reading the file | `Function` | - | - | +| after-read | Hook after reading the file, parameter format: { file ,content } | `Function` | - | - | ### Slot diff --git a/docs/markdown/en-US/waterfall.md b/docs/markdown/en-US/waterfall.md index dea65a31e..94d4ce24e 100644 --- a/docs/markdown/en-US/waterfall.md +++ b/docs/markdown/en-US/waterfall.md @@ -33,7 +33,8 @@ export default {
    + waterfall-offset="400" +>
  • {{ item }}
``` @@ -55,7 +56,7 @@ export default { loadMore() { this.disabled = true; setTimeout(() => { - for (let i = 0; i < 5; i ++) { + for (let i = 0; i < 5; i++) { this.list.push(this.list.length); } this.disabled = false; diff --git a/docs/markdown/zh-CN/actionsheet.md b/docs/markdown/zh-CN/actionsheet.md index 388160bb5..310808041 100644 --- a/docs/markdown/zh-CN/actionsheet.md +++ b/docs/markdown/zh-CN/actionsheet.md @@ -50,7 +50,7 @@ export default { 如果传入了`cancelText`属性，且不为空，则会在下方显示一个取消按钮，点击会将当前`Actionsheet`关闭。 ```html - + ``` #### 带标题的 Actionsheet @@ -69,9 +69,9 @@ export default { |-----------|-----------|-----------|-------------|-------------| | actions | 行动按钮数组 | `Array` | `[]` | - | | title | 标题 | `String` | - | - | -| cancelText | 取消按钮文案 | `String` | - | - | +| cancel-text | 取消按钮文案 | `String` | - | - | | overlay | 是否显示遮罩 | `Boolean` | - | - | -| closeOnClickOverlay | 点击遮罩是否关闭`Actionsheet` | `Boolean` | - | - | +| close-on-click-overlay | 点击遮罩是否关闭`Actionsheet` | `Boolean` | - | - | ### actions diff --git a/docs/markdown/zh-CN/address-edit.md b/docs/markdown/zh-CN/address-edit.md index aea451a9c..8fcdf504f 100644 --- a/docs/markdown/zh-CN/address-edit.md +++ b/docs/markdown/zh-CN/address-edit.md @@ -13,11 +13,11 @@ Vue.use(AddressEdit); ```html + ``` #### 选中省市县 @@ -23,32 +23,32 @@ Vue.use(Area); 如果想选中某个省市县，需要传入一个`value`属性，绑定对应的省市县`code` ```html - + ``` #### 配置显示列 -可以通过`columnsNum`属性配置省市县显示的列数，默认情况下会显示省市县，当你设置为`2`，则只会显示省市选择 +可以通过`columns-num`属性配置省市县显示的列数，默认情况下会显示省市县，当你设置为`2`，则只会显示省市选择 ```html - + ``` ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -| ---------- | ------------------------------------------------------------------- | ----------------- | ------ | ------ | -| value | 当前选中的省市区`code` | `String` | - | - | -| title | 顶部栏标题 | `String` | `''` | - | -| areaList | 省市县数据，必须与`province_list`、`city_list`和`county_list`为 key | `Object` | - | - | -| columnsNum | 省市县显示列数，3-省市县，2-省市，1-省 | `String`,`Number` | 3 | - | +| 参数 | 说明 | 类型 | 默认值 | 可选值 | +| --- | --- | --- | --- | --- | +| value | 当前选中的省市区`code` | `String` | - | - | +| title | 顶部栏标题 | `String` | `''` | - | +| area-list | 省市县数据，格式见下方 | `Object` | - | - | +| columns-num | 省市县显示列数，3-省市县，2-省市，1-省 | `String`,`Number` | `3` | - | ### Event -| 事件名称 | 说明 | 回调参数 | -| -------- | ------------------ | ---------------------------------------- | -| confirm | 点击右上方完成按钮 | 一个数组参数，具体格式看下方数据格式章节 | -| cancel | 点击取消按钮时 | - | +| 事件 | 说明 | 回调参数 | +| --- | --- | --- | +| confirm | 点击右上方完成按钮 | 一个数组参数，具体格式看下方数据格式章节 | +| cancel | 点击取消按钮时 | - | ### 数据格式 diff --git a/docs/markdown/zh-CN/badge.md b/docs/markdown/zh-CN/badge.md index a14588d49..be0a85512 100644 --- a/docs/markdown/zh-CN/badge.md +++ b/docs/markdown/zh-CN/badge.md @@ -11,14 +11,14 @@ Vue.use(Badge); #### 基础用法 -通过在`van-badge-group`上设置`activeKey`属性来控制选中的`badge` +通过在`van-badge-group`上设置`active-key`属性来控制选中的`badge` ```html - - - - - + + + + + ``` @@ -41,7 +41,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 可选值 | |-----------|-----------|-----------|-------------|-------------| -| activeKey | 选中`badge`的索引 | `String | Number` | `0` | - | +| active-key | 选中`badge`的索引 | `String | Number` | `0` | - | ### Badge API | 参数 | 说明 | 类型 | 默认值 | 可选值 | diff --git a/docs/markdown/zh-CN/button.md b/docs/markdown/zh-CN/button.md index ff353c054..993c442d9 100644 --- a/docs/markdown/zh-CN/button.md +++ b/docs/markdown/zh-CN/button.md @@ -55,14 +55,14 @@ Vue.use(Button); #### 页面底部操作按钮 ```html -按钮 +按钮 - 按钮 + 按钮 - 按钮 + 按钮 ``` @@ -74,8 +74,8 @@ Vue.use(Button); | type | 按钮类型 | `String` | `default` | `primary` `danger` | | size | 按钮尺寸 | `String` | `normal` | `large` `small` `mini` | | tag | 按钮标签 | `String` | `button` | 任意`HTML`标签 | -| nativeType | 按钮类型（原生） | `String` | `''` | - | +| native-type | 按钮类型（原生） | `String` | `''` | - | | diabled | 是否禁用 | `Boolean` | `false` | - | | loading | 是否显示为加载状态 | `Boolean` | `false` | - | | block | 是否为块级元素 | `Boolean` | `false` | - | -| bottomAction | 是否为底部行动按钮 | `Boolean` | `false` | - | +| bottom-action | 是否为底部行动按钮 | `Boolean` | `false` | - | diff --git a/docs/markdown/zh-CN/cell.md b/docs/markdown/zh-CN/cell.md index 69ef5dda8..6a6df48d5 100644 --- a/docs/markdown/zh-CN/cell.md +++ b/docs/markdown/zh-CN/cell.md @@ -41,12 +41,12 @@ Vue.use(CellGroup); #### 展示箭头 -传入`isLink`属性则会在右侧显示箭头 +传入`is-link`属性则会在右侧显示箭头 ```html - - + + ``` @@ -55,17 +55,15 @@ Vue.use(CellGroup); ```html - + - + - + ``` @@ -87,7 +85,7 @@ Vue.use(CellGroup); | url | 跳转链接 | `String` | - | - | | to | 路由跳转对象，同 `vue-router` 的 to | `String | Object` | - | - | | replace | 跳转时是否替换当前 history | `String` | `false` | - | -| isLink | 是否展示右侧箭头 | `Boolean` | `false` | - | +| is-link | 是否展示右侧箭头 | `Boolean` | `false` | - | | required | 是否显示表单必填符号 | `Boolean` | `false` | - | ### Slot diff --git a/docs/markdown/zh-CN/contact.md b/docs/markdown/zh-CN/contact.md index 9e5e9cc0b..bb56ec77d 100644 --- a/docs/markdown/zh-CN/contact.md +++ b/docs/markdown/zh-CN/contact.md @@ -37,8 +37,8 @@ Vue.use(ContactEdit); @@ -134,16 +134,16 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 可选值 | |-----------|-----------|-----------|-------------|-------------| | type | 类型，分为添加和编辑两种样式 | `String` | `add` | `edit` | -| addText | 添加时的文案提示 | `String` | `添加订单联系人信息` | - | | name | 联系人姓名 | `String` | - | - | | tel | 联系人手机号 | `String` | - | - | +| add-text | 添加时的文案提示 | `String` | `添加订单联系人信息` | - | ### ContactList API | 参数 | 说明 | 类型 | 默认值 | 可选值 | |-----------|-----------|-----------|-------------|-------------| | v-model | 当前选中联系人的 id | `String | Number` | - | - | -| addText | 新建按钮文案 | `String` | `新建联系人` | - | | list | 联系人列表 | `Array` | `[]` | - | +| add-text | 新建按钮文案 | `String` | `新建联系人` | - | ### ContactList Event @@ -157,10 +157,10 @@ export default { ### ContactEdit API | 参数 | 说明 | 类型 | 默认值 | 可选值 | |-----------|-----------|-----------|-------------|-------------| -| contactInfo | 联系人信息 | `Object` | `[]` | - | -| isEdit | 是否为编辑联系人 | `Boolean` | `false` | - | -| isSaving | 是否显示保存按钮加载动画 | `Boolean` | `false` | - | -| isDeleting | 是否显示删除按钮加载动画 | `Boolean` | `false` | - | +| contact-info | 联系人信息 | `Object` | `[]` | - | +| is-edit | 是否为编辑联系人 | `Boolean` | `false` | - | +| is-saving | 是否显示保存按钮加载动画 | `Boolean` | `false` | - | +| is-deleting | 是否显示删除按钮加载动画 | `Boolean` | `false` | - | ### ContactEdit Event diff --git a/docs/markdown/zh-CN/coupon.md b/docs/markdown/zh-CN/coupon.md index 7e21b2b02..df633df6a 100644 --- a/docs/markdown/zh-CN/coupon.md +++ b/docs/markdown/zh-CN/coupon.md @@ -16,7 +16,7 @@ Vue.use(CouponList); @@ -24,8 +24,8 @@ Vue.use(CouponList); @@ -72,7 +72,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 必须 | |-----------|-----------|-----------|-------------|-------------| | title | 单元格标题 | `String` | `优惠券码` | - | -| chosenCoupon | 当前选中优惠券的索引 | `Number` | `-1` | - | +| chosen-coupon | 当前选中优惠券的索引 | `Number` | `-1` | - | | coupons | 可用优惠券列表 | `Array` | `[]` | - | | editable | 能否切换优惠券 | `Boolean` | `true` | - | @@ -80,17 +80,17 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 必须 | |-----------|-----------|-----------|-------------|-------------| -| chosenCoupon | 当前选中优惠券的索引 | `Number` | `-1` | - | +| chosen-coupon | 当前选中优惠券的索引 | `Number` | `-1` | - | | coupons | 可用优惠券列表 | `Array` | `[]` | - | -| disabledCoupons | 不可用优惠券列表 | `Array` | `[]` | - | -| exchangeButtonText | 兑换按钮文字 | `String` | `兑换` | - | -| exchangeButtonDisabled | 是否禁用兑换按钮 | `Boolean` | `false` | - | -| displayedCouponIndex | 滚动至特定优惠券位置 | `Number` | - | - | -| showCloseButton | 是否显示列表底部按钮 | `Boolean` | `true` | - | -| closeButtonText | 列表底部按钮文字 | `String` | `不使用优惠` | - | -| disabledListTitle | 不可用券列表标题 | `String` | `不可用优惠` | - | -| inputPlaceholder | 输入框文字提示 | `String` | `请输入优惠码` | - | -| showExchangeBar | 是否展示兑换栏 | `Boolean` | `true` | - | +| disabled-doupons | 不可用优惠券列表 | `Array` | `[]` | - | +| exchange-button-text | 兑换按钮文字 | `String` | `兑换` | - | +| exchange-button-disabled | 是否禁用兑换按钮 | `Boolean` | `false` | - | +| 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/datetime-picker.md b/docs/markdown/zh-CN/datetime-picker.md index 03cbf48e1..e51a60bcd 100644 --- a/docs/markdown/zh-CN/datetime-picker.md +++ b/docs/markdown/zh-CN/datetime-picker.md @@ -15,10 +15,10 @@ Vue.use(DatetimePicker); ``` @@ -42,9 +42,9 @@ export default { ``` @@ -54,9 +54,9 @@ export default { ``` @@ -65,11 +65,11 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 可选值 | |-----------|-----------|-----------|-------------|-------------| | type | 组件类型 | `String` | 'datetime' | 'date', 'time' | -| minDate | 可选的最小日期 | `Date` | 十年前的 1 月 1 日 | - | -| maxDate | 可选的最大日期 | `Date` | 十年后的 12 月 31 日 | - | -| minHour | 可选的最小小时 | `Number` | `0` | - | -| maxHour | 可选的最大小时 | `Number` | `23` | - | -| visibileColumnCount | 每一列可见备选元素的个数 | `Number` | `5` | - | +| min-date | 可选的最小日期 | `Date` | 十年前的 1 月 1 日 | - | +| max-date | 可选的最大日期 | `Date` | 十年后的 12 月 31 日 | - | +| min-hour | 可选的最小小时 | `Number` | `0` | - | +| max-hour | 可选的最大小时 | `Number` | `23` | - | +| visibile-column-count | 每一列可见备选元素的个数 | `Number` | `5` | - | ### Event diff --git a/docs/markdown/zh-CN/field.md b/docs/markdown/zh-CN/field.md index 4d2319127..435675928 100644 --- a/docs/markdown/zh-CN/field.md +++ b/docs/markdown/zh-CN/field.md @@ -16,7 +16,7 @@ Vue.use(Field); ```html - + ``` @@ -32,16 +32,15 @@ Vue.use(Field); placeholder="请输入用户名" required @click-icon="username = ''" - > - + /> - + required + /> ``` @@ -49,7 +48,7 @@ Vue.use(Field); ```html - + ``` @@ -57,7 +56,7 @@ Vue.use(Field); ```html - + ``` @@ -73,8 +72,7 @@ Vue.use(Field); placeholder="请输入留言" rows="1" autosize - > - +/> ``` diff --git a/docs/markdown/zh-CN/goods-action.md b/docs/markdown/zh-CN/goods-action.md index 409c51d48..e6f6f14ad 100644 --- a/docs/markdown/zh-CN/goods-action.md +++ b/docs/markdown/zh-CN/goods-action.md @@ -59,7 +59,7 @@ export default { |-----------|-----------|-----------|-------------|-------------| | text | 按钮文字 | `String` | - | - | | icon | 图标 | `String` | - | Icon 组件支持的所有图标 | -| iconClass | 图标额外类名 | `String` | `''` | - | +| icon-class | 图标额外类名 | `String` | `''` | - | | info | 图标右上角提示信息 | `String` | - | - | | url | 跳转链接 | `String` | - | - | | to | 路由跳转对象，同 `vue-router` 的 to | `String | Object` | - | - | diff --git a/docs/markdown/zh-CN/lazyload.md b/docs/markdown/zh-CN/lazyload.md index a6b235495..ec4f717fc 100644 --- a/docs/markdown/zh-CN/lazyload.md +++ b/docs/markdown/zh-CN/lazyload.md @@ -17,7 +17,7 @@ Vue.use(Lazyload, options); 将`v-lazy`指令的值设置为你需要懒加载的图片 ```html - + ``` ```javascript @@ -47,7 +47,7 @@ export default { ```html - + ``` @@ -64,4 +64,4 @@ export default { | filter | 图片url过滤 | `Object` | - | - | | lazyComponent | 是否能懒加载模块 | `Boolean` | `false` | - | -更多内容请参照：[ vue-lazyload 官方文档](https://github.com/hilongjw/vue-lazyload) +更多内容请参照：[vue-lazyload 官方文档](https://github.com/hilongjw/vue-lazyload) diff --git a/docs/markdown/zh-CN/nav-bar.md b/docs/markdown/zh-CN/nav-bar.md index 3deb9e57f..073856423 100644 --- a/docs/markdown/zh-CN/nav-bar.md +++ b/docs/markdown/zh-CN/nav-bar.md @@ -14,9 +14,9 @@ Vue.use(NavBar); ```html @@ -39,7 +39,7 @@ export default { 通过 slot 定制内容 ```html - + ``` @@ -49,9 +49,9 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 可选值 | |-----------|-----------|-----------|-------------|-------------| | title | 标题 | `String` | `''` | - | -| leftText | 左侧文案 | `String` | `''` | - | -| rightText | 右侧文案 | `String` | `''` | - | -| leftArrow | 是否显示左侧箭头 | `Boolean` | `false` | - | +| left-text | 左侧文案 | `String` | `''` | - | +| right-text | 右侧文案 | `String` | `''` | - | +| left-arrow | 是否显示左侧箭头 | `Boolean` | `false` | - | | fixed | 是否固定在顶部 | `Boolean` | `false` | - | ### Slot diff --git a/docs/markdown/zh-CN/notice-bar.md b/docs/markdown/zh-CN/notice-bar.md index d6c28efd9..58dbd5fa8 100644 --- a/docs/markdown/zh-CN/notice-bar.md +++ b/docs/markdown/zh-CN/notice-bar.md @@ -14,7 +14,7 @@ Vue.use(NoticeBar); ```html ``` @@ -50,7 +50,7 @@ Vue.use(NoticeBar); | delay | 动画延迟时间，单位秒 | Number | `1` | - | | speed | 滚动速率，单位px | Number | `50` | - | | scrollable | 是否滚动 | Boolean | `true` | - | -| leftIcon | 左侧图标图片链接 | String | - | - | +| left-icon | 左侧图标图片链接 | String | - | - | | color | 文本颜色 | String | `#f60` | - | | background | 滚动条背景 | String | `#fff7cc` | - | diff --git a/docs/markdown/zh-CN/number-keyboard.md b/docs/markdown/zh-CN/number-keyboard.md index dcc5e89f8..89c2bfc2a 100644 --- a/docs/markdown/zh-CN/number-keyboard.md +++ b/docs/markdown/zh-CN/number-keyboard.md @@ -12,15 +12,15 @@ Vue.use(NumberKeyboard); #### 默认样式 ```html - + 弹出默认键盘 @@ -30,7 +30,7 @@ Vue.use(NumberKeyboard); export default { data() { return { - showKeyboard: true + show: true } }, @@ -49,11 +49,11 @@ export default { ```html @@ -66,12 +66,12 @@ export default { | show | 是否显示键盘 | `Boolean` | - | - | | theme | 键盘样式风格 | `String` | `Default` | `Custom` | | title | 键盘标题 | `String` | - | - | -| zIndex | 键盘 z-index | `Number` | `100` | - | -| extraKey | 左下角按键内容 | `String` | `''` | - | -| closeButtonText | 关闭按钮文字，空则不展示 | `String` | `-` | - | | transition | 是否开启过场动画 | `Boolean` | `true` | - | -| showDeleteKey | 是否展示删除按钮 | `Boolean` | `true` | - | -| hideOnClickOutside | 点击外部时是否收起键盘 | `Boolean` | `true` | - | +| z-index | 键盘 z-index | `Number` | `100` | - | +| extra-key | 左下角按键内容 | `String` | `''` | - | +| close-button-text | 关闭按钮文字，空则不展示 | `String` | `-` | - | +| show-delete-key | 是否展示删除按钮 | `Boolean` | `true` | - | +| hide-on-click-outside | 点击外部时是否收起键盘 | `Boolean` | `true` | - | ### Event diff --git a/docs/markdown/zh-CN/pagination.md b/docs/markdown/zh-CN/pagination.md index cdda6f451..693ba0bd3 100644 --- a/docs/markdown/zh-CN/pagination.md +++ b/docs/markdown/zh-CN/pagination.md @@ -16,8 +16,8 @@ Vue.use(Pagination); ```html ``` @@ -36,7 +36,7 @@ export default { ```html ``` @@ -46,9 +46,9 @@ export default { ```html ``` @@ -56,13 +56,13 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 可选值 | |-----------|-----------|-----------|-------------|-------------| -| v-model | 当前页码 | `Object` | - | - | +| v-model | 当前页码 | `Number` | - | - | | mode | 显示模式 | `String` | `multi` | `simple` | -| itemsPerPage | 每页记录数 | `Number` | `10` | - | -| previousText | 上一页 | `String` | `上一页` | - | -| nextText | 下一页 | `String` | `下一页` | - | -| showPageSize | 显示的页码个数 | `Number` | `5` | - | -| forceEllipses | 显示省略号 | `Boolean` | `false` | - | +| items-per-page | 每页记录数 | `Number` | `10` | - | +| previous-text | 上一页 | `String` | `上一页` | - | +| next-text | 下一页 | `String` | `下一页` | - | +| show-page-size | 显示的页码个数 | `Number` | `5` | - | +| force-ellipses | 显示省略号 | `Boolean` | `false` | - | ### Event diff --git a/docs/markdown/zh-CN/password-input.md b/docs/markdown/zh-CN/password-input.md index 78e07d328..b4f0f7046 100644 --- a/docs/markdown/zh-CN/password-input.md +++ b/docs/markdown/zh-CN/password-input.md @@ -57,7 +57,7 @@ export default { | value | 密码值 | `String` | `''` | - | | length | 密码最大长度 | `Number` | `6` | - | | info | 输入框下方提示 | `String` | - | - | -| errorInfo | 输入框下方错误提示 | `String` | - | - | +| error-info | 输入框下方错误提示 | `String` | - | - | ### Event diff --git a/docs/markdown/zh-CN/picker.md b/docs/markdown/zh-CN/picker.md index 8718f4ae1..71cf2bab4 100644 --- a/docs/markdown/zh-CN/picker.md +++ b/docs/markdown/zh-CN/picker.md @@ -54,7 +54,7 @@ export default { ```html - - + + + ``` ### API @@ -45,7 +45,7 @@ Vue.use(Progress); |-----------|-----------|-----------|-------------|-------------| | inactive | 是否置灰 | `Boolean` | `false` | - | | percentage | 进度百分比 | `Number` | `false` | `0-100` | -| showPivot | 是否显示进度文字 | `Boolean` | `true` | - | -| pivotText | 文字显示 | `String` | 百分比文字 | - | +| show-pivot | 是否显示进度文字 | `Boolean` | `true` | - | +| pivot-text | 文字显示 | `String` | 百分比文字 | - | | color | 进度条颜色 | `String` | `#38f` | hexvalue | -| textColor | 进度条文字颜色 | `String` | `#fff` | hexvalue | +| text-color | 进度条文字颜色 | `String` | `#fff` | hexvalue | diff --git a/docs/markdown/zh-CN/pull-refresh.md b/docs/markdown/zh-CN/pull-refresh.md index 9423b9c26..d508df63a 100644 --- a/docs/markdown/zh-CN/pull-refresh.md +++ b/docs/markdown/zh-CN/pull-refresh.md @@ -44,11 +44,11 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 可选值 | |-----------|-----------|-----------|-------------|-------------| | v-model | 是否在加载中 | `Boolean` | - | - | -| pullingText | 下拉过程中顶部文案 | `String` | `下拉即可刷新...` | - | -| loosingText | 释放过程中顶部文案 | `String` | `释放即可刷新...` | - | -| loadingText | 加载过程中顶部文案 | `String` | `加载中...` | - | -| animationDuration | 动画时长 | `Number` | `300` | - | -| headHeight | 顶部内容高度 | `Number` | `50` | - | +| pulling-text | 下拉过程中顶部文案 | `String` | `下拉即可刷新...` | - | +| loosing-text | 释放过程中顶部文案 | `String` | `释放即可刷新...` | - | +| loading-text | 加载过程中顶部文案 | `String` | `加载中...` | - | +| animation-duration | 动画时长 | `Number` | `300` | - | +| head-height | 顶部内容高度 | `Number` | `50` | - | ### Slot diff --git a/docs/markdown/zh-CN/search.md b/docs/markdown/zh-CN/search.md index 69e18d93f..c8344776c 100644 --- a/docs/markdown/zh-CN/search.md +++ b/docs/markdown/zh-CN/search.md @@ -26,10 +26,10 @@ Tips: 在 `van-search` 外层增加 form 标签，并且 action 不为空，即 - + @cancel="onCancel" + /> ``` @@ -39,8 +39,9 @@ Tips: 在 `van-search` 外层增加 form 标签，并且 action 不为空，即 ```html + show-action + @search="onSearch" +>
搜索
 ``` @@ -51,7 +52,7 @@ Search 默认支持 Input 标签所有的原生属性，比如 `maxlength`、`pl | 参数 | 说明 | 类型 | 默认值 | 可选值 | |-----------|-----------|-----------|-------------|-------------| | background | 搜索框背景色 | `String` | `#f2f2f2` | 所有浏览器支持的颜色描述 | -| showAction | 是否在搜索框右侧显示取消按钮 | `Boolean` | false | - | +| 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 e67de8e84..0993d4538 100644 --- a/docs/markdown/zh-CN/sku.md +++ b/docs/markdown/zh-CN/sku.md @@ -15,12 +15,12 @@ Vue.use(Sku); v-model="showBase" :sku="sku" :goods="goods" - :goodsId="goodsId" - :hideStock="sku.hide_stock" + :goods-id="goodsId" + :hide-stock="sku.hide_stock" :quota="quota" - :quotaUsed="quotaUsed" - :resetStepperOnHide="resetStepperOnHide" - :disableStepperInput="disableStepperInput" + :quota-used="quotaUsed" + :reset-stepper-on-hide="resetStepperOnHide" + :disable-stepper-input="disableStepperInput" @buy-clicked="handleBuyClicked" @add-cart="handleAddCartClicked" /> @@ -31,16 +31,16 @@ Vue.use(Sku); ```html @@ -49,9 +49,9 @@ Vue.use(Sku); @@ -65,14 +65,14 @@ Vue.use(Sku); | v-model | 是否显示sku | `Boolean` | `false` | - | | sku | 商品sku数据 | `Object` | - | - | | goods | 商品信息 | `Object` | - | - | -| goodsId | 商品id | `String | Number` | - | - | -| hideStock | 是否显示商品剩余库存 | `Boolean` | `false` | - | -| showAddCartBtn | 是否显示加入购物车按钮 | `Boolean` | `true` | - | +| goods-id | 商品id | `String | Number` | - | - | +| hide-stock | 是否显示商品剩余库存 | `Boolean` | `false` | - | +| show-add-cart-btn | 是否显示加入购物车按钮 | `Boolean` | `true` | - | | quota | 限购数(0表示不限购) | `Number` | `0` | - | -| quotaUsed | 已经购买过的数量 | `Number` | `0` | - | -| resetStepperOnHide | 窗口隐藏时重置选择的商品数量 | `Boolean` | `false` | - | -| disableStepperInput | 是否禁用sku中stepper的input框 | `Boolean` | `false` | - | -| stepperTitle | 数量选择组件左侧文案 | `String` | `购买数量` | - | +| quota-used | 已经购买过的数量 | `Number` | `0` | - | +| reset-stepper-on-hide | 窗口隐藏时重置选择的商品数量 | `Boolean` | `false` | - | +| disable-stepper-input | 是否禁用sku中stepper的input框 | `Boolean` | `false` | - | +| stepper-title | 数量选择组件左侧文案 | `String` | `购买数量` | - | ### Event diff --git a/docs/markdown/zh-CN/stepper.md b/docs/markdown/zh-CN/stepper.md index 9cde63a92..7a5c3af99 100644 --- a/docs/markdown/zh-CN/stepper.md +++ b/docs/markdown/zh-CN/stepper.md @@ -34,10 +34,16 @@ export default { #### 高级用法 -默认是每次加减为1，可以对组件设置`step`、`min`、`max`、`defaultValue`属性 +默认是每次加减为1，可以对组件设置`step`、`min`、`max`、`default-value`属性 ```html - + ``` ### API @@ -46,10 +52,10 @@ export default { |-----------|-----------|-----------|-------------|-------------| | min | 最小值 | `String | Number` | `1` | - | | max | 最大值 | `String | Number` | - | - | -| defaultValue | 默认值 | `String | Number` | `1` | - | +| default-value | 默认值 | `String | Number` | `1` | - | | step | 步数 | `String | Number` | `1` | - | | disabled | 是否禁用 | `Boolean` | `false` | - | -| disableInput | 是否禁用input框 | `Boolean` | `false` | - | +| disable-input | 是否禁用input框 | `Boolean` | `false` | - | ### Event diff --git a/docs/markdown/zh-CN/steps.md b/docs/markdown/zh-CN/steps.md index dba0cb892..2063d693d 100644 --- a/docs/markdown/zh-CN/steps.md +++ b/docs/markdown/zh-CN/steps.md @@ -53,7 +53,7 @@ export default { 可以通过设置`direction`属性来改变步骤条的显示方式 ```html - +

【城市】物流状态1

2016-07-12 12:40

@@ -75,11 +75,11 @@ export default { |-----------|-----------|-----------|-------------|-------------| | active | 当前步骤，起始值为0 | `Number` | - | - | | icon | 当前步骤的icon | `String` | - | - | -| iconClass | 当前步骤栏为icon添加的类 | `String` | - | - | +| icon-class | 当前步骤栏为icon添加的类 | `String` | - | - | | title | 当前步骤标题 | `String` | - | - | | description | 当前步骤描述 | `String` | - | - | | direction | 显示方向 | `String` | `horizontal` | `vertical` | -| activeColor | active状态颜色 | `String` | `#06bf04` | - | +| active-color | active状态颜色 | `String` | `#06bf04` | - | ### Steps Slot diff --git a/docs/markdown/zh-CN/submit-bar.md b/docs/markdown/zh-CN/submit-bar.md index 325622129..fdbba9730 100644 --- a/docs/markdown/zh-CN/submit-bar.md +++ b/docs/markdown/zh-CN/submit-bar.md @@ -14,7 +14,7 @@ Vue.use(SubmitBar); ```html ``` @@ -26,7 +26,7 @@ Vue.use(SubmitBar); @@ -39,7 +39,7 @@ Vue.use(SubmitBar); ``` @@ -50,7 +50,7 @@ Vue.use(SubmitBar); ```html 全选 @@ -66,8 +66,8 @@ Vue.use(SubmitBar); |-----------|-----------|-----------|-------------|-------------| | price | 价格（单位分） | `Number` | - | - | | label | 价格文案 | `String` | `合计：` | - | -| buttonText | 按钮文字 | `String` | - | - | -| buttonType | 按钮类型 | `String` | `danger` | - | +| button-text | 按钮文字 | `String` | - | - | +| button-type | 按钮类型 | `String` | `danger` | - | | tip | 提示文案 | `String` | - | - | | disabled | 是否禁用按钮 | `Boolean` | `false` | - | | loading | 是否显示加载中的按钮 | `Boolean` | `false` | - | diff --git a/docs/markdown/zh-CN/swipe.md b/docs/markdown/zh-CN/swipe.md index c58f38f7e..47c7dcfd8 100644 --- a/docs/markdown/zh-CN/swipe.md +++ b/docs/markdown/zh-CN/swipe.md @@ -52,8 +52,8 @@ export default { |-----------|-----------|-----------|-------------|-------------| | autoplay | 自动轮播间隔，单位为 ms | `Number` | - | - | | duration | 动画时长，单位为 ms | `Number` | `500` | - | -| showIndicators | 是否显示指示器 | `Boolean` | `true` | - | -| initialSwipe | 初始位置，从 0 开始算 | `Number` | `0` | - | +| show-indicators | 是否显示指示器 | `Boolean` | `true` | - | +| initial-swipe | 初始位置，从 0 开始算 | `Number` | `0` | - | ### 事件 diff --git a/docs/markdown/zh-CN/tab.md b/docs/markdown/zh-CN/tab.md index 548e44f56..bd154372c 100644 --- a/docs/markdown/zh-CN/tab.md +++ b/docs/markdown/zh-CN/tab.md @@ -34,7 +34,7 @@ export default { #### 横向滚动 -默认情况下多于4个tab时，可以横向滚动tab。可以通过设置`swipeThreshold`这个阙值，多于这个阙值时，tab就会支持横向滚动。 +默认情况下多于4个tab时，可以横向滚动tab。可以通过设置`swipe-threshold`这个阙值，多于这个阙值时，tab就会支持横向滚动。 ```html @@ -118,7 +118,7 @@ export default { | type | Tab 样式类型 | `String` | `line` | `card` | | active | 默认激活的 tab | `String` `Number` | `0` | - | | duration | 切换 tab 的动画时间 | `Number` | `0.2` | - | -| swipeThreshold | 滚动阀值，设置 Tab 超过多少个可滚动 | `Number` | `4` | - | +| swipe-threshold | 滚动阀值，设置 Tab 超过多少个可滚动 | `Number` | `4` | - | | sticky | 是否使用粘性定位布局 | `Boolean` | `false` | - | ### Tab API diff --git a/docs/markdown/zh-CN/tree-select.md b/docs/markdown/zh-CN/tree-select.md index 80b301c33..b0bce8e14 100644 --- a/docs/markdown/zh-CN/tree-select.md +++ b/docs/markdown/zh-CN/tree-select.md @@ -48,11 +48,11 @@ export default { #### 传入参数 -| 参数 | 说明 | 类型 | 默认值 | 必须 | +| 参数 | 说明 | 类型 | 默认值 | 可选值 | |-----------|-----------|-----------|-------------|-------------| | items | 分类显示所需的数据，具体数据结构可看 数据结构 | `Array` | `[]` | - | -| mainActiveIndex | 左侧导航高亮的索引 | `Number` | `0` | - | -| activeId | 右侧选择项，高亮的数据id | `Number` | `0` | - | +| main-active-index | 左侧导航高亮的索引 | `Number` | `0` | - | +| active-id | 右侧选择项，高亮的数据id | `Number` | `0` | - | #### 事件 | 事件名 | 说明 | 参数 | diff --git a/docs/markdown/zh-CN/uploader.md b/docs/markdown/zh-CN/uploader.md index 95ea7532d..6e93da559 100644 --- a/docs/markdown/zh-CN/uploader.md +++ b/docs/markdown/zh-CN/uploader.md @@ -12,7 +12,7 @@ Vue.use(Uploader); #### 基础用法 ```html - + ``` @@ -20,7 +20,7 @@ Vue.use(Uploader); ```javascript export default { methods: { - logContent(file) { + onRead(file) { console.log(file) } } @@ -31,7 +31,7 @@ export default { 可以直接在 Uploader 上设置 accpet、multiple 等原生属性，input 会自动继承该属性 ```html - + ``` @@ -40,10 +40,10 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 可选值 | |-----------|-----------|-----------|-------------|-------------| -| resultType | 读取文件的方式，以base64的方式读取；以文本的方式读取 | `String` | `dataUrl` | `text` | +| result-type | 读取文件的方式，以base64的方式读取；以文本的方式读取 | `String` | `dataUrl` | `text` | | disable | 是否禁用上传,在图片上传期间设置为true，禁止用户点击此组件上传图片 | `Boolean` | `false` | - | -| beforeRead | 读文件之前的钩子，参数为选择的文件，若返回 false 则停止读取文件 | `Function` | - | - | -| afterRead | 文件读完之后回调此函数，参数为 { file:'选择的文件',content:'读的内容' } | `Function` | - | - | +| before-read | 读文件之前的钩子，参数为选择的文件，若返回 false 则停止读取文件 | `Function` | - | - | +| after-read | 文件读完之后回调此函数，参数为 { file:'选择的文件',content:'读的内容' } | `Function` | - | - | ### Slot diff --git a/docs/markdown/zh-CN/waterfall.md b/docs/markdown/zh-CN/waterfall.md index ab48739e7..3d400f3e2 100644 --- a/docs/markdown/zh-CN/waterfall.md +++ b/docs/markdown/zh-CN/waterfall.md @@ -37,7 +37,8 @@ export default {
    + waterfall-offset="400" +>
  • {{ item }}
``` @@ -59,7 +60,7 @@ export default { loadMore() { this.disabled = true; setTimeout(() => { - for (let i = 0; i < 5; i ++) { + for (let i = 0; i < 5; i++) { this.list.push(this.list.length); } this.disabled = false;