From a3b9e67d363f9b902b18a01410aec95e1cd6bb61 Mon Sep 17 00:00:00 2001 From: neverland Date: Fri, 20 Nov 2020 20:39:40 +0800 Subject: [PATCH 1/3] docs: fix grammar errors (#7594) --- src/action-sheet/README.md | 18 +++++++++--------- src/address-edit/README.md | 18 +++++++++--------- src/address-list/README.md | 12 ++++++------ src/area/README.md | 6 +++--- src/button/README.md | 4 ++-- src/calendar/README.md | 22 +++++++++++----------- src/card/README.md | 8 ++++---- src/cell/README.md | 6 +++--- src/checkbox/README.md | 14 +++++++------- src/col/README.md | 12 ++++++------ src/collapse/README.md | 6 +++--- src/contact-card/README.md | 6 +++--- src/contact-edit/README.md | 8 ++++---- src/contact-list/README.md | 6 +++--- src/count-down/README.md | 8 ++++---- src/coupon-list/README.md | 4 ++-- src/datetime-picker/README.md | 10 +++++----- src/dialog/README.md | 20 ++++++++++---------- src/dropdown-menu/README.md | 18 +++++++++--------- src/field/README.md | 16 ++++++++-------- src/form/README.md | 4 ++-- src/grid/README.md | 6 +++--- src/icon/README.md | 6 +++--- src/image-preview/README.md | 14 +++++++------- src/image/README.md | 10 +++++----- src/index-bar/README.md | 4 ++-- src/list/README.md | 10 +++++----- src/mixins/popup/index.js | 2 +- src/nav-bar/README.md | 8 ++++---- src/notice-bar/README.md | 10 +++++----- src/number-keyboard/README.md | 14 +++++++------- src/overlay/README.md | 6 +++--- src/pagination/README.md | 6 +++--- src/password-input/README.md | 6 +++--- src/picker/PickerColumn.js | 2 +- src/picker/README.md | 6 +++--- src/popover/README.md | 14 +++++++------- src/popup/README.md | 18 +++++++++--------- src/pull-refresh/README.md | 8 ++++---- src/radio/README.md | 12 ++++++------ src/rate/README.md | 6 +++--- src/search/README.md | 20 ++++++++++---------- src/share-sheet/README.md | 8 ++++---- src/sidebar/README.md | 12 ++++++------ src/sku/README.md | 18 +++++++++--------- src/slider/README.md | 12 ++++++------ src/stepper/README.md | 12 ++++++------ src/steps/README.md | 2 +- src/sticky/README.md | 6 +++--- src/swipe-cell/README.md | 6 +++--- src/swipe/README.md | 12 ++++++------ src/switch-cell/README.md | 2 +- src/switch/README.md | 8 ++++---- src/tab/README.md | 10 +++++----- src/tabbar/README.md | 2 +- src/tag/README.md | 8 ++++---- src/toast/README.md | 2 +- src/tree-select/README.md | 4 ++-- src/uploader/README.md | 10 +++++----- 59 files changed, 274 insertions(+), 274 deletions(-) diff --git a/src/action-sheet/README.md b/src/action-sheet/README.md index c7e67d974..ec4ea5312 100644 --- a/src/action-sheet/README.md +++ b/src/action-sheet/README.md @@ -163,8 +163,8 @@ export default { | lock-scroll | Whether to lock background scroll | _boolean_ | `true` | | lazy-render | Whether to lazy render util appeared | _boolean_ | `true` | | close-on-popstate `v2.5.3` | Whether to close when popstate | _boolean_ | `false` | -| close-on-click-action | Whether to close when click action | _boolean_ | `false` | -| close-on-click-overlay | Whether to close when click overlay | _boolean_ | `true` | +| close-on-click-action | Whether to close when an action is clicked | _boolean_ | `false` | +| close-on-click-overlay | Whether to close when overlay is clicked | _boolean_ | `true` | | safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` | | get-container | Return the mount node for ActionSheet | _string \| () => Element_ | - | @@ -183,13 +183,13 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| select | Triggered when click option | _action: Action, index: number_ | -| cancel | Triggered when click cancel button | - | -| open | Triggered when open ActionSheet | - | -| close | Triggered when close ActionSheet | - | -| opened | Triggered when opened ActionSheet | - | -| closed | Triggered when closed ActionSheet | - | -| click-overlay | Triggered when click overlay | - | +| select | Emitted when an option is clicked | _action: Action, index: number_ | +| cancel | Emitted when the cancel button is clicked | - | +| open | Emitted when opening ActionSheet | - | +| close | Emitted when closing ActionSheet | - | +| opened | Emitted when ActionSheet is opened | - | +| closed | Emitted when ActionSheet is closed | - | +| click-overlay | Emitted when overlay is clicked | - | ### Slots diff --git a/src/address-edit/README.md b/src/address-edit/README.md index c1256d35e..525fc65bb 100644 --- a/src/address-edit/README.md +++ b/src/address-edit/README.md @@ -94,15 +94,15 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| save | Triggered when click save button | content：form content | -| focus | Triggered when focus field | key: field name | -| delete | Triggered when confirm delete | content：form content | -| cancel-delete | Triggered when cancel delete | content：form content | -| select-search | Triggered when select search result | value: search content | -| click-area `v2.5.9` | Triggered when click area | - | -| change-area | Triggered when change area | values: area values | -| change-detail | Triggered when address detail changed | value: address detail | -| change-default | Triggered when switch default address | value: checked | +| save | Emitted when the save button is clicked | content：form content | +| focus | Emitted when field is focused | key: field name | +| delete | Emitted when confirming delete | content：form content | +| cancel-delete | Emitted when canceling delete | content：form content | +| select-search | Emitted when a search result is selected | value: search content | +| click-area `v2.5.9` | Emitted when the area field is clicked | - | +| change-area | Emitted when area changed | values: area values | +| change-detail | Emitted when address detail changed | value: address detail | +| change-default | Emitted when switching default address | value: checked | ### Slots diff --git a/src/address-list/README.md b/src/address-list/README.md index 298a50f94..51a2ac848 100644 --- a/src/address-list/README.md +++ b/src/address-list/README.md @@ -86,12 +86,12 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| add | Triggered when click add button | - | -| edit | Triggered when edit address | item: address object，index | -| select | Triggered when select address | item: address object，index | -| edit-disabled | Triggered when edit disabled address | item: address object，index | -| select-disabled | Triggered when select disabled address | item: address object，index | -| click-item | Triggered when click address item | item: address object，index | +| add | Emitted when the add button is clicked | - | +| edit | Emitted when the edit icon of address is clicked | item: address object，index | +| select | Emitted when an address is selected | item: address object，index | +| edit-disabled | Emitted when the edit icon of disabled address is clicked | item: address object，index | +| select-disabled | Emitted when a disabled address is selected | item: address object，index | +| click-item | Emitted when an address item is clicked | item: address object，index | ### Data Structure of Address diff --git a/src/area/README.md b/src/area/README.md index b4db1c884..04e182232 100644 --- a/src/area/README.md +++ b/src/area/README.md @@ -75,9 +75,9 @@ To have a selected value，simply pass the `code` of target area to `value` prop | Event | Description | Arguments | | --- | --- | --- | -| confirm | triggers when clicking the confirm button | an array | -| cancel | triggers when clicking the cancel button | - | -| change | Triggered when current option changed | Picker instance, current values，column index | +| confirm | Emitted when the confirm button is clicked | selected areas | +| cancel | Emitted when the cancel button is clicked | - | +| change | Emitted when current option changed | Picker instance, current values，column index | ### Slots diff --git a/src/button/README.md b/src/button/README.md index 7caef15b0..82e5b7ae1 100644 --- a/src/button/README.md +++ b/src/button/README.md @@ -131,8 +131,8 @@ Vue.use(Button); | Event | Description | Arguments | | --- | --- | --- | -| click | Triggered when click button and not disabled or loading | _event: Event_ | -| touchstart | Triggered when touch start | _event: TouchEvent_ | +| click | Emitted when button is clicked and not disabled or loading | _event: Event_ | +| touchstart | Emitted when button is touched | _event: TouchEvent_ | ### Slots diff --git a/src/calendar/README.md b/src/calendar/README.md index be87db300..9a812052f 100644 --- a/src/calendar/README.md +++ b/src/calendar/README.md @@ -17,7 +17,7 @@ Vue.use(Calendar); ### Select Single Date -The `confirm` event will be triggered after the date selection is completed. +The `confirm` event will be emitted after the date selection is completed. ```html @@ -100,7 +100,7 @@ export default { ### Quick Select -Set `show-confirm` to `false` to hide the confirm button. In this case, the `confirm` event will be triggered immediately after the selection is completed. +Set `show-confirm` to `false` to hide the confirm button. In this case, the `confirm` event will be emitted immediately after the selection is completed. ```html @@ -256,7 +256,7 @@ Following props are supported when the poppable is true | position | Popup position, can be set to `top` `right` `left` | _string_ | `bottom` | | round | Whether to show round corner | _boolean_ | `true` | | close-on-popstate `v2.4.4` | Whether to close when popstate | _boolean_ | `true` | -| close-on-click-overlay | Whether to close when click overlay | _boolean_ | `true` | +| close-on-click-overlay | Whether to close when overlay is clicked | _boolean_ | `true` | | safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` | | get-container `v2.4.4` | Return the mount node for Calendar | _string \| () => Element_ | - | @@ -294,14 +294,14 @@ Following props are supported when the type is multiple | Event | Description | Arguments | | --- | --- | --- | -| select | Triggered when select date | _value: Date \| Date[]_ | -| confirm | Triggered after date selection is complete，if `show-confirm` is`true`, it is triggered after clicking the confirm button | _value: Date \| Date[]_ | -| open `v2.5.2` | Triggered when open Popup | - | -| close `v2.5.2` | Triggered when close Popup | - | -| opened `v2.5.2` | Triggered when opened Popup | - | -| closed `v2.5.2` | Triggered when closed Popup | - | -| unselect `v2.7.2` | Triggered when unselect date when type is multiple | _value: Date_ | -| month-show `v2.8.2` | Triggered when a month enters the visible area | _{ date: Date, title: string }_ | +| select | Emitted when date is selected | _value: Date \| Date[]_ | +| confirm | Emitted after date selection is complete，if `show-confirm` is `true`, it is Emitted after clicking the confirm button | _value: Date \| Date[]_ | +| open `v2.5.2` | Emitted when opening Popup | - | +| close `v2.5.2` | Emitted when closing Popup | - | +| opened `v2.5.2` | Emitted when Popup is opened | - | +| closed `v2.5.2` | Emitted when Popup is closed | - | +| unselect `v2.7.2` | Emitted when unselect date when type is multiple | _value: Date_ | +| month-show `v2.8.2` | Emitted when a month enters the visible area | _{ date: Date, title: string }_ | ### Slots diff --git a/src/card/README.md b/src/card/README.md index 952af913a..37efd5129 100644 --- a/src/card/README.md +++ b/src/card/README.md @@ -80,10 +80,10 @@ Use slot to custom content. ### Events -| Event | Description | Arguments | -| ----------- | ---------------------------- | -------------- | -| click | Triggered when clicked | _event: Event_ | -| click-thumb | Triggered when thumb clicked | _event: Event_ | +| Event | Description | Arguments | +| ----------- | --------------------------------- | -------------- | +| click | Emitted when component is clicked | _event: Event_ | +| click-thumb | Emitted when thumb is clicked | _event: Event_ | ### Slots diff --git a/src/cell/README.md b/src/cell/README.md index a3e13a470..07f3c7931 100644 --- a/src/cell/README.md +++ b/src/cell/README.md @@ -153,9 +153,9 @@ Vue.use(CellGroup); ### Cell Events -| Event | Description | Arguments | -| ----- | ------------------------- | -------------- | -| click | Triggered when click cell | _event: Event_ | +| Event | Description | Arguments | +| ----- | ---------------------------- | -------------- | +| click | Emitted when cell is clicked | _event: Event_ | ### CellGroup Slots diff --git a/src/checkbox/README.md b/src/checkbox/README.md index 3f6321f27..e32bbbede 100644 --- a/src/checkbox/README.md +++ b/src/checkbox/README.md @@ -235,16 +235,16 @@ export default { ### Checkbox Events -| Event | Description | Parameters | -| ------ | ----------------------------- | ------------------ | -| change | Triggered when value changed | _checked: boolean_ | -| click | Triggered when click checkbox | _event: Event_ | +| Event | Description | Parameters | +| ------ | ------------------------------------ | ------------------ | +| change | Emitted when value changed | _checked: boolean_ | +| click | Emitted when the checkbox is clicked | _event: Event_ | ### CheckboxGroup Events -| Event | Description | Parameters | -| ------ | ---------------------------- | -------------- | -| change | Triggered when value changed | _names: any[]_ | +| Event | Description | Parameters | +| ------ | -------------------------- | -------------- | +| change | Emitted when value changed | _names: any[]_ | ### Checkbox Slots diff --git a/src/col/README.md b/src/col/README.md index 28cc21d2b..1acaa1eb3 100644 --- a/src/col/README.md +++ b/src/col/README.md @@ -108,12 +108,12 @@ Setting `type` to `flex` to enable flex layout. ### Row Events -| Event | Description | Arguments | -| ----- | ------------------------ | -------------- | -| click | Triggered when click row | _event: Event_ | +| Event | Description | Arguments | +| ----- | ------------------------------- | -------------- | +| click | Emitted when the row is clicked | _event: Event_ | ### Col Events -| Event | Description | Arguments | -| ----- | ------------------------ | -------------- | -| click | Triggered when click col | _event: Event_ | +| Event | Description | Arguments | +| ----- | ------------------------------- | -------------- | +| click | Emitted when the col is clicked | _event: Event_ | diff --git a/src/collapse/README.md b/src/collapse/README.md index 5bbfe7241..20f2cfbbe 100644 --- a/src/collapse/README.md +++ b/src/collapse/README.md @@ -110,9 +110,9 @@ export default { ### Collapse Events -| Event | Description | Arguments | -| ------ | --------------------------- | ----------- | -| change | Triggered when switch panel | activeNames | +| Event | Description | Arguments | +| ------ | ---------------------------- | ----------- | +| change | Emitted when switching panel | activeNames | ### CollapseItem Props diff --git a/src/contact-card/README.md b/src/contact-card/README.md index 5e2f2ef9a..dcf8559f2 100644 --- a/src/contact-card/README.md +++ b/src/contact-card/README.md @@ -84,6 +84,6 @@ export default { ### Events -| Event | Description | Arguments | -| ----- | ---------------------- | -------------- | -| click | Triggered when clicked | _event: Event_ | +| Event | Description | Arguments | +| ----- | --------------------------------- | -------------- | +| click | Emitted when component is clicked | _event: Event_ | diff --git a/src/contact-edit/README.md b/src/contact-edit/README.md index 6a323dbaf..b569124c2 100644 --- a/src/contact-edit/README.md +++ b/src/contact-edit/README.md @@ -60,10 +60,10 @@ export default { ### Events -| Event | Description | Arguments | -| ------ | ---------------------------------- | --------------------- | -| save | Triggered when click save button | content：contact info | -| delete | Triggered when click delete button | content：contact info | +| Event | Description | Arguments | +| ------ | ----------------------------------------- | --------------------- | +| save | Emitted when the save button is clicked | content：contact info | +| delete | Emitted when the delete button is clicked | content：contact info | ### Data Structure of Contact diff --git a/src/contact-list/README.md b/src/contact-list/README.md index b61defc8a..369370085 100644 --- a/src/contact-list/README.md +++ b/src/contact-list/README.md @@ -75,9 +75,9 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| add | Triggered when click add button | - | -| edit | Triggered when click edit button | _contact: Contact，index: number_ | -| select | Triggered when select contact | _contact: Contact, index: number_ | +| add | Emitted when the add button is clicked | - | +| edit | Emitted when the edit button is clicked | _contact: Contact，index: number_ | +| select | Emitted when a contact is selected | _contact: Contact, index: number_ | ### Data Structure of Contact diff --git a/src/count-down/README.md b/src/count-down/README.md index 99e5b7c46..b8402f0de 100644 --- a/src/count-down/README.md +++ b/src/count-down/README.md @@ -133,10 +133,10 @@ export default { ### Events -| Event | Description | Arguments | -| --------------- | ---------------------------------- | -------------------- | -| finish | Triggered when count down finished | - | -| change `v2.4.4` | Triggered when count down changed | _timeData: TimeData_ | +| Event | Description | Arguments | +| --------------- | -------------------------------- | -------------------- | +| finish | Emitted when count down finished | - | +| change `v2.4.4` | Emitted when count down changed | _timeData: TimeData_ | ### Slots diff --git a/src/coupon-list/README.md b/src/coupon-list/README.md index b26f2efac..24a706b65 100644 --- a/src/coupon-list/README.md +++ b/src/coupon-list/README.md @@ -109,8 +109,8 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| change | Triggered when change chosen coupon | index: index of chosen coupon | -| exchange | Triggered when exchange coupon | code: exchange code | +| change | Emitted when chosen coupon changed | index: index of chosen coupon | +| exchange | Emitted when exchanging coupon | code: exchange code | ### Data Structure of Coupon diff --git a/src/datetime-picker/README.md b/src/datetime-picker/README.md index c42961fe5..5c3d0adc3 100644 --- a/src/datetime-picker/README.md +++ b/src/datetime-picker/README.md @@ -286,11 +286,11 @@ Following props are supported when the type is time ### Events -| Event | Description | Arguments | -| ------- | ----------------------------------- | ----------------------- | -| change | Triggered when value changed | picker: Picker instance | -| confirm | Triggered when click confirm button | value: current value | -| cancel | Triggered when click cancel button | - | +| Event | Description | Arguments | +| --- | --- | --- | +| change | Emitted when value changed | picker: Picker instance | +| confirm | Emitted when the confirm button is clicked | value: current value | +| cancel | Emitted when the cancel button is clicked | - | ### Methods diff --git a/src/dialog/README.md b/src/dialog/README.md index 2505aa145..3ba44796e 100644 --- a/src/dialog/README.md +++ b/src/dialog/README.md @@ -153,7 +153,7 @@ export default { | overlayClass | Custom overlay class | _string_ | - | | overlayStyle | Custom overlay style | _object_ | - | | closeOnPopstate | Whether to close when popstate | _boolean_ | `true` | -| closeOnClickOverlay | Whether to close when click overlay | _boolean_ | `false` | +| closeOnClickOverlay | Whether to close when overlay is clicked | _boolean_ | `false` | | lockScroll | Whether to lock body scroll | _boolean_ | `true` | | allowHtml `v2.8.7` | Whether to allow HTML rendering in message | _boolean_ | `true` | | beforeClose | Callback before close,
call done() to close dialog,
call done(false) to cancel loading | (action: string, done: Function) => void | - | @@ -180,7 +180,7 @@ export default { | overlay-class | Custom overlay class | _string_ | - | | overlay-style | Custom overlay style | _object_ | - | | close-on-popstate | Whether to close when popstate | _boolean_ | `true` | -| close-on-click-overlay | Whether to close when click overlay | _boolean_ | `false` | +| close-on-click-overlay | Whether to close when overlay is clicked | _boolean_ | `false` | | lazy-render | Whether to lazy render util appeared | _boolean_ | `true` | | lock-scroll | Whether to lock background scroll | _boolean_ | `true` | | allow-html `v2.8.7` | Whether to allow HTML rendering in message | _boolean_ | `true` | @@ -190,14 +190,14 @@ export default { ### Events -| Event | Description | Parameters | -| ------- | ----------------------------------- | ---------- | -| confirm | Triggered when click confirm button | - | -| cancel | Triggered when click cancel button | - | -| open | Triggered when open Dialog | - | -| close | Triggered when close Dialog | - | -| opened | Triggered when opened Dialog | - | -| closed | Triggered when closed Dialog | - | +| Event | Description | Parameters | +| ------- | ------------------------------------------ | ---------- | +| confirm | Emitted when the confirm button is clicked | - | +| cancel | Emitted when the cancel button is clicked | - | +| open | Emitted when opening Dialog | - | +| close | Emitted when closing Dialog | - | +| opened | Emitted when Dialog is opened | - | +| closed | Emitted when Dialog is closed | - | ### Slots diff --git a/src/dropdown-menu/README.md b/src/dropdown-menu/README.md index d7c7e71fb..d4fd3607f 100644 --- a/src/dropdown-menu/README.md +++ b/src/dropdown-menu/README.md @@ -129,8 +129,8 @@ Use `active-color` prop to custom active color of the title and options. | z-index | z-index of menu item | _number \| string_ | `10` | | duration | Transition duration, unit second | _number \| string_ | `0.2` | | overlay | Whether to show overlay | _boolean_ | `true` | -| close-on-click-overlay | Whether to close when click overlay | _boolean_ | `true` | -| close-on-click-outside | Whether to close when click outside | _boolean_ | `true` | +| close-on-click-overlay | Whether to close when overlay is clicked | _boolean_ | `true` | +| close-on-click-outside | Whether to close when outside is clicked | _boolean_ | `true` | ### DropdownItem Props @@ -146,13 +146,13 @@ Use `active-color` prop to custom active color of the title and options. ### DropdownItem Events -| Event | Description | Arguments | -| ------ | ----------------------------------------- | --------- | -| change | Triggered select option and value changed | value | -| open | Triggered when open menu | - | -| close | Triggered when close menu | - | -| opened | Triggered when menu opened | - | -| closed | Triggered when menu closed | - | +| Event | Description | Arguments | +| ------ | --------------------------------------- | --------- | +| change | Emitted select option and value changed | value | +| open | Emitted when opening menu | - | +| close | Emitted when closing menu | - | +| opened | Emitted when menu is opened | - | +| closed | Emitted when menu is closed | - | ### DropdownItem Slots diff --git a/src/field/README.md b/src/field/README.md index 43261bdbf..29ae9e803 100644 --- a/src/field/README.md +++ b/src/field/README.md @@ -259,14 +259,14 @@ Field support all native events of input tag | Event | Description | Parameters | | --- | --- | --- | -| input | Triggered when input value changed | _value: string_ | -| focus | Triggered when input gets focus | _event: Event_ | -| blur | Triggered when input loses focus | _event: Event_ | -| clear | Triggered when click clear icon | _event: Event_ | -| click | Triggered when click Field | _event: Event_ | -| click-input `v2.8.1` | Triggered when click input | _event: Event_ | -| click-left-icon | Triggered when click the left icon of Field | _event: Event_ | -| click-right-icon | Triggered when click the right icon of Field | _event: Event_ | +| input | Emitted when input value changed | _value: string_ | +| focus | Emitted when input is focused | _event: Event_ | +| blur | Emitted when input is blured | _event: Event_ | +| clear | Emitted when the clear icon is clicked | _event: Event_ | +| click | Emitted when component is clicked | _event: Event_ | +| click-input `v2.8.1` | Emitted when the input is clicked | _event: Event_ | +| click-left-icon | Emitted when the left icon is clicked | _event: Event_ | +| click-right-icon | Emitted when the right icon is clicked | _event: Event_ | ### Methods diff --git a/src/form/README.md b/src/form/README.md index e90b9ff37..bbca7e1c9 100644 --- a/src/form/README.md +++ b/src/form/README.md @@ -462,8 +462,8 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| submit | Triggered after submitting the form and validation passed | _values: object_ | -| failed | Triggered after submitting the form and validation failed | _errorInfo: { values: object, errors: object[] }_ | +| submit | Emitted after submitting the form and validation passed | _values: object_ | +| failed | Emitted after submitting the form and validation failed | _errorInfo: { values: object, errors: object[] }_ | ### Methods diff --git a/src/grid/README.md b/src/grid/README.md index 0c997fbc3..1795d5e70 100644 --- a/src/grid/README.md +++ b/src/grid/README.md @@ -121,9 +121,9 @@ Vue.use(GridItem); ### GridItem Events -| Event | Description | Arguments | -| ----- | ---------------------- | -------------- | -| click | Triggered when clicked | _event: Event_ | +| Event | Description | Arguments | +| ----- | --------------------------------- | -------------- | +| click | Emitted when component is clicked | _event: Event_ | ### GridItem Slots diff --git a/src/icon/README.md b/src/icon/README.md index 0e47d983e..795874810 100644 --- a/src/icon/README.md +++ b/src/icon/README.md @@ -96,6 +96,6 @@ import 'vant/lib/icon/local.css'; ### Events -| Event | Description | Arguments | -| ----- | ------------------------- | -------------- | -| click | Triggered when click icon | _event: Event_ | +| Event | Description | Arguments | +| ----- | ---------------------------- | -------------- | +| click | Emitted when icon is clicked | _event: Event_ | diff --git a/src/image-preview/README.md b/src/image-preview/README.md index c1c2deae6..13af99942 100644 --- a/src/image-preview/README.md +++ b/src/image-preview/README.md @@ -118,9 +118,9 @@ export default { | showIndicators | Whether to show indicators | _boolean_ | `false` | | loop | Whether to enable loop | _boolean_ | `true` | | swipeDuration | Animation duration (ms) | _number \| string_ | `500` | -| onClose | Triggered when close | _Function_ | - | -| onChange | Triggered when current image change | _Function_ | - | -| onScale | Triggered when current image scale | _Function_ | - | +| onClose | Emitted when ImagePreview is closed | _Function_ | - | +| onChange | Emitted when current image changed | _Function_ | - | +| onScale | Emitted when scaling current image | _Function_ | - | | closeOnPopstate | Whether to close when popstate | _boolean_ | `true` | | asyncClose | Whether to enable async close | _boolean_ | `false` | | className | Custom className | _any_ | - | @@ -155,10 +155,10 @@ export default { | Event | Description | Parameters | | --- | --- | --- | -| close | Triggered when close | { index, url } | -| closed `v2.5.6` | Triggered after closed | - | -| change | Triggered when current image change | index: index of current image | -| scale `v2.5.0` | Triggered when current image scale | { index: index of current image, scale: scale of current image} | +| close | Emitted when closing ImagePreview | { index, url } | +| closed `v2.5.6` | Emitted when ImagePreview is closed | - | +| change | Emitted when current image changed | index: index of current image | +| scale `v2.5.0` | Emitted when scaling current image | { index: index of current image, scale: scale of current image} | | swipeTo `2.9.0` | Swipe to target index | index: target index, options: Options | - | ### Slots diff --git a/src/image/README.md b/src/image/README.md index d344bc191..8350fde92 100644 --- a/src/image/README.md +++ b/src/image/README.md @@ -91,11 +91,11 @@ Vue.use(Lazyload); ### Events -| Event | Description | Arguments | -| ----- | -------------------------------- | -------------- | -| click | Triggered when click image | _event: Event_ | -| load | Triggered when image loaded | - | -| error | Triggered when image load failed | - | +| Event | Description | Arguments | +| ----- | ------------------------------ | -------------- | +| click | Emitted when image is clicked | _event: Event_ | +| load | Emitted when image loaded | - | +| error | Emitted when image load failed | - | ### Slots diff --git a/src/index-bar/README.md b/src/index-bar/README.md index ec0856ced..6c2f05b5c 100644 --- a/src/index-bar/README.md +++ b/src/index-bar/README.md @@ -80,8 +80,8 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| select | Triggered when select index | _index: number \| string_ | -| change `v2.10.10` | Triggered when active index changed | _index: number \| string_ | +| select | Emitted when an index is selected | _index: number \| string_ | +| change `v2.10.10` | Emitted when active index changed | _index: number \| string_ | ### IndexAnchor Slots diff --git a/src/list/README.md b/src/list/README.md index 71e7e68b4..f1b8af9f5 100644 --- a/src/list/README.md +++ b/src/list/README.md @@ -144,10 +144,10 @@ export default { | Attribute | Description | Type | Default | | --- | --- | --- | --- | -| v-model | Whether to show loading info，the `load` event will not be triggered when loading | _boolean_ | `false` | -| finished | Whether loading is finished，the `load` event will not be triggered when finished | _boolean_ | `false` | -| error | Whether loading is error，the `load` event will be triggered only when error text clicked, the `sync` modifier is needed | _boolean_ | `false` | -| offset | The load event will be triggered when the distance between the scrollbar and the bottom is less than offset | _number \| string_ | `300` | +| v-model | Whether to show loading info，the `load` event will not be Emitted when loading | _boolean_ | `false` | +| finished | Whether loading is finished，the `load` event will not be Emitted when finished | _boolean_ | `false` | +| error | Whether loading is error，the `load` event will be Emitted only when error text clicked, the `sync` modifier is needed | _boolean_ | `false` | +| offset | The load event will be Emitted when the distance between the scrollbar and the bottom is less than offset | _number \| string_ | `300` | | loading-text | Loading text | _string_ | `Loading...` | | finished-text | Finished text | _string_ | - | | error-text | Error loaded text | _string_ | - | @@ -158,7 +158,7 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| load | Triggered when the distance between the scrollbar and the bottom is less than offset | - | +| load | Emitted when the distance between the scrollbar and the bottom is less than offset | - | ### Methods diff --git a/src/mixins/popup/index.js b/src/mixins/popup/index.js index 628819e93..6c458cf82 100644 --- a/src/mixins/popup/index.js +++ b/src/mixins/popup/index.js @@ -28,7 +28,7 @@ export const popupMixinProps = { overlayStyle: Object, // overlay custom class name overlayClass: String, - // whether to close popup when click overlay + // whether to close popup when overlay is clicked closeOnClickOverlay: Boolean, // z-index zIndex: [Number, String], diff --git a/src/nav-bar/README.md b/src/nav-bar/README.md index 3462c6ea0..d18bd5204 100644 --- a/src/nav-bar/README.md +++ b/src/nav-bar/README.md @@ -75,7 +75,7 @@ export default { ### Events -| Event | Description | Arguments | -| ----------- | --------------------------------- | --------- | -| click-left | Triggered when click left button | - | -| click-right | Triggered when click right button | - | +| Event | Description | Arguments | +| ----------- | ---------------------------------------- | --------- | +| click-left | Emitted when the left button is clicked | - | +| click-right | Emitted when the right button is clicked | - | diff --git a/src/notice-bar/README.md b/src/notice-bar/README.md index d7dc29137..8b1ac3ae5 100644 --- a/src/notice-bar/README.md +++ b/src/notice-bar/README.md @@ -100,11 +100,11 @@ Vue.use(NoticeBar); ### Events -| Event | Description | Arguments | -| --------------- | ------------------------------ | -------------- | -| click | Triggered when click NoticeBar | _event: Event_ | -| close | Triggered when closed | _event: Event_ | -| replay `v2.6.2` | Triggered when replay | - | +| Event | Description | Arguments | +| --------------- | ---------------------------------- | -------------- | +| click | Emitted when NoticeBar is clicked | _event: Event_ | +| close | Emitted when NoticeBar is closed | _event: Event_ | +| replay `v2.6.2` | Emitted when NoticeBar is replayed | - | ### Slots diff --git a/src/number-keyboard/README.md b/src/number-keyboard/README.md index 73456df9d..96e5990b3 100644 --- a/src/number-keyboard/README.md +++ b/src/number-keyboard/README.md @@ -159,7 +159,7 @@ export default { | delete-button-text | Delete button text | _string_ | Delete Icon | | close-button-loading `v2.7.0` | Whether to show loading close button in custom theme | _boolean_ | `false` | | show-delete-key `v2.5.9` | Whether to show delete button | _boolean_ | `true` | -| hide-on-click-outside | Whether to hide keyboard when click outside | _boolean_ | `true` | +| hide-on-click-outside | Whether to hide keyboard when outside is clicked | _boolean_ | `true` | | get-container `v2.10.0` | Return the mount node for NumberKeyboard | _string \| () => Element_ | - | | safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` | @@ -167,12 +167,12 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| input | Triggered when keydown | key: Content of the key | -| delete | Triggered when press delete key | - | -| close | Triggered when click close button | - | -| blur | Triggered when click close button or blur keyboard | - | -| show | Triggered when keyboard is fully displayed | - | -| hide | Triggered when keyboard is fully hidden | - | +| input | Emitted when keydown | key: Content of the key | +| delete | Emitted when the delete key is pressed | - | +| close | Emitted when the close button is clicked | - | +| blur | Emitted when the close button is clicked or the keyboard is blured | - | +| show | Emitted when keyboard is fully displayed | - | +| hide | Emitted when keyboard is fully hidden | - | ### Slots diff --git a/src/overlay/README.md b/src/overlay/README.md index dafca6221..62dae5185 100644 --- a/src/overlay/README.md +++ b/src/overlay/README.md @@ -68,9 +68,9 @@ export default { ### Events -| Event | Description | Arguments | -| ----- | ---------------------- | -------------- | -| click | Triggered when clicked | _event: Event_ | +| Event | Description | Arguments | +| ----- | --------------------------------- | -------------- | +| click | Emitted when component is clicked | _event: Event_ | ### Slots diff --git a/src/pagination/README.md b/src/pagination/README.md index c82cd7d04..c15e2b3d7 100644 --- a/src/pagination/README.md +++ b/src/pagination/README.md @@ -76,9 +76,9 @@ export default { ### Events -| Event | Description | Arguments | -| ------ | ------------------------ | --------- | -| change | Triggered on page change | - | +| Event | Description | Arguments | +| ------ | --------------------------------- | --------- | +| change | Emitted when current page changed | - | ### Slots diff --git a/src/password-input/README.md b/src/password-input/README.md index dc469b83a..1b86e7c50 100644 --- a/src/password-input/README.md +++ b/src/password-input/README.md @@ -131,6 +131,6 @@ export default { ### Events -| Event | Description | Arguments | -| ----- | -------------------------------- | --------- | -| focus | Triggered when input get focused | - | +| Event | Description | Arguments | +| ----- | ----------------------------- | --------- | +| focus | Emitted when input is focused | - | diff --git a/src/picker/PickerColumn.js b/src/picker/PickerColumn.js index 5e36c1a8b..8534f5d31 100644 --- a/src/picker/PickerColumn.js +++ b/src/picker/PickerColumn.js @@ -166,7 +166,7 @@ export default createComponent({ this.setIndex(index, true); // compatible with desktop scenario - // use setTimeout to skip the click event triggered after touchstart + // use setTimeout to skip the click event Emitted after touchstart setTimeout(() => { this.moving = false; }, 0); diff --git a/src/picker/README.md b/src/picker/README.md index 6976f409b..b2dea43ad 100644 --- a/src/picker/README.md +++ b/src/picker/README.md @@ -263,9 +263,9 @@ Picker events will pass different parameters according to the columns are single | Event | Description | Arguments | | --- | --- | --- | -| confirm | Triggered when click confirm button | Single column：current value，current index
Multiple columns：current values，current indexes | -| cancel | Triggered when click cancel button | Single column：current value，current index
Multiple columns：current values，current indexes | -| change | Triggered when current option changed | Single column：Picker instance, current value，current index
Multiple columns：Picker instance, current values，column index | +| confirm | Emitted when click confirm button | Single column：current value，current index
Multiple columns：current values，current indexes | +| cancel | Emitted when click cancel button | Single column：current value，current index
Multiple columns：current values，current indexes | +| change | Emitted when current option changed | Single column：Picker instance, current value，current index
Multiple columns：Picker instance, current values，column index | ### Slots diff --git a/src/popover/README.md b/src/popover/README.md index 4d9499ece..3203ae89f 100644 --- a/src/popover/README.md +++ b/src/popover/README.md @@ -179,13 +179,13 @@ export default { ### Events -| Event | Description | Arguments | -| ------ | -------------------------------- | ------------------------------- | -| select | Triggered when clicking action | _action: Action, index: number_ | -| open | Triggered when opening Popover | - | -| close | Triggered when closing Popover | - | -| opened | Triggered when Popover is opened | - | -| closed | Triggered when Popover is closed | - | +| Event | Description | Arguments | +| ------ | --------------------------------- | ------------------------------- | +| select | Emitted when an action is clicked | _action: Action, index: number_ | +| open | Emitted when opening Popover | - | +| close | Emitted when closing Popover | - | +| opened | Emitted when Popover is opened | - | +| closed | Emitted when Popover is closed | - | ### Slots diff --git a/src/popup/README.md b/src/popup/README.md index 0d6baadb2..ce481f84b 100644 --- a/src/popup/README.md +++ b/src/popup/README.md @@ -118,7 +118,7 @@ export default { | lock-scroll | Whether to lock background scroll | _boolean_ | `true` | | lazy-render | Whether to lazy render util appeared | _boolean_ | `true` | | close-on-popstate | Whether to close when popstate | _boolean_ | `false` | -| close-on-click-overlay | Whether to close when click overlay | _boolean_ | `true` | +| close-on-click-overlay | Whether to close when overlay is clicked | _boolean_ | `true` | | closeable | Whether to show close icon | _boolean_ | `false` | | close-icon | Close icon name | _string_ | `cross` | | close-icon-position | Close Icon Position，can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` | @@ -129,11 +129,11 @@ export default { ### Events -| Event | Description | Arguments | -| ------------- | ---------------------------- | -------------- | -| click | Triggered when click Popup | _event: Event_ | -| open | Triggered when open Popup | - | -| close | Triggered when close Popup | - | -| opened | Triggered when opened Popup | - | -| closed | Triggered when closed Popup | - | -| click-overlay | Triggered when click overlay | - | +| Event | Description | Arguments | +| ------------- | ------------------------------- | -------------- | +| click | Emitted when Popup is clicked | _event: Event_ | +| open | Emitted when opening Popup | - | +| close | Emitted when closing Popup | - | +| opened | Emitted when Popup is opened | - | +| closed | Emitted when Popup is closed | - | +| click-overlay | Emitted when overlay is clicked | - | diff --git a/src/pull-refresh/README.md b/src/pull-refresh/README.md index f36c9ebb8..cb9355f5e 100644 --- a/src/pull-refresh/README.md +++ b/src/pull-refresh/README.md @@ -13,7 +13,7 @@ Vue.use(PullRefresh); ### Basic Usage -The `refresh` event will be triggered when pull refresh, you should set `v-model` to `false` to reset loading status after process refresh event. +The `refresh` event will be Emitted when pull refresh, you should set `v-model` to `false` to reset loading status after process refresh event. ```html @@ -109,9 +109,9 @@ Use slots to custom tips. ### Events -| Event | Description | Parameters | -| ------- | --------------------------- | ---------- | -| refresh | Triggered when pull refresh | - | +| Event | Description | Parameters | +| ------- | ----------------------------- | ---------- | +| refresh | Emitted after pulling refresh | - | ### Slots diff --git a/src/radio/README.md b/src/radio/README.md index 7baffe57c..91e51c7ca 100644 --- a/src/radio/README.md +++ b/src/radio/README.md @@ -171,15 +171,15 @@ export default { ### Radio Events -| Event | Description | Parameters | -| ----- | -------------------------- | -------------- | -| click | Triggered when click radio | _event: Event_ | +| Event | Description | Parameters | +| ----- | ----------------------------- | -------------- | +| click | Emitted when radio is clicked | _event: Event_ | ### RadioGroup Events -| Event | Description | Parameters | -| ------ | ---------------------------- | -------------- | -| change | Triggered when value changed | _name: string_ | +| Event | Description | Parameters | +| ------ | -------------------------- | -------------- | +| change | Emitted when value changed | _name: string_ | ### Radio Slots diff --git a/src/rate/README.md b/src/rate/README.md index a87c5fbf8..3549658ff 100644 --- a/src/rate/README.md +++ b/src/rate/README.md @@ -118,6 +118,6 @@ export default { ### Events -| Event | Description | Parameters | -| ------ | --------------------------- | ------------ | -| change | Triggered when rate changed | current rate | +| Event | Description | Parameters | +| ------ | ------------------------- | ------------ | +| change | Emitted when rate changed | current rate | diff --git a/src/search/README.md b/src/search/README.md index 1d838e758..8c92d43e9 100644 --- a/src/search/README.md +++ b/src/search/README.md @@ -29,7 +29,7 @@ export default { ### Listen to Events -`search` event will be triggered when click the search button on the keyboard, `cancel` event will be triggered when click the cancel button. +`search` event will be Emitted when click the search button on the keyboard, `cancel` event will be Emitted when click the cancel button. ```html
@@ -90,7 +90,7 @@ export default { ### Custom Action Button -Use `action` slot to custom right button, `cancel` event will no longer be triggered when use this slot. +Use `action` slot to custom right button, `cancel` event will no longer be Emitted when use this slot. ```html Element_ | - | @@ -136,9 +136,9 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| select | Triggered when click option | _option: Option, index: number_ | -| cancel | Triggered when click cancel button | - | -| click-overlay `v2.9.1` | Triggered when click overlay | - | +| select | Emitted when an option is clicked | _option: Option, index: number_ | +| cancel | Emitted when the cancel button is clicked | - | +| click-overlay `v2.9.1` | Emitted when overlay is clicked | - | ### Slots diff --git a/src/sidebar/README.md b/src/sidebar/README.md index 72427ed27..6b283d080 100644 --- a/src/sidebar/README.md +++ b/src/sidebar/README.md @@ -89,9 +89,9 @@ export default { ### Sidebar Events -| Event | Description | Arguments | -| ------ | --------------------------- | ---------------------------- | -| change | Triggered when item changed | index: index of current item | +| Event | Description | Arguments | +| ------ | -------------------------------- | ---------------------------- | +| change | Emitted when chosen item changed | index: index of current item | ### SidebarItem Props @@ -107,9 +107,9 @@ export default { ### SidebarItem Events -| Event | Description | Arguments | -| ----- | ------------------------- | ---------------------------- | -| click | Triggered when click item | index: index of current item | +| Event | Description | Arguments | +| ----- | ------------------------------- | ---------------------------- | +| click | Emitted when an item is clicked | index: index of current item | ### SidebarItem Slots diff --git a/src/sku/README.md b/src/sku/README.md index 179e99240..f833e65f6 100644 --- a/src/sku/README.md +++ b/src/sku/README.md @@ -130,7 +130,7 @@ export default { | reset-stepper-on-hide | Whether to reset stepper when hide | _boolean_ | `false` | | reset-selected-sku-on-hide | Whether to reset selected sku when hide | _boolean_ | `false` | | disable-stepper-input | Whether to disable stepper input | _boolean_ | `false` | -| close-on-click-overlay | Whether to close sku popup when click overlay | _boolean_ | `true` | +| close-on-click-overlay | Whether to close sku popup when overlay is clicked | _boolean_ | `true` | | stepper-title | Quantity title | _string_ | `Quantity` | | custom-stepper-config | Custom stepper related config | _object_ | `{}` | | message-config | Message related config | _object_ | `{}` | @@ -146,14 +146,14 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| add-cart | Triggered when click cart button | data: object | -| buy-clicked | Triggered when click buy button | data: object | -| stepper-change | Triggered when stepper value changed | value: number | -| sku-selected | Triggered when select sku | { skuValue, selectedSku, selectedSkuComb } | -| sku-prop-selected | Triggered when select property | { propValue, selectedProp, selectedSkuComb } | -| open-preview | Triggered when open image preview | data: object | -| close-preview | Triggered when close image preview | data: object | -| sku-reset `v2.8.1` | Triggered when reset sku and property | { selectedSku, selectedProp, selectedSkuComb } | +| add-cart | Emitted when click cart button | data: object | +| buy-clicked | Emitted when click buy button | data: object | +| stepper-change | Emitted when stepper value changed | value: number | +| sku-selected | Emitted when select sku | { skuValue, selectedSku, selectedSkuComb } | +| sku-prop-selected | Emitted when select property | { propValue, selectedProp, selectedSkuComb } | +| open-preview | Emitted when open image preview | data: object | +| close-preview | Emitted when close image preview | data: object | +| sku-reset `v2.8.1` | Emitted when reset sku and property | { selectedSku, selectedProp, selectedSkuComb } | ### Methods diff --git a/src/slider/README.md b/src/slider/README.md index 5ec705a41..d88d0cf3a 100644 --- a/src/slider/README.md +++ b/src/slider/README.md @@ -159,12 +159,12 @@ export default { ### Events -| Event | Description | Arguments | -| ---------- | ------------------------------------ | ------------------- | -| input | Instant triggered when value changed | value: current rate | -| change | Triggered after value changed | value: current rate | -| drag-start | Triggered when start drag | - | -| drag-end | Triggered when end drag | - | +| Event | Description | Arguments | +| ---------- | ------------------------------ | ------------------- | +| input | Emitted when value is changing | value: current rate | +| change | Emitted after value changed | value: current rate | +| drag-start | Emitted when start draging | - | +| drag-end | Emitted when end draging | - | ### Slots diff --git a/src/stepper/README.md b/src/stepper/README.md index 06b6700f9..f806adaad 100644 --- a/src/stepper/README.md +++ b/src/stepper/README.md @@ -135,9 +135,9 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| change | Triggered when value change | _value: string, detail: { name: string }_ | -| overlimit | Triggered when click disabled button | - | -| plus | Triggered when click plus button | - | -| minus | Triggered when click minus button | - | -| focus | Triggered when input focused | _event: Event_ | -| blur | Triggered when input blured | _event: Event_ | +| change | Emitted when value changed | _value: string, detail: { name: string }_ | +| overlimit | Emitted when a disabled button is clicked | - | +| plus | Emitted when the plus button is clicked | - | +| minus | Emitted when the minus button is clicked | - | +| focus | Emitted when the input is focused | _event: Event_ | +| blur | Emitted when the input is blured | _event: Event_ | diff --git a/src/steps/README.md b/src/steps/README.md index a82b38f2f..7bed96a39 100644 --- a/src/steps/README.md +++ b/src/steps/README.md @@ -87,4 +87,4 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| click-step `v2.5.9` | Triggered when a step's title or icon is clicked | _index: number_ | +| click-step `v2.5.9` | Emitted when a step's title or icon is clicked | _index: number_ | diff --git a/src/sticky/README.md b/src/sticky/README.md index 4691e0abb..8d73f2d24 100644 --- a/src/sticky/README.md +++ b/src/sticky/README.md @@ -62,6 +62,6 @@ export default { ### Events -| Event | Description | Arguments | -| ------ | --------------------- | ------------------------------ | -| scroll | Triggered when scroll | object: { scrollTop, isFixed } | +| Event | Description | Arguments | +| ------ | ---------------------- | ------------------------------ | +| scroll | Emitted when scrolling | object: { scrollTop, isFixed } | diff --git a/src/swipe-cell/README.md b/src/swipe-cell/README.md index 16762f6e3..1e14cb08f 100644 --- a/src/swipe-cell/README.md +++ b/src/swipe-cell/README.md @@ -117,9 +117,9 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| click | Triggered when clicked | Click positon (`left` `right` `cell` `outside`) | -| open | Triggered when opened | { position: 'left' \| 'right' , name: string } | -| close | Triggered when closed | { position: string , name: string } | +| click | Emitted when SwipeCell is clicked | Click positon (`left` `right` `cell` `outside`) | +| open | Emitted when SwipeCell is opened | { position: 'left' \| 'right' , name: string } | +| close | Emitted when SwipeCell is closed | { position: string , name: string } | ### beforeClose Params diff --git a/src/swipe/README.md b/src/swipe/README.md index 91cfae89e..fc16bdde7 100644 --- a/src/swipe/README.md +++ b/src/swipe/README.md @@ -175,15 +175,15 @@ export default { ### Swipe Events -| Event | Description | Arguments | -| ------ | ----------------------------------- | ----------------------------- | -| change | Triggered when current swipe change | index: index of current swipe | +| Event | Description | Arguments | +| ------ | ---------------------------------- | ----------------------------- | +| change | Emitted when current swipe changed | index: index of current swipe | ### SwipeItem Events -| Event | Description | Arguments | -| ----- | ---------------------- | -------------- | -| click | Triggered when clicked | _event: Event_ | +| Event | Description | Arguments | +| ----- | --------------------------------- | -------------- | +| click | Emitted when component is clicked | _event: Event_ | ### Swipe Methods diff --git a/src/switch-cell/README.md b/src/switch-cell/README.md index fb51c9935..018bebb63 100644 --- a/src/switch-cell/README.md +++ b/src/switch-cell/README.md @@ -75,4 +75,4 @@ Use `loading` property to keep component in loading state. | Event | Description | Arguments | | --- | --- | --- | -| change | triggered when the on-off state is changed | checked: switch is on or not | +| change | Emitted when the on-off state is changed | checked: switch is on or not | diff --git a/src/switch/README.md b/src/switch/README.md index 7f0351b24..1cd2c14e1 100644 --- a/src/switch/README.md +++ b/src/switch/README.md @@ -104,7 +104,7 @@ export default { ### Events -| Event | Description | Parameters | -| ------ | ----------------------------------- | -------------- | -| change | Triggered when check status changed | _value: any_ | -| click | Triggered when clicked | _event: Event_ | +| Event | Description | Parameters | +| ------ | --------------------------------- | -------------- | +| change | Emitted when check status changed | _value: any_ | +| click | Emitted when component is clicked | _event: Event_ | diff --git a/src/tab/README.md b/src/tab/README.md index bcd38d88a..1fb5b7591 100644 --- a/src/tab/README.md +++ b/src/tab/README.md @@ -257,11 +257,11 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| click | Triggered when click tab | name，title | -| change | Triggered when active tab changed | name，title | -| disabled | Triggered when click disabled tab | name，title | -| rendered `v2.3.0` | Triggered when content first rendered in lazy-render mode | name，title | -| scroll | Triggered when tab scroll in sticky mode | object: { scrollTop, isFixed } | +| click | Emitted when a tab is clicked | name，title | +| change | Emitted when active tab changed | name，title | +| disabled | Emitted when a disabled tab is clicked | name，title | +| rendered `v2.3.0` | Emitted when content first rendered in lazy-render mode | name，title | +| scroll | Emitted when tab scrolling in sticky mode | object: { scrollTop, isFixed } | ### Tabs Methods diff --git a/src/tabbar/README.md b/src/tabbar/README.md index 48af8bb8e..456e2cad0 100644 --- a/src/tabbar/README.md +++ b/src/tabbar/README.md @@ -166,7 +166,7 @@ export default { | Event | Description | Arguments | | ------ | -------------------------------- | ---------------------------- | -| change | Triggered when change active tab | active: index of current tab | +| change | Emitted when changing active tab | active: index of current tab | ### TabbarItem Props diff --git a/src/tag/README.md b/src/tag/README.md index 70e04a2df..218414f0e 100644 --- a/src/tag/README.md +++ b/src/tag/README.md @@ -100,7 +100,7 @@ export default { ### Events -| Event | Description | Arguments | -| ----- | ------------------------------- | -------------- | -| click | Triggered when clicked | _event: Event_ | -| close | Triggered when click close icon | - | +| Event | Description | Arguments | +| ----- | ---------------------------------- | -------------- | +| click | Emitted when component is clicked | _event: Event_ | +| close | Emitted when close icon is clicked | - | diff --git a/src/toast/README.md b/src/toast/README.md index ae5d0a2bb..a3184da13 100644 --- a/src/toast/README.md +++ b/src/toast/README.md @@ -160,7 +160,7 @@ Toast.resetDefaultOptions('loading'); | overlay | Whether to show overlay | _boolean_ | `false` | | forbidClick | Whether to forbid click background | _boolean_ | `false` | | closeOnClick | Whether to close after clicked | _boolean_ | `false` | -| closeOnClickOverlay | Whether to close when click overlay | _boolean_ | `false` | +| closeOnClickOverlay | Whether to close when overlay is clicked | _boolean_ | `false` | | loadingType | Loading icon type, can be set to `spinner` | _string_ | `circular` | | duration | Toast duration(ms), won't disappear if value is 0 | _number_ | `2000` | | className | Custom className | _any_ | - | diff --git a/src/tree-select/README.md b/src/tree-select/README.md index 81d662a45..302759846 100644 --- a/src/tree-select/README.md +++ b/src/tree-select/README.md @@ -124,8 +124,8 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| click-nav | triggered when parent node is selected | index: index of selected parent | -| click-item | triggered when item is selected | data: selected item | +| click-nav | Emitted when parent node is selected | index: index of selected parent | +| click-item | Emitted when item is selected | data: selected item | ### Slots diff --git a/src/uploader/README.md b/src/uploader/README.md index d7531e2a2..55baef846 100644 --- a/src/uploader/README.md +++ b/src/uploader/README.md @@ -202,7 +202,7 @@ Use `disabled` prop to disable uploader. | name | Input name | _number \| string_ | - | | preview-size | Size of preview image | _number \| string_ | `80px` | | preview-image | Whether to show image preview | _boolean_ | `true` | -| preview-full-image | Whethe to show full screen image preview when click image | _boolean_ | `true` | +| preview-full-image | Whethe to show full screen image preview when image is clicked | _boolean_ | `true` | | preview-options `v2.9.3` | Options of full screen image preview，see [ImagePreview](#/en-US/image-preview) | _object_ | - | | multiple | Whether to enable multiple selection pictures | _boolean_ | `false` | | disabled | Whether to disabled the upload | _boolean_ | `false` | @@ -224,10 +224,10 @@ Use `disabled` prop to disable uploader. | Event | Description | Arguments | | --- | --- | --- | -| oversize | Triggered when file size over limit | Same as after-read | -| click-preview | Triggered when click preview image | Same as after-read | -| close-preview | Triggered when close full screen image preview | - | -| delete | Triggered when delete preview file | Same as after-read | +| oversize | Emitted when file size over limit | Same as after-read | +| click-preview | Emitted when preview image is clicked | Same as after-read | +| close-preview | Emitted when the full screen image preview is closed | - | +| delete | Emitted when preview file is deleted | Same as after-read | ### Slots From 5298e597a612e32f85133bae2bec4c278650db0a Mon Sep 17 00:00:00 2001 From: neverland Date: Fri, 20 Nov 2020 20:43:54 +0800 Subject: [PATCH 2/3] docs(ImagePreview): fix swipeTo method (#7595) --- src/image-preview/README.md | 7 +++++++ src/image-preview/README.zh-CN.md | 9 ++++++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/src/image-preview/README.md b/src/image-preview/README.md index 13af99942..8f344c75b 100644 --- a/src/image-preview/README.md +++ b/src/image-preview/README.md @@ -159,6 +159,13 @@ export default { | closed `v2.5.6` | Emitted when ImagePreview is closed | - | | change | Emitted when current image changed | index: index of current image | | scale `v2.5.0` | Emitted when scaling current image | { index: index of current image, scale: scale of current image} | + +### Methods + +Use [ref](https://vuejs.org/v2/api/#ref) to get ImagePreview instance and call instance methods. + +| Name | Description | Attribute | Return value | +| --- | --- | --- | --- | | swipeTo `2.9.0` | Swipe to target index | index: target index, options: Options | - | ### Slots diff --git a/src/image-preview/README.zh-CN.md b/src/image-preview/README.zh-CN.md index 93b6634a1..161fc41a1 100644 --- a/src/image-preview/README.zh-CN.md +++ b/src/image-preview/README.zh-CN.md @@ -199,7 +199,14 @@ export default { | closed `v2.5.6` | 关闭且且动画结束后触发 | - | | change | 切换当前图片时触发 | index: 当前图片的索引 | | scale `v2.5.0` | 缩放当前图片时触发 | { index: 当前图片的索引, scale: 当前缩放的值 } | -| swipeTo `2.9.0` | 切换到指定位置 | index: number, options: Options | - | + +### 方法 + +通过组件调用 `ImagePreview` 时，通过 ref 可以获取到 ImagePreview 实例并调用实例方法，详见[组件实例方法](#/zh-CN/advanced-usage#zu-jian-shi-li-fang-fa)。 + +| 方法名 | 说明 | 参数 | 返回值 | +| --------------- | -------------- | ------------------------------- | ------ | +| swipeTo `2.9.0` | 切换到指定位置 | index: number, options: Options | - | ### Slots From 5605b0aa575202292fde3325545c2e89a132c8fc Mon Sep 17 00:00:00 2001 From: chenjiahan Date: Fri, 20 Nov 2020 21:29:38 +0800 Subject: [PATCH 3/3] chore(Popover): remove import mixin --- src/popover/index.less | 1 - 1 file changed, 1 deletion(-) diff --git a/src/popover/index.less b/src/popover/index.less index a97e0ec6a..c718d41a6 100644 --- a/src/popover/index.less +++ b/src/popover/index.less @@ -1,5 +1,4 @@ @import '../style/var'; -@import '../style/mixins/hairline'; .van-popover { position: absolute;