← 返回主文档
步骤 5

注册 Helper 到 RegisterWidgetHelper.ts

将 Helper 添加到系统内置 Helper 数组,使其能参与属性面板构建

📋 功能描述

RegisterWidgetHelper.ts 中将新创建的 Helper 导入并添加到 SYS_WIDGET_HELPERS 数组中。注册后,系统能够根据 Helper 配置生成右侧属性面板、处理拖拽行为、构造默认 widget 数据等。

🧩 模块描述

RegisterWidgetHelper.ts 是 Helper 注册的统一入口:

📁 文件信息

文件路径

packages/form-designer/src/config/RegisterWidgetHelper.ts

操作类型

修改 - 添加 import 和数组项

注册位置

SYS_WIDGET_HELPERS 数组

所属层级

页面设计器层 (packages/form-designer)

💻 修改示例

1. 在文件顶部添加导入:

// packages/form-designer/src/config/RegisterWidgetHelper.ts // 在已有 imports 中添加: import MyNewComponentHelper from '~@/config/widget-helper/MyNewComponentHelper'

2. 在 SYS_WIDGET_HELPERS 数组中添加:

export const SYS_WIDGET_HELPERS = [ // 布局 RowHelper, TabsHelper, // 容器 RootHelper, ColHelper, GroupPanelHelper, // 通用组件 FormCommonTxtHelper, FormCommonBtnHelper, // ← 添加新 Helper(根据组件类型放在对应分组) MyNewComponentHelper, ]

⚠️ 注意事项

分组放置

根据组件类型(布局/容器/表单/通用/业务等)将 Helper 放在对应的注释分组下,便于维护。

➡️ 下一步

完成 Helper 注册后,继续执行: