Plugin Lifecycle events

You can detect whether or not your plugin panel is visible with the help of UXP APIs

IMPORTANT

This is only applicable to plugins with a panel. You cannot detect the execution of a command plugin via these hooks. Familiarize yourself with plugin entrypoints to know the difference between a command and a panel plugin.

Also, for plugins that have multiple panels, you cannot differentiate between them, at present.

Example

JavaScript

manifest

const entrypoints = require("uxp").entrypoints;

entrypoints.setup({
  panels: {
    starterpanel: {
      create: async (rootNode) => {
        console.log('Plugin panel created');
      },
      destroy: async (rootNode) => {
        console.log('Destroy panel');
      }
    }
  }
});
Copied to your clipboard
const entrypoints = require("uxp").entrypoints;

entrypoints.setup({
  panels: {
    starterpanel: {
      create: async (rootNode) => {
        console.log('Plugin panel created');
      },
      destroy: async (rootNode) => {
        console.log('Destroy panel');
      }
    }
  }
});

{
  /**/
  "entrypoints": [{
      "type": "panel",
      "id": "mainPanel",
      "label": "My plugin",
      "minimumSize": {
          "width": 400,
          "height": 400
      },
      "maximumSize": {
          "width": 800,
          "height": 800
      },
      "preferredDockedSize": {
          "width": 400,
          "height": 400
      },
      "preferredFloatingSize": {
          "width": 600,
          "height": 600
      }
  }]
}
Copied to your clipboard
{
  /**/
  "entrypoints": [{
      "type": "panel",
      "id": "mainPanel",
      "label": "My plugin",
      "minimumSize": {
          "width": 400,
          "height": 400
      },
      "maximumSize": {
          "width": 800,
          "height": 800
      },
      "preferredDockedSize": {
          "width": 400,
          "height": 400
      },
      "preferredFloatingSize": {
          "width": 600,
          "height": 600
      }
  }]
}

Adding command entrypoints

Communicate with other plugins

Last updated 11/26/2024

Was this helpful?

Yes