UX1 自定义组件常用公开能力

这页列出当前 Agent 开发辅助工具包已核实的 UX1 自定义组件公开入口。旧工程可能锁定不同模板和依赖版本,因此动手前仍需核对目标组件的 package.json、相邻同类组件和已安装依赖的类型声明。

下面的包路径来自当前工具包契约;若目标工程的类型声明与本文不同,以目标工程实际版本为准,不能用本文强行升级或改写旧工程。

名称

用途

Edit

显示设计页面中的组件。

Use

显示用户实际使用的组件。

Option

提供右侧属性设置面板。

public/data.json

声明组件名称、默认配置和事件。

IConfig

定义组件可配置的数据。

目录和加载约定见组件工程与契约

当前工具包契约从 @deepfos/ux-state 的包入口提供:

API

用途

useValue

读取和更新组件主值。

useGetRuntimeState

读取组件运行时状态对象。

useSetRuntimeState

更新运行时状态路径,也可按当前契约注册 data.json.methods 声明的方法。

当前工具包契约从 @deepfos/ux-view 的包入口提供:

API

用途

useDataEntryEdit

接入数据录入组件的编辑态通用逻辑。

useDataEntryUse

接入数据录入组件的使用态初值、校验、重置和变更逻辑。

FormItem

提供表单项的标题、校验、必填和提示等容器能力。

getLocale()

获取页面当前语言。

FormItem 的上述来源已由当前工具包契约核实;如果目标工程的已安装类型或同类组件使用不同入口,应沿用该工程版本,不从培训旧示例猜测路径。

当前工具包契约从 @deepfos/ux-dynamic-option-panel 的包入口提供:

API

用途

DynamicOptionPanel(默认导出)

根据 optionSchema 渲染属性面板。

registerComponent

注册当前组件需要的自定义属性控件。

optionSchema 通常用 viewListlogicList 描述面板。精确参数、内置控件和联动规则以开发辅助工具包及目标工程当前版本为准。

组件事件先在 data.json.events 中声明,再作为同名回调传给 Use。用户交互时调用该回调,由平台执行属性面板中配置的动作。需要暴露组件方法或提取元素依赖时,应使用目标项目的公开契约。

Agent 只使用辅助工具包和目标项目当前版本确认的公开入口,不深度导入源码目录或依赖平台内部状态。配置应与 data.json 保持一致,并处理加载、空数据和错误情况。

完成后,Agent 会检查类型、构建和组件产物;精确参数以辅助工具包及目标项目当前版本为准。属性面板的节点和联动规则见属性面板与联动

回到顶部

咨询热线

400-821-9199

我们使用 ChatGPT,基于文档中心的内容以及对话上下文回答您的问题。

ctrl+Enter to send