pycn
v2.0.1
Published
[![npm][npm]][npm-url] ![GitHub][license]
Downloads
45
Readme
pycn
中国行政区域(省/市/区/街道)拼音,支持 es
cjs
umd
格式,方便 node/es6/浏览器使用。
适用以下场景:
- 字母索引城市列表选择
- 拼音搜索省/市/区/街道数据
如果不使用拼音,需要注意一些多音字处理,比如 亳(bo,不是 hao)州市、厦(xia,不是 sha)门、长(chang,不是 zhang)春市 ...
数据来源:高德地图-行政区域查询
数据格式
| 文件模块 | 描述 | | --- | --- | | py-data.ts | 省/市/区/街道 | | py-province-city-district.ts | 省/市/区 | | py-province-city.ts | 省/市 | | py-province.ts | 省 | | py-city.ts | 市 | | py-district.ts | 区 | | py-street.ts | 街道 |
安装
- node/es
npm install pycn
- 浏览器
html 直接引入 unpkg 对应的文件,注意不同模块对应不同的全局变量,如 py-city.js
全局变量为 pyCity
。
使用
所有文件模块都存放在 es
或 cjs
或 umd
文件夹下,通过模块引入不同文件使用不同数据。
注意:尽量只使用其中一个数据,否则会使项目构建体积变大。
// 省/市/区/街道
import pyData from 'pycn/es/py-data';
// 省/市/区
import pyProvinceCityDistrict from 'pycn/es/py-province-city-district';
// 省/市
import pyProvinceCity from 'pycn/es/py-province-city';
// 省
import pyProvince from 'pycn/es/py-province';
// 市
import pyCity from 'pycn/es/py-city';
// 区
import pyDistrict from 'pycn/es/py-district';
// 街道
import pyStreet from 'pycn/es/py-street';
示例
- 所有城市按字母排序
import pyCity from 'pycn/es/py-city';
const result = pyCity.sort((a, b) => a.py.localeCompare(b.py, 'zh'));
console.log(result);