49 lines
1.6 KiB
Markdown
49 lines
1.6 KiB
Markdown
|
# zy-react-data 数据包文档
|
|||
|
|
|
|||
|
|
## 快速开始
|
|||
|
|
|
|||
|
|
### 安装
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
yarn add zy-react-data
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 📄 更新日志
|
|||
|
|
|
|||
|
|
### v1.0.0 (2026-08-25)
|
|||
|
|
|
|||
|
|
- 🎉 初始版本发布
|
|||
|
|
|
|||
|
|
### 使用方式
|
|||
|
|
|
|||
|
|
JSON、枚举均按目录引入：
|
|||
|
|
|
|||
|
|
```tsx
|
|||
|
|
import Area from "zy-react-data/json/area.json";
|
|||
|
|
import { DICTIONARY_APP_KEY_ENUM } from "zy-react-data/enum/dictionary";
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 说明
|
|||
|
|
|
|||
|
|
- 枚举的类型说明根据包内 `.d.ts` 类型声明整理。
|
|||
|
|
- 业务项目可以独立升级本包，不需要同步升级 `zy-react-library`。
|
|||
|
|
|
|||
|
|
## 静态 JSON
|
|||
|
|
|
|||
|
|
| 文件 | 引入路径 | 简要说明 |
|
|||
|
|
| --- | --- | --- |
|
|||
|
|
| `area.json` | `zy-react-data/json/area.json` | 行政区域树形数据，供地区级联、地区树选择使用。 |
|
|||
|
|
| `industry.json` | `zy-react-data/json/industry.json` | 行业分类树形数据，供行业级联、行业树选择使用。 |
|
|||
|
|
| `nation.json` | `zy-react-data/json/nation.json` | 民族数据列表。 |
|
|||
|
|
|
|||
|
|
## 枚举
|
|||
|
|
|
|||
|
|
| 枚举 | 引入路径 | 简要说明 |
|
|||
|
|
| --- | --- | --- |
|
|||
|
|
| `DICTIONARY_APP_KEY_ENUM` | `zy-react-data/enum/dictionary` | 字典接口使用的 `appKey` 常量，包含 `DEFAULT`、`GWJ`。 |
|
|||
|
|
| `HIDDEN_SOURCE_ENUM` | `zy-react-data/enum/hidden/gwj` | 隐患来源选项列表。 |
|
|||
|
|
| `HIDDEN_STATE_ENUM` | `zy-react-data/enum/hidden/gwj` | 隐患状态选项列表。 |
|
|||
|
|
| `HIDDEN_RECTIFICATION_TYPE_ENUM` | `zy-react-data/enum/hidden/gwj` | 隐患整改类型选项列表。 |
|
|||
|
|
| `UPLOAD_FILE_TYPE_ENUM` | `zy-react-data/enum/uploadFile` | 文件上传类型编码枚举。 |
|
|||
|
|
| `UPLOAD_FILE_PATH_ENUM` | `zy-react-data/enum/uploadFile` | 文件上传类型编码到服务端路径标识的映射。 |
|