ui/vant
1
0
Fork 0
mirror of https://github.com/youzan/vant.git synced 2025-10-18 17:51:54 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

[Improvement] optimize area performance (#457)

Browse Source
This commit is contained in:
neverland
2017-12-20 17:39:51 +08:00
committed by GitHub
parent df67b005ce
commit 021d30efb1
6 changed files with 98 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
docs/markdown/zh-CN/area.md
View File

@@ -2,7 +2,7 @@
### 使用指南
``` javascript
```javascript
import { Area } from 'vant';
Vue.use(Area);
@@ -12,25 +12,23 @@ Vue.use(Area);
#### 基础用法
要初始化一个`Area`组件，你需要传入一个`areaList`属性，`areaList`数据格式具体可看下面数据格式章节。
要初始化一个`Area`组件，你需要传入一个`areaList`属性，`areaList`数据格式具体可看下面数据格式章节
```html
<van-area :areaList="areaList" />
```
#### 选中省市县
如果想选中某个省市县，需要传入一个`value`属性，绑定对应的省市县`code`。
如果想选中某个省市县，需要传入一个`value`属性，绑定对应的省市县`code`
```html
<van-area :areaList="areaList" value="110101" />
```
#### 配置显示列
可以通过`columnsNum`属性配置省市县显示的列数，默认情况下会显示省市县，当你设置为`2`，则只会显示省市选择。
可以通过`columnsNum`属性配置省市县显示的列数，默认情况下会显示省市县，当你设置为`2`，则只会显示省市选择
```html
<van-area :areaList="areaList" :columnsNum="2" title="标题" />
@@ -38,29 +36,30 @@ Vue.use(Area);
### 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` | `''` | - |
| areaList | 省市县数据，必须与`province_list`、`city_list`和`county_list`为 key | `Object` | - | - |
| columnsNum | 省市县显示列数，3-省市县，2-省市，1-省 | `String`,`Number` | 3 | - |
### Event
| 事件名称 | 说明 | 回调参数 |
|-----------|-----------|-----------|
| confirm | 点击右上方完成按钮 | 一个数组参数，具体格式看下方数据格式章节 |
| cancel | 点击取消按钮时 | - |
| 事件名称 | 说明 | 回调参数 |
| -------- | ------------------ | ---------------------------------------- |
| confirm | 点击右上方完成按钮 | 一个数组参数，具体格式看下方数据格式章节 |
| cancel | 点击取消按钮时 | - |
### 数据格式
#### 省市县列表数据格式
整体是一个Object，包含 `province_list`, `city_list`, `county_list` 三个key。
整体是一个 Object，包含 `province_list`, `city_list`, `county_list` 三个 key。
每项以省市区编码作为key，省市区名字作为value。编码为6位数字，前两位代表省份，中间两位代表城市，后两位代表区县，以0补足6位。如北京编码为 `11`，以零补足6位，为 `110000`。
每项以省市区编码作为 key，省市区名字作为 value。编码为 6 位数字，前两位代表省份，中间两位代表城市，后两位代表区县，以 0 补足 6 位。如北京编码为 `11`，以零补足 6 位，为 `110000`。
`AreaList`具体格式如下：
```javascript
{
province_list: {
@@ -91,18 +90,24 @@ Vue.use(Area);
完整数据见 [Area.json](https://github.com/youzan/vant/blob/dev/docs/demos/mock/area.json)
#### 点击完成时返回的数据格式
返回的数据整体为一个数组，数组内包含 `columnsNum` 个数据， 每个数据对应一列选项中被选中的数据。
`code` 代表被选中的地区编码， `name` 代表被选中的地区名称
```javascript
[{
code: '110000',
name: '北京市'
}, {
code: '110100',
name: '北京市'
},{
code: '110101',
name: '东城区'
}]
[
{
code: '110000',
name: '北京市'
},
{
code: '110100',
name: '北京市'
},
{
code: '110101',
name: '东城区'
}
];
```