UXP Manifest

The Manifest file is a JSON file located at the root of the plugin bundle that contains metadata about the plugin.

Overview

Each UXP plugin must have one manifest.json file that the host application uses to load and manage the plugin. In addition to core metadata such as the plugin's name, version, icons, and entry points, the manifest specifies permissions, compatibility details, and other definitions that shape how the plugin integrates with the host environment.

Most importantly, it contains your plugin ID, which uniquely identifies your plugin when it's installed in the host application. Valid plugin IDs are required for distributing in Adobe's Marketplace—read more in the Developer Distribution documentation.

Manifest Keys

Example

Copy
{
    "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"
        }
    }
}
Copied to your clipboard
{
    "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"
        }
    }
}

Required properties

manifestVersion

Indicates the version of the manifest schema. Premiere supports version "5".

id

Uniquely identifies a plugin and is used to disambiguate plugin contexts, storage, errors, etc. For plugins distributed through the plugin marketplace, the id has to match the one set in the Developer Distribution portal.

name

Visually identifies the plugin in the user interface. It is usually used in a plugin menu listing or launcher for top-level action items. The name can be a string, a key from the StringsDefinition object, or a localized string.

version

Indicates the plugin's version. The string has a format of major.minor.patch.

host

The host object indicates the plugin's compatibility with the host. Incompatible plugins will:

• fail to install if attempted in the given host
• be invisible in the in-app plugin marketplace for the given host
• be unavailable for update if the update is no longer compatible.

Check the HostDefinition section for more details.

entrypoints

This array defines the entrypoints that the plugin provides; currently, only Commands and Panels are supported. Check the EntrypointDefinition section for more details.

Optional properties

main

Indicates the primary JavaScript or HTML file, relative to the plugin's installation directory. It supports HTML and JS files, such as index.html and index.js. If not specified (for deprecations), main.js is used.

icons

An array of icons representing the overall plugin or panel icon. The host application uses these icons to present the plugin to the user. If the icons array is missing, a default icon will be used. See the IconDefinition section for more details.

strings

A set of strings used to localize the plugin name and other user-facing strings. It can also be a path to a JSON file containing them. See the StringsDefinition section for more details.

requiredPermissions

Indicates the various permissions this plugin requires before accessing certain API surfaces. Without them, access may fail or throw an error. Users will be asked for their consent when your plugin attempts to use openExternal(), openPath(), and <sp-link> anchor tags. For everything else, it is given at install time. See the PermissionsDefinition section for more details.

featureFlags

A set of feature flags that can be used to enable or disable certain features of the plugin. These flags are used to gate features that are not yet ready for general availability. See the FeatureFlags section for more details.

addon

Addon definitions for hybrid plugins. A UXP Hybrid plugin is a UXP plugin that can access the power of C++ native libraries.

Supporting Definitions

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.

Copy
{
  "name": "my-plugin",
    "strings": {
      "my-plugin": {
        "default": "My Plugin",
        "it": "Il mio Plugin",
        "fr": "Mon Plugin"
      }
  }
}
Copied to your clipboard
{
  "name": "my-plugin",
    "strings": {
      "my-plugin": {
        "default": "My Plugin",
        "it": "Il mio Plugin",
        "fr": "Mon Plugin"
      }
  }
}

LocalizedString

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

Copy
{
  "default": "Settings",
  "it": "Impostazioni",
  "fr": "Paramètres"
}
Copied to your clipboard
{
  "default": "Settings",
  "it": "Impostazioni",
  "fr": "Paramètres"
}

Required Properties

The default string used when no translation is available for the current locale.

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

width

The width of the icon in pixels.

height

The height of the icon in pixels.

path

The path to the icon, relative to the plugin's installation directory. Supports PNG (.png), JPG (.jpg or .jpeg), and SVG (.svg) files.

scale

Specifies the scaling factors that the icon supports.

Copy
{
    "path": "icon.png",
    "width": 24,
    "height": 24,
    "scale": [1, 2, 2.5]
}
Copied to your clipboard
{
    "path": "icon.png",
    "width": 24,
    "height": 24,
    "scale": [1, 2, 2.5]
}

Results in the following icon files being used (if available):

• icon.png or icon@1x.png (24x24px) for 100% scaling
• icon@2x.png (48x48px) for 200% scaling
• icon@2.5x.png (60x60px) for 250% scaling

theme

Specifies the themes that the icon supports. Available themes in UXP are: "all" (default), "lightest", "light", "medium", "dark", "darkest".

Copy
{
    "path": "icon-light.png",
    "width": 24,
    "height": 24,
    "theme": ["lightest", "light"]
},
{
    "path": "icon-dark.png",
    "width": 24,
    "height": 24,
    "theme": ["darkest", "dark"]
}
Copied to your clipboard
{
    "path": "icon-light.png",
    "width": 24,
    "height": 24,
    "theme": ["lightest", "light"]
},
{
    "path": "icon-dark.png",
    "width": 24,
    "height": 24,
    "theme": ["darkest", "dark"]
}

species

Specifies the species that the icon supports. Indicates the suitable use of this icon. Available species are:

• "generic": suitable for display anywhere
• "toolbar": suitable for display in a toolbar. Icon sizes are 23x23px for 100% scaling and 46x46px for 200% scaling.
• "pluginList": suitable for display in a plugin list. Icon sizes are 24x24px for 100% scaling and 48x48px for 200% scaling.

EntrypointDefinition

Represents an entrypoint that the plugin provides. An entrypoint is a point of entry for the plugin. It is used to identify the code that implements the entrypoint.

Properties

type

The type of entrypoint. Currently, only Commands and Panels are supported.

id

The ID of the entrypoint. This ID must be unique within the plugin. It is used to identify the code that implements the entrypoint.

label

The label of the entrypoint. This label is used to display the entrypoint to the user, such as in the plugin menu.

description

A description of the entrypoint. This description is used in tooltips and other places where a longer description is appropriate, depending on the host app. Default value is the plugin's name.

shortcut

A keyboard shortcut that can be used to invoke the entrypoint. They are specified separately for Windows and macOS platforms. If the shortcut is not available in the host application, it will be ignored.

Copy
"shortcut": {
    "mac": "Cmd+Shift+P",
    "win": "Ctrl+Shift+P"
}
Copied to your clipboard
"shortcut": {
    "mac": "Cmd+Shift+P",
    "win": "Ctrl+Shift+P"
}

Keyboard shortcuts are defined separately for each platform. Each definition is a string that follows this syntax:

• One or more modifier keys, in any order, each one followed by +.
• Mac: modifiers may be Cmd, Ctrl, Opt/Alt, or Shift. The shortcut must contain at least one of Cmd or Ctrl.
• Win: modifiers may be Ctrl, Alt, or Shift. The shortcut must contain Ctrl.
• A letter or number key.

Letters are case-insensitive (e.g., "Cmd+P" and "Cmd+p" mean the same thing and neither requires pressing Shift). Other keys (including punctuation, arrow keys, or F1-F12) are currently not supported.

icon

An icon specific to the entrypoint. If specified, this icon overrides the plugin icon in places where the entrypoint is specifically displayed. Default value is the plugin icon.

minimumSize and maximumSize

Indicates the desired minimum and maximum size of the panel, defined by width and height in pixels, although the host application may not be able to honor them. When not specified, default values will be used.

Panel size can be locked to a specific size by setting minimumSize equal to maximumSize.

preferredDockedSize and preferredFloatingSize

Indicates the preferred size of the panel when docked (for panels or modal dialogs without a reference_node_id) or floating. The host application may not be able to honor them. When not specified, default values will be used.

HostDefinition

Represents the host application that the plugin is compatible with.

Properties

app

The host app that the plugin supports. Possible values are:

• "PS": Adobe Photoshop
• "ID": Adobe InDesign
• "premierepro": Adobe Premiere
• "XD": Adobe XD

minVersion

The minimum version of the host app that the plugin supports in the x.y.z format.

maxVersion

The maximum version of the host app that the plugin supports in the x.y.z format. Default value is the latest version of the host app.

PermissionsDefinition

To ensure that plugins are secure, UXP requires that plugins declare the permissions they need to function. Permissions not explicitly declared will be denied by default.

Properties

clipboard

Enables the plugin to read and write to the clipboard. The clipboard recipe has more examples.

• read: enables the plugin to read from the clipboard.
• readAndWrite: enables the plugin to read from and write to the clipboard.

Default value is undefined (no clipboard access).

localFileSystem

Enables the plugin to access the filesystem. The Filesystem Operations recipe has detailed examples.

• "plugin": enables the plugin to access the filesystem in the plugin folders (the plugin's installation directory, data folder, and temporary folder).
• "request": enables the plugin to request access to the filesystem.
• "fullAccess": enables the plugin to access the filesystem without requesting access.

Default value is "plugin".

network

Enables the plugin to access the network—for example, to make HTTP requests (XHR, fetch, etc.), load images (<img src="" />), etc.

• "all": enables the plugin to access all domains.
• "domains": enables the plugin to access the specified domains.

Default value is undefined (no network access). See the NetworkPermission section for more details, or the network recipe for examples.

webview

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

Default value is undefined (no webview usage). See the WebviewPermission section for more Details.

launchProcess

Enables the plugin to launch processes using APIs like require("uxp").shell.openPath() or shell.openExternal().

Default value is undefined (no process launching). See the LaunchProcessPermission section for more details and the launch process recipe for examples.

allowCodeGenerationFromStrings

Enables the plugin to generate code from strings. You will need this while using inline event handlers for HTML elements, eval(), and new Function() syntax.

Default value is false.

enableUserInfo

Enables the plugin to access the user's anonymized GUID information. Default value is false.

Copy
// set "enableUserInfo" to true in the manifest

let userId = require('uxp').userInfo.userId(); // Get the GUID of user
console.log(userId);
// "dad8483a3682a0c3e0fa990281142353901a69fc371254edde8b7dd38ca604c6"
Copied to your clipboard
// set "enableUserInfo" to true in the manifest

let userId = require('uxp').userInfo.userId(); // Get the GUID of user
console.log(userId);
// "dad8483a3682a0c3e0fa990281142353901a69fc371254edde8b7dd38ca604c6"

ipc

Enables the plugin to communicate with other plugins.

Default value is undefined (no IPC). See the IpcPermission section for more details.

NetworkPermission

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

Copy
{
  "domains": [
    "https://example.com",
    "https://*.adobe.com/",
    "wss://*.myplugin.com"
  ]
}
Copied to your clipboard
{
  "domains": [
    "https://example.com",
    "https://*.adobe.com/",
    "wss://*.myplugin.com"
  ]
}

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

Copy
const response = await fetch("https://example.com");
Copied to your clipboard
const response = await fetch("https://example.com");

Or load images like this:

Copy
<img src="https://example.com/image.png" />
Copied to your clipboard
<img src="https://example.com/image.png" />

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

Copy
{
  "domains": "all"
}
Copied to your clipboard
{
  "domains": "all"
}

The network recipe has more details.

WebviewPermission

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

Copy
{
  "allow": "yes",
  "domains": ["https://example.com"],
  "enableMessageBridge": "localAndRemote"
}
Copied to your clipboard
{
  "allow": "yes",
  "domains": ["https://example.com"],
  "enableMessageBridge": "localAndRemote"
}

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

Copy
<webview src="https://example.com" />
Copied to your clipboard
<webview src="https://example.com" />

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

Copy
// 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!");
});

// In the webview:
window.addEventListener("message", (event) => {
  console.log("Received message from plugin:", event.data);
  window.uxpHost.postMessage("Hello from the webview!");
});
Copied to your clipboard
// 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!");
});

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

allow

Must be set to "yes" to enable webviews.

domains

The domains that the plugin can access. Can be a list of domains, or the string "all" to allow access to all domains.

enableMessageBridge

Specifies whether the plugin can communicate with the webview using the message API.

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.

Copy
{
  "schemes": ["http", "https"],
  "extensions": ["pdf"]
}
Copied to your clipboard
{
  "schemes": ["http", "https"],
  "extensions": ["pdf"]
}

schemes

A set of schemes that the plugin can launch, for example ["http", "https", "mailto"].

extensions

A set of extensions that the plugin can launch, for example ["pdf", "png", "jpg"]. Only relevant for local files (using the file:// schema).

The launch process recipe has more details.

IpcPermission

Specifies the IPC channels that the plugin can use.

Copy
{
  "enablePluginCommunication": true
}
Copied to your clipboard
{
  "enablePluginCommunication": true
}

enablePluginCommunication

Enables the plugin to communicate with other plugins. The inter plugin communication tutorial has more details.

FeatureFlags

Specifies which experimental features the plugin can use.

Copy
{
  "enableFillAsCustomAttribute": true,
  "enableSWCSupport": true,
  "enableAlerts": true
}
Copied to your clipboard
{
  "enableFillAsCustomAttribute": true,
  "enableSWCSupport": true,
  "enableAlerts": true
}

Properties

enableFillAsCustomAttribute

Enables the plugin to use CSS variable in the fill attribute on SVG elements.

Copy
<svg width="100" height="100">
  <rect width="100" height="100"
        fill="var(--iconColor, red)"
  />
</svg>
Copied to your clipboard
<svg width="100" height="100">
  <rect width="100" height="100"
        fill="var(--iconColor, red)"
  />
</svg>

With the following CSS:

Copy
:root {
  --iconColor: blue;
}
Copied to your clipboard
:root {
  --iconColor: blue;
}

enableSWCSupport

Enables the plugin to use Spectrum Web Components. Requires installing and importing the components separately.

Copy
<sp-button variant="primary">
    Click me
</sp-button>
Copied to your clipboard
<sp-button variant="primary">
    Click me
</sp-button>

Note that you will need to manually install the library (via npm or yarn), import the components (for example, import '@spectrum-web-components/button/sp-button.js'), and bundle the code with a tool like Webpack or Esbuild so that it's included in your plugin.

enableAlerts

Enable the plugin to use create simple dialogs via alert(), prompt() and confirm()

Last updated 11/10/2025

Was this helpful?

Yes

No