vant/packages/area/en-US.md

Area

The Picker component is usually used with Popup Component.

Install

import { Area } from 'vant';

Vue.use(Area);

Usage

Basic Usage

To initailize Area component, area-list property is required. Data structure will be introduced later.

<van-area :area-list="areaList" />

Initial Value

To have a selected value，simply pass the code of target area to value property.

<van-area :area-list="areaList" value="110101" />

Columns Number

columns-num property is used to config number of columns to be displayed. This component has 3 columns corresponding to a 3 level picker by default. Set columns-num with 2, you'll have a 2 level picker.

<van-area :area-list="areaList" :columns-num="2" title="Title" />

Columns Placeholder

columns-placeholder property is used to config placeholder of columns.

<van-area
  :area-list="areaList"
  :columns-placeholder="['Choose', 'Choose', 'Choose']"
  title="Title"
/>

API

Attribute	Description	Type	Default
value	the code of selected area	String	-
title	Toolbar title	String	-
area-list	Area data	Object	-
columns-num	level of picker	`String	Number`
columns-placeholder	placeholder of columns	string[]	[]
item-height	Option height	Number	44
loading	Whether to show loading prompt	Boolean	false
visible-item-count	Count of visible columns	Number	5
confirm-button-text	Text of confirm button	String	Confirm
cancel-button-text	Text of cancel button	String	Cancel

Event

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

Methods

Use ref to get area instance and call instance methods

Name	Attribute	Return value	Description
reset	-	-	Reset all options

Data Structure

areaList

An object contains three properties: province_list, city_list and county_list. Each property is a simple key-value object, key is a 6-bit code of the area of which first two bits stand for the province or state, middle two bits are used as city code and the last two are district code, value is the name of the area. If the code stands for an area that has sub-areas, lower bits of it will be filled with 0.

Example of AreaList

{
  province_list: {
    110000: 'Beijing',
    330000: 'Zhejiang Province'
  },
  city_list: {
    110100: 'Beijing City',
    330100: 'Hangzhou',
  },
  county_list: {
    110101: 'Dongcheng District',
    110102: 'Xicheng District',
    110105: 'Chaoyang District',
    110106: 'Fengtai District'
    330105: 'Gongshu District',
    330106: 'Xihu District',
    // ....
  }
}

All code of China: Area.json

argument of callback function confirm

An array contains selected area objects.

code - code of selected area, name - name of selected area

[{
  code: '330000',
  name: 'Zhejiang Province'
}, {
  code: '330100',
  name: 'Hangzhou'
},{
  code: '330105',
  name: 'Xihu District'
}]