ui/vant
1
0
Fork 0
mirror of https://github.com/youzan/vant.git synced 2026-05-19 01:02:35 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

docs: prettier all markdown files

Browse Source
This commit is contained in:
chenjiahan
2020-04-11 09:09:00 +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/address-list/README.md
+31 -31
View File
@@ -37,24 +37,24 @@ export default {
id: '1',
name: 'John Snow',
tel: '13000000000',
address: 'Somewhere'
address: 'Somewhere',
},
{
id: '2',
name: 'Ned Stark',
tel: '1310000000',
address: 'Somewhere'
}
address: 'Somewhere',
},
],
disabledList: [
{
id: '3',
name: 'Tywin',
tel: '1320000000',
address: 'Somewhere'
}
]
}
address: 'Somewhere',
},
],
};
},
methods: {
onAdd() {
@@ -62,9 +62,9 @@ export default {
},
onEdit(item, index) {
Toast('Edit:' + index);
}
}
}
},
},
};
```
## API
@@ -72,19 +72,19 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Id of chosen address | *string* | - |
| list | Address list | *Address[]* | `[]` |
| disabled-list | Disabled address list | *Address[]* | `[]` |
| disabled-text | Disabled text | *string* | - |
| switchable | Whether to allow switch address | *boolean* | `true` |
| add-button-text | Add button text | *string* | `Add new address` |
| default-tag-text `v2.3.0` | Default tag text | *string* | - |
| --- | --- | --- | --- |
| v-model | Id of chosen address | _string_ | - |
| list | Address list | _Address[]_ | `[]` |
| disabled-list | Disabled address list | _Address[]_ | `[]` |
| disabled-text | Disabled text | _string_ | - |
| switchable | Whether to allow switch address | _boolean_ | `true` |
| add-button-text | Add button text | _string_ | `Add new address` |
| default-tag-text `v2.3.0` | Default tag text | _string_ | - |
### Events
| 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 |
@@ -94,18 +94,18 @@ export default {
### Data Structure of Address
| Key | Description | Type |
|------|------|------|
| id | Id | *number \| string* |
| name | Name | *string* |
| tel | Phone | *number \| string* |
| address | Address | *string* |
| isDefault | Is default address | *boolean* |
| Key | Description | Type |
| --------- | ------------------ | ------------------ |
| id | Id | _number \| string_ |
| name | Name | _string_ |
| tel | Phone | _number \| string_ |
| address | Address | _string_ |
| isDefault | Is default address | _boolean_ |
### Slots
| Name | Description | SlotProps |
|------|------|------|
| default | Custom content after list | - |
| top | Custom content before list | - |
| item-bottom `v2.5.0` | Custom content after list item | item |
| Name | Description | SlotProps |
| -------------------- | ------------------------------ | --------- |
| default | Custom content after list | - |
| top | Custom content before list | - |
| item-bottom `v2.5.0` | Custom content after list item | item |
src/address-list/README.zh-CN.md
+37 -37
View File
@@ -37,24 +37,24 @@ export default {
id: '1',
name: '张三',
tel: '13000000000',
address: '浙江省杭州市西湖区文三路 138 号东方通信大厦 7 楼 501 室'
address: '浙江省杭州市西湖区文三路 138 号东方通信大厦 7 楼 501 室',
},
{
id: '2',
name: '李四',
tel: '1310000000',
address: '浙江省杭州市拱墅区莫干山路 50 号'
}
address: '浙江省杭州市拱墅区莫干山路 50 号',
},
],
disabledList: [
{
id: '3',
name: '王五',
tel: '1320000000',
address: '浙江省杭州市滨江区江南大道 15 号'
}
]
}
address: '浙江省杭州市滨江区江南大道 15 号',
},
],
};
},
methods: {
onAdd() {
@@ -62,50 +62,50 @@ export default {
},
onEdit(item, index) {
Toast('编辑地址:' + index);
}
}
}
},
},
};
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| v-model | 当前选中地址的 id | *string* | - |
| list | 地址列表 | *Address[]* | `[]` |
| disabled-list | 不可配送地址列表 | *Address[]* | `[]` |
| disabled-text | 不可配送提示文案 | *string* | - |
| switchable | 是否允许切换地址 | *boolean* | `true` |
| add-button-text | 底部按钮文字 | *string* | `新增地址` |
| default-tag-text `v2.3.0` | 默认地址标签文字 | *string* | - |
| 参数 | 说明 | 类型 | 默认值 |
| ------------------------- | ----------------- | ----------- | ---------- |
| v-model | 当前选中地址的 id | _string_ | - |
| list | 地址列表 | _Address[]_ | `[]` |
| disabled-list | 不可配送地址列表 | _Address[]_ | `[]` |
| disabled-text | 不可配送提示文案 | _string_ | - |
| switchable | 是否允许切换地址 | _boolean_ | `true` |
| add-button-text | 底部按钮文字 | _string_ | `新增地址` |
| default-tag-text `v2.3.0` | 默认地址标签文字 | _string_ | - |
### Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|------|
| add | 点击新增按钮时触发 | - |
| edit | 点击编辑按钮时触发 | item: 地址对象，index: 索引 |
| select | 切换选中的地址时触发 | item: 地址对象，index: 索引 |
| edit-disabled | 编辑不可配送的地址时触发 | item: 地址对象，index: 索引 |
| 事件名 | 说明 | 回调参数 |
| --------------- | ------------------------ | --------------------------- |
| add | 点击新增按钮时触发 | - |
| edit | 点击编辑按钮时触发 | item: 地址对象，index: 索引 |
| select | 切换选中的地址时触发 | item: 地址对象，index: 索引 |
| edit-disabled | 编辑不可配送的地址时触发 | item: 地址对象，index: 索引 |
| select-disabled | 选中不可配送的地址时触发 | item: 地址对象，index: 索引 |
| click-item | 点击任意地址时触发 | item: 地址对象，index: 索引 |
| click-item | 点击任意地址时触发 | item: 地址对象，index: 索引 |
### Address 数据结构
| 键名 | 说明 | 类型 |
|------|------|------|
| id | 每条地址的唯一标识 | *number \| string* |
| name | 收货人姓名 | *string* |
| tel | 收货人手机号 | *number \| string* |
| address | 收货地址 | *string* |
| isDefault | 是否为默认地址 | *boolean* |
| 键名 | 说明 | 类型 |
| --------- | ------------------ | ------------------ |
| id | 每条地址的唯一标识 | _number \| string_ |
| name | 收货人姓名 | _string_ |
| tel | 收货人手机号 | _number \| string_ |
| address | 收货地址 | _string_ |
| isDefault | 是否为默认地址 | _boolean_ |
### Slots
| 名称 | 说明 | SlotProps |
|------|------|------|
| default | 在列表下方插入内容 | - |
| top | 在顶部插入内容 | - |
| 名称 | 说明 | SlotProps |
| -------------------- | -------------------- | ---------- |
| default | 在列表下方插入内容 | - |
| top | 在顶部插入内容 | - |
| item-bottom `v2.5.0` | 在列表项底部插入内容 | 列表项的值 |