43 lines
1.6 KiB
Markdown
43 lines
1.6 KiB
Markdown
|
---
|
|||
|
|
name: jjb-interpolation-standards
|
|||
|
|
description: 定义 JJB 接口动态文本配置使用规范。在遵循字段码规范、列配置规范、兜底处理时查阅。
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# 接口动态文本配置
|
|||
|
|
|
|||
|
|
## 使用规范
|
|||
|
|
|
|||
|
|
- **字段码规范**：
|
|||
|
|
|
|||
|
|
- 字段码（`fieldCode`）应与后端接口返回的字段码保持一致
|
|||
|
|
|
|||
|
|
- 字段码命名规则：`appIdentifier-pageFolder-fieldSemantic`，例如 `reslib-app-resourceManagement-createTime`。详见 [[jjb-field-code-registration]]
|
|||
|
|
|
|||
|
|
- **列配置规范**：
|
|||
|
|
|
|||
|
|
- 需要动态配置标题的列必须包含 `fieldCode` 属性
|
|||
|
|
|
|||
|
|
- 不需要动态配置的列可以不包含 `fieldCode`，使用固定的 `title`
|
|||
|
|
|
|||
|
|
- **页面标题规范**：
|
|||
|
|
|
|||
|
|
- `DEFAULT_MENU` 是后端返回的页面默认标题，可以通过 `insert('DEFAULT_MENU')` 获取
|
|||
|
|
|
|||
|
|
- 该值可以用于 `PageLayout` 组件的 `title` 属性，但**不是必须的**，可根据实际需求选择是否使用
|
|||
|
|
|
|||
|
|
- 建议提供兜底标题，例如：`insert('DEFAULT_MENU') || '默认标题'`
|
|||
|
|
|
|||
|
|
- **兜底处理**：
|
|||
|
|
|
|||
|
|
- 使用 `insert` 方法时，建议提供兜底文本，例如：`insert('reslib-app-resourceManagement-userName') || '用户名'`
|
|||
|
|
|
|||
|
|
- 如果接口未返回字段配置或字段不可见，使用兜底文本确保页面正常显示
|
|||
|
|
|
|||
|
|
- **注意事项**：
|
|||
|
|
|
|||
|
|
- 字段配置数据加载期间，`interpolation.map` 和 `interpolation.list` 为空对象/数组
|
|||
|
|
|
|||
|
|
- 字段的可见性由 `visibleEnum` 控制，`"FALSE"` 表示可见，`"TRUE"` 表示不可见（注意是字符串，非 boolean）
|
|||
|
|
|
|||
|
|
- 不可见的字段会被 `columns` 方法过滤掉，不会在表格中显示
|