Adobe XD api 插件配置文件 manifest.json 说明

官方manifest.json说明： https://adobexdplatform.com/plugin-docs/reference/structure/manifest.html

manifest.json

{
  "name" : "myPlugin",   //插件名称，发布后会显示在官方的插件商店
  "host" : {
    "app" : "XD",  
    "minVersion" : "13.0.0"
  },
  "description" : "Sample plugin for Adobe XD, providing starter project scaffolding.", //插件的简介，发布后会显示在官方的插件商店
  "id" : "#########,  //从 Adobe I/O Console 可以获取到插件的唯一ID，该ID请勿随意修改。
 "icons": [  //设置项目的图标，支持定义多个尺寸
    {
      "width": 16,
      "height": 16,
      "path": "images/icon-16.png"
    },
    {
      "width": 96,
      "height": 96,
      "path": "images/icon-96.png"
    }
  ],
  "uiEntryPoints" : [ //数组，可以设置多个菜单
    {
        "label" : "我的插件",  //显示在Adobe XD中的插件名称
        "type" : "menu",   //插件的入口类型，目前只支持菜单
        "menuItems":[
			{
				"label" : "子菜单1",
				"type" : "menu",
                "commandId" : "StartCommand",  //初始函数名
	            "shortcut": {   //快捷键
                    "mac": "Cmd+Shift+w",
                    "win": "Ctrl+Shift+w"
                }
			},
            {
				"label" : "子菜单2",
				"type" : "menu",
                "commandId" : "StartCommand",  //初始函数名
	            "shortcut": {   //快捷键
                    "mac": "Cmd+Shift+p",
                    "win": "Ctrl+Shift+p"
                }
			}
        ]
  } ],
  "version" : "1.0.0"  //插件版本
}

参数说明：

顶级元数据：

键	数据类型	说明
`id`	`string`	从 Adobe I/O Console 可以获取到插件的唯一ID，该ID请勿随意修改。
`name`	`string`	插件名，会显示在插件管理器列表中，不要随意修改。发布插件时此名字必须与, I/O Console 上申请的插件名称一致。
`version`	`string`	插件版本号，必须是x.y.z三段格式。每段范围0-99。
`description`	`string`	插件的说明，会显示在插件管理器列表。
`icons`	`Array<Object>`	插件的图标，会显示在插件管理器列表。建议只提供一个96×96的2倍分辨率图标，因为XD会根据需要自动缩小到48x48来使用。
`host.app`	`string`	表示插件为AdobeXD插件。目前能使用的唯一值是 "XD"。
`host.minVersion`	`string`	支持此插件的Adobe XD的最低版本。必须是x.y.z三段格式。
`host.maxVersion`	`string`	支持此插件的Adobe XD的最高版本。必须是x.y.z三段格式。一倍不用设置最高版本。
`uiEntryPoints`	`Array<MenuItemDefinition or SubmenuDefinition>`	插件添加到Adobe XD的菜单时的参数设置。

uiEntryPoints子数组：

键	数据类型	说明
`type`	`string`	//插件的入口类型，目前只支持菜单
`label`	`string`or `Object`	插件在菜单中显示的名称。可以设置多语言切换。官方的菜单命名规范： follow our plugin experience guidelines.
`commandId`	`string`	点击菜单执行的代码的函数名，将会执行插件目录中的main.js中相应函数名的代码。
`shortcut`	`{mac: string, win: string}`	快捷键设置，可选。

子菜单：

键	数据类型	说明
`type`	`string`	//插件的入口类型，目前只支持菜单
`label`	`string` or `Object`	插件在菜单中显示的名称。可以设置多语言切换。
`menuItems`	`Array<MenuItemDefinition>`	设置子菜单数组，仅支持一级子菜单。

来源：CSDN

作者：Kwin Lin

链接：https://blog.csdn.net/weixin_43014320/article/details/86071802

标签

adobe

Adobe XD api 插件配置文件 manifest.json 说明

菜单项：

子菜单：