{"id":15029184,"url":"https://github.com/plortinus/element-china-area-data","last_synced_at":"2025-05-15T02:09:29.357Z","repository":{"id":18169353,"uuid":"83518664","full_name":"Plortinus/element-china-area-data","owner":"Plortinus","description":":cn: Element UI \u0026\u0026 antd Cascader级联选择器 中国省市区三级、二级联动option数据","archived":false,"fork":false,"pushed_at":"2023-12-14T05:56:30.000Z","size":5793,"stargazers_count":1315,"open_issues_count":15,"forks_count":216,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-05-11T21:44:07.408Z","etag":null,"topics":["address","administrative-divisions","administrative-divisions-of-china","antdesign","area","china","china-area-data","city","element-ui","province","vue"],"latest_commit_sha":null,"homepage":"https://plortinus.github.io/element-china-area-data/index.html","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Plortinus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-01T06:10:33.000Z","updated_at":"2025-04-25T10:26:40.000Z","dependencies_parsed_at":"2024-06-18T12:26:04.439Z","dependency_job_id":null,"html_url":"https://github.com/Plortinus/element-china-area-data","commit_stats":{"total_commits":47,"total_committers":5,"mean_commits":9.4,"dds":"0.21276595744680848","last_synced_commit":"de68a8b44057e3a0b4619b9634fef2c535520bc4"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Plortinus%2Felement-china-area-data","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Plortinus%2Felement-china-area-data/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Plortinus%2Felement-china-area-data/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Plortinus%2Felement-china-area-data/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Plortinus","download_url":"https://codeload.github.com/Plortinus/element-china-area-data/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254259384,"owners_count":22040820,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["address","administrative-divisions","administrative-divisions-of-china","antdesign","area","china","china-area-data","city","element-ui","province","vue"],"created_at":"2024-09-24T20:09:54.757Z","updated_at":"2025-05-15T02:09:29.329Z","avatar_url":"https://github.com/Plortinus.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Element UI 中国省市区级联数据\n\n[![npm](https://img.shields.io/npm/v/element-china-area-data.svg)](https://www.npmjs.com/package/element-china-area-data) ![npm](https://img.shields.io/npm/dw/element-china-area-data) ![GitHub top language](https://img.shields.io/github/languages/top/Plortinus/element-china-area-data) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/element-china-area-data) ![GitHub](https://img.shields.io/github/license/Plortinus/element-china-area-data)\n\n## 演示效果 gif\n\n![20230508-093525](https://user-images.githubusercontent.com/20693993/236715340-09fb0820-781b-4faf-8a0f-3f24012d8213.gif)\n\n\n## 安装\n\n```bash\nnpm install element-china-area-data -S\n```\n\n[在线示例](https://plortinus.github.io/element-china-area-data/index.html)\n\n## import 使用\n\n```js\nimport {\n  provinceAndCityData,\n  pcTextArr,\n  regionData,\n  pcaTextArr,\n  codeToText,\n} from \"element-china-area-data\";\n```\n\n1. `provinceAndCityData`省市二级联动数据,汉字+code\n2. `regionData`省市区三级联动数据\n3. `pcTextArr`省市联动数据，纯汉字\n4. `pcaTextArr`省市区联动数据，纯汉字\n5. `codeToText`是个大对象，属性是区域码，属性值是汉字 用法例如：`codeToText['110000']`输出`北京市`\n\n- 省市二级联动:\n\n  ```js\n  \u003ctemplate\u003e\n    \u003cdiv id=\"app\"\u003e\n      \u003cel-cascader\n        size=\"large\"\n        :options=\"provinceAndCityData\"\n        v-model=\"selectedOptions\"\u003e\n      \u003c/el-cascader\u003e\n    \u003c/div\u003e\n  \u003c/template\u003e\n\n  \u003cscript\u003e\n    import { provinceAndCityData } from 'element-china-area-data'\n    export default {\n      data () {\n        return {\n          provinceAndCityData,\n          selectedOptions: []\n        }\n      },\n    }\n  \u003c/script\u003e\n  ```\n\n- 省市二级联动,纯汉字:\n\n  ```js\n  \u003ctemplate\u003e\n    \u003cdiv id=\"app\"\u003e\n      \u003cel-cascader\n        size=\"large\"\n        :options=\"pcTextArr\"\n        v-model=\"selectedOptions\"\u003e\n      \u003c/el-cascader\u003e\n    \u003c/div\u003e\n  \u003c/template\u003e\n\n  \u003cscript\u003e\n    import { pcTextArr } from 'element-china-area-data'\n    export default {\n      data () {\n        return {\n          pcTextArr,\n          selectedOptions: []\n        }\n      },\n    }\n  \u003c/script\u003e\n  ```\n\n- 省市区三级联动\n\n  ```js\n  \u003ctemplate\u003e\n    \u003cdiv id=\"app\"\u003e\n      \u003cel-cascader\n        size=\"large\"\n        :options=\"regionData\"\n        v-model=\"selectedOptions\"\u003e\n      \u003c/el-cascader\u003e\n    \u003c/div\u003e\n  \u003c/template\u003e\n\n  \u003cscript\u003e\n    import { regionData } from 'element-china-area-data'\n    export default {\n      data () {\n        return {\n          regionData,\n          selectedOptions: []\n        }\n      },\n    }\n  \u003c/script\u003e\n  ```\n\n- 省市区三级联动，纯汉字\n\n  ```js\n  \u003ctemplate\u003e\n    \u003cdiv id=\"app\"\u003e\n      \u003cel-cascader\n        size=\"large\"\n        :options=\"pcaTextArr\"\n        v-model=\"selectedOptions\"\u003e\n      \u003c/el-cascader\u003e\n    \u003c/div\u003e\n  \u003c/template\u003e\n\n  \u003cscript\u003e\n    import { pcaTextArr } from 'element-china-area-data'\n    export default {\n      data () {\n        return {\n          pcaTextArr,\n          selectedOptions: []\n        }\n      },\n    }\n  \u003c/script\u003e\n  ```\n\n## script 引入\n\n```html\n\u003cscript src=\"https://unpkg.com/element-china-area-data@6.0.0/dist/element-china-area-data.iife.js\"\u003e\u003c/script\u003e\n\u003cscript\u003e\n  new Vue({\n    el: \"#app\",\n    data: function () {\n      return {\n        codeToText: elementChinaAreaData.codeToText,\n        provinceAndCityData: elementChinaAreaData.provinceAndCityData,\n        pcTextArr: elementChinaAreaData.pcTextArr,\n        regionData: elementChinaAreaData.regionData,\n        pcaTextArr: elementChinaAreaData.pcaTextArr,\n        selectedOptions1: [\"11\", \"110101\"],\n        selectedOptions2: [\"12\", \"1201\", \"120101\"],\n        selectedOptions3: [\"北京市\", \"朝阳区\"],\n        selectedOptions4: [\"北京市\", \"市辖区\", \"朝阳区\"],\n      };\n    },\n  });\n\u003c/script\u003e\n```\n\n## v6 改动\n\n0. 改用全新脚手架构建，同时支持 CommonJS 和 ESM modules\n1. 去掉了 provinceAndCityDataPlus/regionDataPlus/TextToCode，全选功能请利用级联组件自身的\n2. CodeToText 修改为 codeToText\n3. 添加了纯汉字的数据对象 pcTextArr 和 pcaTextArr\n4. 不再支持港澳台，使用新的数据源https://github.com/modood/Administrative-divisions-of-China\n\n## 旧版本 v5.0.2\n\n[文档地址](./V5.MD)\n## 数据来源\n\n[Administrative-divisions-of-China](https://github.com/modood/Administrative-divisions-of-China)\n\n## 开发测试命令\n\n- dev - starts dev server\n- build - generates the following bundles: CommonJS (.cjs) ESM (.mjs) and IIFE (.iife.js). The name of bundle isautomatically taken from package.json name property\n- test - starts vitest and runs all tests\n- test:coverage - starts vitest and run all tests with code coverage report\n- lint:scripts - lint .ts files with eslint\n- lint:styles - lint .css and .scss files with stylelint\n- format:scripts - format .ts, .html and .json files with prettier\n- format:styles - format .cs and .scss files with stylelint\n- format - format all with prettier and stylelint\n- prepare - script for setting up husky pre-commit hook\n- uninstall-husky - script for removing husky from repository\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplortinus%2Felement-china-area-data","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplortinus%2Felement-china-area-data","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplortinus%2Felement-china-area-data/lists"}