addOnUISdk.instance.manifest

The manifest object provides access to the manifest.json file entries of the add-on.

Type

object (specific type Record)

Please see the Manifest Schema Reference for the whole list of properties and types that can be specified in the manifest.json for your add-on.

Example Usage

Below is an example of using the manifest object, along with the expected output.

data-slots=heading, code
data-repeat=2

JavaScript

import addOnUISdk from "https://express.adobe.com/static/add-on-sdk/sdk.js";

addOnUISdk.ready.then(() => {
  console.log(JSON.stringify(addOnUISdk.instance.manifest));

  console.log("Name: " + manifest["name"]);
  console.log("Test ID " + manifest["testId"]);
  console.log("Version " + manifest["version"]);
  console.log("Manifest Version " + manifest["manifestVersion"]);
  for (const app of manifest["requirements"]["apps"]) {
    console.log("Requirements -> Apps " + JSON.stringify(app));
  }
  for (const entryPoint of manifest["entryPoints"]) {
    console.log("Entry Point Type " + entryPoint["type"]);
    console.log("Entry Point ID " + entryPoint["id"]);
    console.log("Entry Point main " + entryPoint["main"]);
  }
});

Output

{"testId":"08f4469f-7999-458b-9ef9-b1bd043cbdca","name":"Add On Api Sampler","version":"1.0.0","manifestVersion":2,"requirements":{"apps":[{"name":"Express","apiVersion":1}]},"entryPoints":[{"type":"panel","id":"panel1","main":"https://localhost:5241/08f4469f-7999-458b-9ef9-b1bd043cbdca/index.html"}]}

Name: Add On Api Sampler
Test ID 08f4469f-7999-458b-9ef9-b1bd043cbdca
Version 1.0.0
Manifest Version 2
Requirements -> Apps {"name":"Express","apiVersion":1}
Entry Point Type panel
Entry Point ID panel1
Entry Point main https://localhost:5241/08f4469f-7999-458b-9ef9-b1bd043cbdca/index.html