应用

应用把你自己的工具放进控制台,紧挨着它所处理的内容。它的界面是你托管的网页,并通过与你的应用相同的 GraphQL API 读写数据。

四种位置

应用的页面以 iframe 嵌入控制台,位于四个位置之一:导航中的整页、记录编辑器中的标签页、记录编辑器中的侧边栏面板,或替换某个字段默认输入框的字段编辑器。标签页或侧边栏与模型绑定,在打开匹配模型的记录时出现。

与记录协作

编辑器位置通过 @foir/sdk 中的 Editor SDK 与控制台通信,它需要 React 18 或更高版本。页面加载时,控制台会发送记录的值、schema 和主题,并继续负责保存、发布和版本控制。整页以查看它的团队成员的身份行事,只拥有其位置所声明、且该成员也拥有的作用域。它的令牌每次有效五分钟,并在该成员退出登录时失效。

一份清单

应用由你选定的 https URL 上的一份 JSON 清单描述,只有 name 和 version 是必填项。除页面外,应用还可以提供凭据、操作、生命周期钩子,以及在安装时映射到你的模型上的数据结构。它从不拥有模型。

安装与应用市场

从应用市场安装应用,或粘贴其清单 URL 安装。应用市场是经过精选的,未列出的应用则通过其 URL 安装。无论哪种方式,安装预览都会准确显示该应用的每个操作可以读取或写入什么。

用于单个项目的工具

单个项目的标签页或侧边栏可以直接在 foir.config.ts 中声明并推送。当工具要在多个项目中复用时,再构建应用。你提供的页面必须允许控制台作为框架祖先,否则浏览器会将其渲染为空白,SDK 为此提供了 placementFrameAncestors 用于这一点。

阅读详情

应用指南介绍了清单、每种位置、应用可以提供什么,以及安装和更新如何进行。