Files
wukuang/packages/business-components/README.md
T

36 lines
1.9 KiB
Markdown
Raw Normal View History

2026-05-23 14:05:22 +08:00
# Business Components
### 1. `src/enum/` 目录
该目录主要用于存放各种枚举定义和常量配置,主要是针对业务实体模型以及页面设计的配置项extArrts中的属性key以及一些公共常用属性key。
- `src/enum/common/Constant.ts`: 业务实体模型和页面设计器配置项的默认值和常量配置,例如图片上传限制、文本输入长度限制、数值精度等。
- `src/enum/common/Enum.ts`: 存放通用的枚举定义,例如模型类型、字段类型等。
- `src/enum/settings/` 目录:包含各种字段类型(如附件、日期、数字、选择器等)的特定枚举定义,用于配置字段的业务属性。
**最佳实践**
- 在项目中需要编码字段配置项属性或字段配置项默认值时,使用特定常量或枚举时,避免硬编码。
- 保持枚举和常量的命名清晰和一致,提高代码可读性。
- 对于字段配置相关的默认值,优先在 `Constant.ts` 中定义,便于统一管理和修改。
### 2. `src/components/` 目录
该目录包含可复用的 Vue 组件,分为业务组件和通用组件。
- `src/components/business/`: 存放与特定业务逻辑紧密相关的组件,如多语言选择器、人员组织字段选择器等。
- `src/components/common/`: 存放通用组件,可在不同业务场景中复用,如 AI 图标、自定义时间选择器、弹窗、异常提示等。
- `src/components/setting/`: 主要存放字段配置项设置相关的组件。
- `src/components/index.ts`: 统一导出所有业务组件和通用组件。
### 3. `src/constants/` 目录
该目录用于存放应用级别的常量,与 `enum/common/Constant.ts` 区分,这里通常是更宏观或不直接与枚举关联的常量。
- `src/constants/AIInput.ts`: AI 输入相关的常量。
- `src/constants/UrlPrefix.ts`: URL 前缀相关的常量。
### 4. `src/locales/` 目录
该目录用于存放国际化(i18n)相关的语言文件和配置。