alighasami/vant
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: prettier all markdown files

Browse Source
This commit is contained in:
chenjiahan
2020-04-11 09:17:33 +08:00
committed by neverland
parent 48067f79db
commit 7f84f8a487
140 changed files with 4441 additions and 4723 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/coupon-list/README.md
+43 -43
View File
@@ -48,7 +48,7 @@ const coupon = {
startAt: 1489104000,
endAt: 1514592000,
valueDesc: '1.5',
unitDesc: '元'
unitDesc: '元',
};
export default {
@@ -56,8 +56,8 @@ export default {
return {
chosenCoupon: -1,
coupons: [coupon],
disabledCoupons: [coupon]
}
disabledCoupons: [coupon],
};
},
methods: {
onChange(index) {
@@ -66,9 +66,9 @@ export default {
},
onExchange(code) {
this.coupons.push(coupon);
}
}
}
},
},
};
```
## API
@@ -76,53 +76,53 @@ export default {
### CouponCell Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| title | Cell title | *string* | `Coupon` |
| chosen-coupon | Index of chosen coupon | *number \| string* | `-1` |
| coupons | Coupon list | *Coupon[]* | `[]` |
| editable | Cell editable | *boolean* | `true` |
| border | Whether to show innner border | *boolean* | `true` |
| currency | Currency symbol | *string* | `¥` |
| --- | --- | --- | --- |
| title | Cell title | _string_ | `Coupon` |
| chosen-coupon | Index of chosen coupon | _number \| string_ | `-1` |
| coupons | Coupon list | _Coupon[]_ | `[]` |
| editable | Cell editable | _boolean_ | `true` |
| border | Whether to show innner border | _boolean_ | `true` |
| currency | Currency symbol | _string_ | `¥` |
### CouponList Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current exchange code | *string* | - |
| chosen-coupon | Index of chosen coupon | *number* | `-1` |
| coupons | Coupon list | *Coupon[]* | `[]` |
| disabled-coupons | Disabled coupon list | *Coupon[]* | `[]` |
| enabled-title | Title of coupon list | *string* | `Available` | - |
| disabled-title | Title of disabled coupon list | *string* | `Unavailable` | - |
| exchange-button-text | Exchange button text | *string* | `Exchange` |
| exchange-button-loading | Whether to show loading in exchange button | *boolean* | `false` |
| exchange-button-disabled | Whether to disable exchange button | *boolean* | `false` |
| exchange-min-length | Min length to enable exchange button | *number* | `1` |
| displayed-coupon-index | Index of displayed coupon | *number* | - |
| close-button-text | Close button text | *string* | `Close` |
| input-placeholder | Input placeholder | *string* | `Coupon code` |
| currency | Currency symbol | *string* | `¥` |
| empty-image | Placeholder image when list is empty | *string* | `https://img.yzcdn.cn/vant/coupon-empty.png` |
| show-count `v2.3.0` | Whether to show coupon count in tab title | *boolean* | `true` |
| --- | --- | --- | --- |
| v-model | Current exchange code | _string_ | - |
| chosen-coupon | Index of chosen coupon | _number_ | `-1` |
| coupons | Coupon list | _Coupon[]_ | `[]` |
| disabled-coupons | Disabled coupon list | _Coupon[]_ | `[]` |
| enabled-title | Title of coupon list | _string_ | `Available` | - |
| disabled-title | Title of disabled coupon list | _string_ | `Unavailable` | - |
| exchange-button-text | Exchange button text | _string_ | `Exchange` |
| exchange-button-loading | Whether to show loading in exchange button | _boolean_ | `false` |
| exchange-button-disabled | Whether to disable exchange button | _boolean_ | `false` |
| exchange-min-length | Min length to enable exchange button | _number_ | `1` |
| displayed-coupon-index | Index of displayed coupon | _number_ | - |
| close-button-text | Close button text | _string_ | `Close` |
| input-placeholder | Input placeholder | _string_ | `Coupon code` |
| currency | Currency symbol | _string_ | `¥` |
| empty-image | Placeholder image when list is empty | _string_ | `https://img.yzcdn.cn/vant/coupon-empty.png` |
| show-count `v2.3.0` | Whether to show coupon count in tab title | _boolean_ | `true` |
### CouponList Events
| Event | Description | Arguments |
|------|------|------|
| --- | --- | --- |
| change | Triggered when change chosen coupon | index: index of chosen coupon |
| exchange | Triggered when exchange coupon | code: exchange code |
### Data Structure of Coupon
| Key | Description | Type |
|------|------|------|
| id | Id | *string* |
| name | Name | *string* |
| condition | Condition | *string* |
| startAt | Start time (Timestmap, unit second) | *number* |
| endAt | End time (Timestmap, unit second) | *number* |
| description | Description | *string* |
| reason | Unavailable reason | *string* |
| value | Value | *number* |
| valueDesc | Value Text | *string* |
| unitDesc | Unit Text | *string* |
| Key | Description | Type |
| ----------- | ----------------------------------- | -------- |
| id | Id | _string_ |
| name | Name | _string_ |
| condition | Condition | _string_ |
| startAt | Start time (Timestmap, unit second) | _number_ |
| endAt | End time (Timestmap, unit second) | _number_ |
| description | Description | _string_ |
| reason | Unavailable reason | _string_ |
| value | Value | _number_ |
| valueDesc | Value Text | _string_ |
| unitDesc | Unit Text | _string_ |