@pansy/china-division
v2.1.0
Published
中国省市区数据
Downloads
62
Readme
基于china-division, 提供中国省市区数据并提供相应的工具方法
提供两种数据格式
{ v: string; n: string; c: {...}[] }
{ label: string; value: string; children: {...}[] }
适用于Antd
级联选择组件
如有更新数据的需求,请修改china-division
版本,执行npm run export:data
即可。
✨ 特性
- 🌈 基于
china-division
,提供了香港、澳门、台湾的数据 - 💻 使用 TypeScript 编写,提供完善的类型定义
- 🌴 提供
js
、json
两种数据引用方式
🏗 安装
# yarn
yarn add @pansy/china-division
# npm
npm install @pansy/china-division --save
# pnpm
pnpm add @pansy/china-division
🔨 使用
// Antd Cascader组件使用
import cascaderOptions, { DivisionUtil } from '@pansy/china-division';
const divisionUtil = new DivisionUtil(cascaderOptions);
// 返回源数据
divisionUtil.getSourceData();
// 返回省级别数据
divisionUtil.getProvinces();
// 返回指定Code的所有子节点
divisionUtil.getChildrenByCode('110000');
// 返回指定Code的名称
divisionUtil.getNameByCode('110000');
// 返回指定Code的节点
divisionUtil.getDivisionByCode('110000');
⌨️ 本地开发
$ git clone [email protected]:pansyjs/china-division.git
$ cd ./china-division
# 安装依赖
$ pnpm install
# 导出数据
$ npm run export
# 运行测试用例
$ npm run test
# 编译项目
$ npm run build
🌟 社区互助
| Github Issue | 钉钉群 | 微信群 | | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- | | issues | | |