注意:以下翻译的准确性尚未经过验证。这是使用 AIP ↗ 从原始英文文本进行的机器翻译。

模块接口

模块接口是一组变量,当嵌入时,能够映射到父模块的变量,并从URL初始化。您可以将模块接口视为Workshop模块的API。

要将变量添加到模块接口中,导航到变量的设置面板,添加一个外部ID,并确保启用模块接口的切换。您可以为模块接口变量提供一个显示名称和描述,这将在模块嵌入或用于打开Workshop模块事件时显示。

模块接口配置

嵌入模块接口

当嵌入一个模块时,该模块的模块接口变量将可用于将父模块变量映射到子模块接口变量。您可以在嵌入模块文档的接口配置中了解更多信息。

打开Workshop模块事件

打开Workshop模块事件可用于避免手动创建URL,如下所述。所选模块的接口将出现,允许变量值从当前模块传递到所选模块的接口变量。当调用事件时,URL使用当前值打开所选模块。

使用模块接口变量创建URL

在打开Workshop模块事件之外,可以手动动态生成URL,以便使用模块接口变量的URL查询参数值共享应用程序状态的自定义链接。为此,请按照以下步骤操作:

  1. 登录到您的Workshop应用。
  2. 从浏览器中复制URL。确保处于查看模式而不是编辑模式。此URL是固定的,因此您可以与拥有正确权限的其他用户共享。
  3. 现在,返回编辑模式。
  4. 选择位于左侧边栏的变量菜单。
  5. 创建一个新变量 > 字符串 > 静态
  6. 转到变量的设置标签,添加一个外部ID。
  7. 将步骤2中的URL后加上?,后接外部ID,=,以及您希望设置的值。例如,?interfaceVariable=123。您可以通过添加一个和号&,后接另一个外部ID,等于=值,来添加其他模块接口变量。

链接现在可以使用,并将模块接口变量定义为URL中设置的值。此链接可以通过使用变量变换动态生成,值来自操作表单、函数或其他变量变换。

出于测试目的,您可以将URL中的/latest/更改为/dev/,链接将重定向到Workshop应用程序的最后保存版本,而不是最后发布版本。

Carbon导航

阅读关于在Carbon导航中使用模块接口变量的信息。请注意,Carbon支持的变量类型有限制,并且在为Carbon模块选项卡配置参数时,外部ID必须以variable.为前缀。