Adobe UXP Manifest 5 (SchemaStore) JSON Schema

Schema URL

https://catalog.lintel.tools/schemas/schemastore/adobe-uxp-manifest/versions/5.json

Type: object

Properties

id string required

A unique identifier for this plug-in. A globally unique ID may be obtained from Adobe's Developer Distribution portal https://developer.adobe.com/distribute/home

Examples: "3cc45790", "com.author.development.id"

name string required

The name of this plug-in. It should match the project name from Adobe's Developer Distribution portal

Examples: "My Plug-in"

version string required

The current version number of this plug-in, in the format "major.minor.patch", where "minor" and "patch" are optional

pattern=^\d{1,2}(\.\d{1,2})?(\.\d{1,2})?$

manifestVersion integer required

The version of this UXP manifest file (5)

Default: 5

Constant: 5

entrypoints object[] required

A list of commands and panels that this plug-in provides

main string

Relative path to the plug-in initialization file, which must be either a JavaScript program or an HTML document

Default: "main.js"

icons array

An icon representing the plug-in as a whole, adapted to different themes. Must be of the "pluginList" species and 24x24 in size

host object | object[]

The host program(s) this plug-in is intended to run on. An array may only be provided during development; a single host must be specified when submitting to the plug-in marketplace

requiredPermissions object

8 nested properties

network object

Allows the plug-in to access the network

1 nested properties

domains string[] | string required

A list of host names that the plug-in may send requests to, or "all"

clipboard string

Allows the plug-in to access the clipboard

Examples: "read"

One of: const: "read" const: "read", const: "readAndWrite" const: "readAndWrite"

localFileSystem string

Allows the plug-in to access the local file system

Default: "plugin"

One of: const: "plugin" const: "plugin", const: "request" const: "request", const: "fullAccess" const: "fullAccess"

launchProcess object

Allows the plug-in to launch external processes through associated schemes and file extensions

2 nested properties

schemes string[] required

A list of URI schemes that the plug-in may launch

Examples: ["http","https"], ["mailto","file"]

extensions string[] required

A list of allowed file extensions that the plug-in may launch when using the "file://" schema

Examples: ["pdf","png","jpg"]

allowCodeGenerationFromStrings boolean

Allows the plug-in to evaluate code from strings, including JavaScript eval() and HTML inline event handlers

Default: false

ipc object

Allows the plug-in to communicate with other plug-ins

Examples: {"enablePluginCommunication":true}

1 nested properties

enablePluginCommunication boolean required

Enables this permission

Default: false

webview object

This feature is only available from UXP 6.0. Allows the plug-in to use WebViews https://developer.adobe.com/photoshop/uxp/2022/guides/uxp_guide/uxp-misc/manifest-v5/#webviews

2 nested properties

allow string required

Enables this permission

Constant: "yes"

domains string[] required

A list of host names that the plug-in may request within WebViews

Examples: ["https://*.adobe.com","https://*.google.com"]

enableUserInfo boolean

This feature is only available from UXP 7.3. Allows the plug-in to identify the current user's Creative Cloud account https://developer.adobe.com/photoshop/uxp/2022/guides/uxp_guide/uxp-misc/manifest-v5/#guid

Default: false

featureFlags object

Enables specific experimental features for this plug-in https://developer.adobe.com/indesign/uxp/plugins/concepts/manifest/#featureflags

2 nested properties

enableSWCSupport boolean

Enables the usage of Spectrum Web Components as custom HTML elements https://developer.adobe.com/photoshop/uxp/2022/uxp-api/reference-spectrum/swc/

Examples: true

enableFillAsCustomAttribute boolean

Enables the usage of CSS variables (custom attributes) for the "fill" attribute in SVG elements

Examples: true

strings Record<string, object>

Specifies a set of localized strings that may be reused in other parts of the manifest file by specifying the string name as a value (for example "'label': 'my-string'"), such as panel menus and command names https://developer.adobe.com/indesign/uxp/plugins/concepts/manifest/#stringsdefinition

Examples: {"my-menu-label":{"default":"Menu Label","fr":"Etiquette de Menu","de":"Menübezeichnung"}}

Definitions

hostDefinition object

app string required

The host program

One of: Adobe Photoshop const: "PS", Adobe InDesign const: "ID", Adobe XD const: "XD"

minVersion string required

The minimum host version required to run this plug-in. At least two segments must be specified

Examples: "19.1"

pattern=^\d{1,2}\.\d{1,2}(\.\d{1,2})?$

maxVersion string

The maximum host version supported by this plug-in. At least two segments ("x.y") must be specified

Examples: "23.7.1"

pattern=^\d{1,2}\.\d{1,2}(\.\d{1,2})?$

iconDefinition object

width integer required

The icon width in logical pixels

min=1

height integer required

The icon's height in logical pixels

min=1

path string required

Relative base path of the icon files, excluding the "@1x" scale descriptor. For example, use "icons/icons.png" for the true file names "icons/[email protected]" and "icons/[email protected]"

Examples: "assets/icons/my-icon.png"

scale number[]

A list of image scales provided. The image file names must suffix the base name with "@(scale)x"; for example, "icons/[email protected]" and "icons/[email protected]" for scales [1, 2]

Default:

[
  1
]

Examples: [1,1.25,1.5,1.75,2]

minItems=1uniqueItems=true

theme string[] | array

A list of user interface themes that contrast well enough with this icon

Default:

[
  "all"
]

Examples: ["lightest","darkest"]

species array

Specifies the contexts in which this icon should be displayed

One of: const: ["generic"] const: ["generic"], const: ["toolbar"] const: ["toolbar"], const: ["pluginList"] const: ["pluginList"]

localizedString Record<string, string>

Specifies a localized text string

Examples:

{ "default": "Hello", "de": "Hallo" }
{ "default": "Menu Label", "fr": "Etiquette de Menu", "de": "Menübezeichnung" }

default string required

The default string in case the user's language is unsupported

sizeSpecifier object

width integer required

The width dimension in pixels

min=1

height integer required

The height dimension in pixels

min=1