SuperAPI AI 工具集

orderly-plugin-write

编程与开发

查看项目

更新于 10-16 03:11

技能介绍

用途:在已用 orderly-plugin-create 生成脚手架后,编写 Orderly 插件的实际代码,或增改拦截器、Hooks 与生命周期逻辑。插件可直接使用 @orderly.network/hooks、@orderly.network/ui、@orderly.network/utils;仅 SDK 声明的可注入目标(如 Trading.OrderEntry.SubmitSection)可被拦截,可用 Inspector 工具查找目标路径。

主要能力:插件分 Widget(经拦截器挂载到锚点)、Page(用 SDK UI 与 Hooks 构建完整页面)、Layout(仅交易页,内置布局拦截 Trading.Layout.Desktop,SDK 也暴露 Trading.Layout.Mobile)三类。拦截器函数为 component:(Original,props,api)=>ReactNode,支持增强、包裹、替换三种策略,同一目标可链式叠加。编写前建议先用 Orderly docs MCP 的 orderly_docs_search、orderly_docs_get_hook、orderly_docs_get_component、orderly_docs_get_type 等确认签名。拦截器内不能直接调用 Hooks,需返回包装组件。setup 仅做幂等非 UI 工作;Provider 目前不消费 setup 返回的清理函数,事件订阅应在包装组件内用 useEffect 清理,并使用 TrackerEventName 枚举。类型可用 createInterceptor、PluginInterceptor 泛型或内联标注。插件 id 须匹配 /^[a-zA-Z][a-zA-Z0-9-]*$/ 且与 Marketplace API 一致。

适用场景与限制:适合给交易页面注入 UI、构建页面、调整桌面布局。onError 在拦截器抛错时触发,onFallback 提供降级 UI;onInitialize、onInstall、onMount、onUnmount、onDispose 当前未被 plugin-core 调用,不应依赖。Layout 仅限交易页且内置插件面向桌面。具体定价等未提供。