https://github.com/pansyjs/china-division
🇨🇳 中国省市区数据
https://github.com/pansyjs/china-division
china china-divisions
Last synced: 6 months ago
JSON representation
🇨🇳 中国省市区数据
- Host: GitHub
- URL: https://github.com/pansyjs/china-division
- Owner: pansyjs
- Created: 2019-06-16T07:11:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-30T01:51:41.000Z (12 months ago)
- Last Synced: 2024-10-30T04:00:50.274Z (12 months ago)
- Topics: china, china-divisions
- Language: TypeScript
- Homepage:
- Size: 855 KB
- Stars: 70
- Watchers: 3
- Forks: 21
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
@pansy/china-division
> 基于[china-division](https://github.com/modood/Administrative-divisions-of-China), 提供中国省市区数据并提供相应的工具方法
**提供两种数据格式**
- `{ v: string; n: string; c: {...}[] }`
- `{ label: string; value: string; children: {...}[] }` 适用于`Antd`级联选择组件
如有更新数据的需求，请修改`china-division`版本，执行`npm run export:data`即可。
## ✨ 特性
- 🌈 基于`china-division`，提供了香港、澳门、台湾的数据
- 💻 使用 TypeScript 编写，提供完善的类型定义
- 🌴 提供`js`、`json`两种数据引用方式
## 🏗 安装
```sh
# yarn
yarn add @pansy/china-division
# npm
npm install @pansy/china-division --save
# pnpm
pnpm add @pansy/china-division
```
## 🔨 使用
```ts
// 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');
```
## ⌨️ 本地开发
```sh
$ git clone git@github.com:pansyjs/china-division.git
$ cd ./china-division
# 安装依赖
$ pnpm install
# 导出数据
$ npm run export
# 运行测试用例
$ npm run test
# 编译项目
$ npm run build
```
## 🌟 社区互助
| Github Issue | 钉钉群 | 微信群 |
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- |
| [issues](https://github.com/pansyjs/china-division/issues) | 
| 
|