Skip to content

Commit 6e4d840

Browse files
author
Steve Kwak
committed
Merge branch 'console-update-v2' of https://github.com/AdobeXD/Plugin-Docs into console-update-v2
2 parents 517d022 + e833265 commit 6e4d840

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

reference/structure/manifest.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ The manifest is where you include metadata about your plugin. Simply put, the ma
1515
],
1616
"host": {
1717
"app": "XD",
18-
"minVersion": "13.0",
19-
"maxVersion": "22.0"
18+
"minVersion": "21.0"
2019
},
2120

2221
"uiEntryPoints": [
@@ -50,9 +49,9 @@ Key path | Type | Description | Required
5049
`id` | `string` | Unique identifier for your plugin. You can get your unique ID on the [Adobe I/O Console](https://console.adobe.io/plugins).| Develop / Publish
5150
`name` | `string` | The name should be 3 - 45 characters. <br> **Note:** We recommend your plugin name matches the _project name_ you created when getting your plugin ID from the I/O Console. | Develop / Publish
5251
`version`| `string` | Version number of your plugin in `x.y.z` format. <br>Version must be three segments and each version component must be between `0` and `99`. | Develop / Publish
53-
`icons` | `array<object>` | Icons displayed in the Plugin Manager listing. <br> PNG, JPG/JPEG formats are supported and the max file size for each icon is 1MB. <br> Two sizes are required - `[24, 48]`. | Publish
52+
`icons` | `array<object>` | Icons displayed in XD's plugins panel. <br> PNG, JPG/JPEG formats are supported and the max file size for each icon is 1MB. <br> Two sizes are required - `[24, 48]`. <br> **Note:** Icons for XD's Plugin Manager are uploaded directly via the I/O Console, not included within your plugin itself. See our ["Publishing your plugin" guide](../../distribution/how-to-submit-to-plugin-manager.md) to learn more. | Publish
5453
`host.app` | `string` | Indicates that this is a plugin for Adobe XD (currently, the only valid value here is `"XD"`). | Develop / Publish
55-
`host.minVersion` | `string` | Minimum required version of the host app (in `x.y` format) that can run this plugin. <br> **Note:** Must be two segments. Typically, you'll leave the minor segment set to `0`, e.g. `16.0`. | Develop / Publish
54+
`host.minVersion` | `string` | Minimum required version of the host app (in `x.y` format) that can run this plugin. The lowest valid version for headless and modal plugins is `13.0`. The lowest valid version for panel plugins is `21.0`. <br> **Note:** The version number must be two segments. Typically, you'll leave the minor segment set to `0`, e.g. `16.0`. | Develop / Publish
5655
`host.maxVersion` | `string` | Maximum version of host app that can run this plugin. Same formatting as `host.minVersion`. | Optional
5756
`uiEntryPoints` | <code>array&lt;[MenuItemDefinition](#MenuItemDefinition)&gt;</code> | Describes the entries your plugin adds to the _Plugins_ menu & "plugin launchpad" sidebar in XD. See the next section for details. | Develop / Publish
5857

@@ -68,8 +67,8 @@ Key | Type | Description
6867
----|------|------------
6968
`type` | `string` | Entry point type: either `"menu"` or `"panel"`.
7069
`label` | <code>?string&#124;[LocaleMap](#menu-localization)</code> | _Required_ if multiple `MenuItemDefinition` objects defined; _ignored_ if only one defined.<br><br> Label for this menu item that the user will select to run your plugin. May be a single string _or_ a dictionary of localized strings.
71-
`commandId` | `string` | Specify `commandId` to create a menu item that runs plugin code directly -- either a headless command, or a command with modal dialog box UI. This identifier links the menu item to a [_handler function_](./handlers.md#command) in your plugin's JavaScript code. This identifier needs to be unique within your plugin. Don't specify `commandId` and `panelId` at the same time.
72-
`panelId` | `string` | Specify `panelId` to create a menu item that opens panel UI for your plugin. This identifier links the menu item to a [_panel definition_ object](./handlers.md#panel) in your plugin's JavaScript code. This identifier needs to be unique within your plugin. Don't specify `commandId` and `panelId` at the same time.
70+
`commandId` | `string` | Specify `commandId` to create a menu item that runs plugin code directly -- either a headless command, or a command with modal dialog UI. This identifier links the menu item to a [_handler function_](./handlers.md#command) in your plugin's JavaScript code. This identifier needs to be unique within your plugin. Don't specify `commandId` and `panelId` at the same time.
71+
`panelId` | `string` | Specify `panelId` to create a menu item that opens panel UI for your plugin. This identifier links the menu item to a [_panel definition object_](./handlers.md#panel) in your plugin's JavaScript code. This identifier needs to be unique within your plugin. Don't specify `commandId` and `panelId` at the same time.
7372
`shortcut` | `Object` | _Optional._ Object defining Mac and Windows keyboard shortcuts for this menu item. See "Keyboard shortcuts" below for details.
7473

7574
### Keyboard shortcuts

0 commit comments

Comments
 (0)