UXP Manifest

The manifest is a JSON file that is located at the root of the plugin bundle. It is named manifest.json and is required for all plugins.

Overview

Each UXP plugin has one manifest.json file that describes the plugin. It contains metadata such as the plugin's name, version, icons, and entry points.

The manifest file also contains the permissions that the plugin requires. Most importantly, it contains your plugin ID which is used to identify your plugin. (Valid plugin IDs are required for distributing in Adobe's Marketplace, read more in the docmentation.)

Since UXP plugins can be run in a number of different hosts, the manifest also contains a host field that specifies which host the plugin is for. This is used to identify the plugin in the manifest and in the plugin bundle.

Reference

Manifest

The object at the root of the manifest file.

data-slots=text

Example

{
	"manifestVersion": 5,
	"id": "YOUR_ID_HERE",
	"name": "Name of your plugin",
	"version": "1.0.0",
	"main": "index.html",
	"host": {
		"app": "HOST_APPLICATION",
		"minVersion": "HOST_VERSION"
	},
	"entrypoints": [
		{
			"type": "command",
			"id": "commandFn",
			"label": {
				"default": "Show A Dialog"
			}
		},
		{
			"type": "panel",
			"id": "panelName",
			"label": {
				"default": "Panel Name"
			}
		}
	],
	"icons": [
		{
			"width": 24,
			"height": 24,
			"path": "icons/icon.png",
			"scale": [
				1,
				2
			]
		}
	],
	"requiredPermissions": {
		"network": {
			"domains": "all"
		}
	}
}

data-slots=text

Properties

StringsDefinition

Represents a set of strings used to localize the plugin name and other user-facing strings.

StringsDefinition keys can be used anywhere where LocalizedString is supported.

Example

Your manifest.json file might look like this:

{
	"name": "my-plugin",
	"strings": {
		"my-plugin": {
			"default": "My Plugin",
			"de": "Mein Plugin"
		}
	}
}

LocalizedString

Represents a localized string. The key is the locale, and the value is the translated string.

Example

{
	"default": "Hello",
	"en": "Hello",
	"de": "Hallo"
}

Properties

IconDefinition

Represents an icon used by the plugin or specific entry point. The icon may be used in the plugin list, toolbar, or other places.

Properties

EntrypointDefinition

Represents an entrypoint provided by the plugin, which can be invoked by the user.

An entrypoint consists of an ID and a label at minimum.

Example

{
    "id": "myPlugin.myEntrypoint",
    "label": "My Entrypoint"
}

Properties

HostDefinition

UXP supports a number of different host applications. The host definition specifies which host app the plugin supports.

Properties

PermissionsDefinition

To ensure that plugins are secure, UXP requires that plugins declare the permissions they need to function.

data-variant=info

data-slots=heading, text

Properties

NetworkPermission

Specifies the domains that the plugin can access in network requests.

Example

{
    "domains": [
        "https://example.com",
        "https://*.adobe.com/",
        "wss://*.myplugin.com"
    ]
}

Then, in your plugin code, you can make network requests like this:

const response = await fetch("https://example.com");

Or load images like this:

<img src="https://example.com/image.png" />

You can also allow access to all domains by setting domains to "all".

{
    "domains": "all"
}

Properties

The network recipe has more details.

WebViewPermission

Enables the plugin to use webviews in its UI to display web content or complex UI.

Example

{
    "allow": "yes",
    "domains": ["https://example.com"],
    "enableMessageBridge": "localAndRemote"
}

Then, in your plugin code, you can use a webview like this:

<webview src="https://example.com" />

To communicate between the webview and the plugin, you can use the message API:

// In the plugin:
const webview = document.querySelector("webview");
webview.addEventListener("message", (event) => \{
    console.log("Received message from webview:", event.data);
    webview.postMessage("Hello from the plugin!");
\});\n
// In the webview:
window.addEventListener("message", (event) => \{
    console.log("Received message from plugin:", event.data);
    window.uxpHost.postMessage("Hello from the webview!");
\});

Properties

Find the detailed WebView API reference or use the webview-starter template plugin in UDT.

LaunchProcessPermission

Specifies the schemes and extensions that the plugin can launch.

For example, if the plugin can launch a web browser, it should specify the http and https schemes.

Example

{
    "schemes": ["http", "https"],
    "extensions": []
}

Properties

The launch process recipe has more details.

IpcPermission

Allows communication with other plugins.

Example

{
    "enablePluginCommunication": true
}

Properties

The inter-plugin communication example has more details.

FeatureFlags

Specifies which experimental features the plugin uses.

Example

{
    "enableFillAsCustomAttribute": true,
    "enableSWCSupport": true
}

Properties