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

docs: type highlight (#4264)

Browse Source
This commit is contained in:
neverland
2019-08-27 22:09:21 +08:00
committed by GitHub
parent a79750d00c
commit ecbdc2bede
129 changed files with 1493 additions and 1484 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/coupon-list/README.md
+31 -31
View File
@@ -73,32 +73,32 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| title | Cell title | `string` | `Coupon` | - |
| chosen-coupon | Index of chosen coupon | `number` | `-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* | `-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 | Version |
|------|------|------|------|------|
| 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` | - |
| 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` | - |
### CouponList Events
@@ -111,13 +111,13 @@ export default {
| 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` |
| 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* |
src/coupon-list/README.zh-CN.md
+33 -33
View File
@@ -73,34 +73,34 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| title | 单元格标题 | `string` | `优惠券` | - |
| chosen-coupon | 当前选中优惠券的索引 | `number` | `-1` | - |
| coupons | 可用优惠券列表 | `Coupon[]` | `[]` | - |
| editable | 能否切换优惠券 | `boolean` | `true` | - |
| border | 是否显示内边框 | `boolean` | `true` | - |
| currency | 货币符号 | `string` | `¥` | - | - |
| title | 单元格标题 | *string* | `优惠券` | - |
| chosen-coupon | 当前选中优惠券的索引 | *number* | `-1` | - |
| coupons | 可用优惠券列表 | *Coupon[]* | `[]` | - |
| editable | 能否切换优惠券 | *boolean* | `true` | - |
| border | 是否显示内边框 | *boolean* | `true` | - |
| currency | 货币符号 | *string* | `¥` | - | - |
### CouponList Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 当前输入的兑换码 | `string` | - | - |
| chosen-coupon | 当前选中优惠券的索引 | `number` | `-1` | - |
| coupons | 可用优惠券列表 | `Coupon[]` | `[]` | - |
| disabled-coupons | 不可用优惠券列表 | `Coupon[]` | `[]` | - |
| enabled-title | 可用优惠券列表标题 | `string` | `可使用优惠券` | - |
| disabled-title | 不可用优惠券列表标题 | `string` | `不可使用优惠券` | - |
| exchange-button-text | 兑换按钮文字 | `string` | `兑换` | - |
| exchange-button-loading | 是否显示兑换按钮加载动画 | `boolean` | `false` | - |
| exchange-button-disabled | 是否禁用兑换按钮 | `boolean` | `false` | - |
| exchange-min-length | 兑换码最小长度 | `number` | `1` | - |
| displayed-coupon-index | 滚动至特定优惠券位置 | `number` | - | - |
| show-close-button | 是否显示列表底部按钮 | `boolean` | `true` | - |
| close-button-text | 列表底部按钮文字 | `string` | `不使用优惠` | - |
| input-placeholder | 输入框文字提示 | `string` | `请输入优惠码` | - |
| show-exchange-bar | 是否展示兑换栏 | `boolean` | `true` | - |
| currency | 货币符号 | `string` | `¥` | - |
| empty-image | 列表为空时的占位图 | `string` | `https://img.yzcdn.cn/vant/coupon-empty.png` | 2.1.0 |
| v-model | 当前输入的兑换码 | *string* | - | - |
| chosen-coupon | 当前选中优惠券的索引 | *number* | `-1` | - |
| coupons | 可用优惠券列表 | *Coupon[]* | `[]` | - |
| disabled-coupons | 不可用优惠券列表 | *Coupon[]* | `[]` | - |
| enabled-title | 可用优惠券列表标题 | *string* | `可使用优惠券` | - |
| disabled-title | 不可用优惠券列表标题 | *string* | `不可使用优惠券` | - |
| exchange-button-text | 兑换按钮文字 | *string* | `兑换` | - |
| exchange-button-loading | 是否显示兑换按钮加载动画 | *boolean* | `false` | - |
| exchange-button-disabled | 是否禁用兑换按钮 | *boolean* | `false` | - |
| exchange-min-length | 兑换码最小长度 | *number* | `1` | - |
| displayed-coupon-index | 滚动至特定优惠券位置 | *number* | - | - |
| show-close-button | 是否显示列表底部按钮 | *boolean* | `true` | - |
| close-button-text | 列表底部按钮文字 | *string* | `不使用优惠` | - |
| input-placeholder | 输入框文字提示 | *string* | `请输入优惠码` | - |
| show-exchange-bar | 是否展示兑换栏 | *boolean* | `true` | - |
| currency | 货币符号 | *string* | `¥` | - |
| empty-image | 列表为空时的占位图 | *string* | `https://img.yzcdn.cn/vant/coupon-empty.png` | 2.1.0 |
### CouponList Events
@@ -113,13 +113,13 @@ export default {
| 键名 | 说明 | 类型 |
|------|------|------|
| id | 优惠券 id | `string` |
| name | 优惠券名称 | `string` |
| condition | 满减条件 | `string` |
| startAt | 卡有效开始时间 (时间戳, 单位秒) | `number` |
| endAt | 卡失效日期 (时间戳, 单位秒) | `number` |
| description | 描述信息，优惠券可用时展示 | `string` |
| reason | 不可用原因，优惠券不可用时展示 | `string` |
| value | 折扣券优惠金额，单位分 | `number` |
| valueDesc | 折扣券优惠金额文案 | `string` |
| unitDesc | 单位文案 | `string` |
| id | 优惠券 id | *string* |
| name | 优惠券名称 | *string* |
| condition | 满减条件 | *string* |
| startAt | 卡有效开始时间 (时间戳, 单位秒) | *number* |
| endAt | 卡失效日期 (时间戳, 单位秒) | *number* |
| description | 描述信息，优惠券可用时展示 | *string* |
| reason | 不可用原因，优惠券不可用时展示 | *string* |
| value | 折扣券优惠金额，单位分 | *number* |
| valueDesc | 折扣券优惠金额文案 | *string* |
| unitDesc | 单位文案 | *string* |