Editor API

The Editor API enables code running within a Wix editor (for example in a settings panel) to interact with other parts of the editor. Using the API, you can access the properties of a widget on the editor canvas, retrieve data about the editor environment, and more.

Setup

To use the Editor API, install the @wix/editor package using npm or Yarn:

Copy

or

Copy

Wix-hosted apps

To use the Editor API in Wix-hosted apps, import one of the editor submodules in your code and call it's methods directly. For example:

Copy

Self-hosted apps

To use the Editor API in self-hosted apps, first create a Wix Client using one of the editor submodules. For example:

Copy

Then, use the client to call the submodule's methods. For example:

Copy
Did this help?