@wix/editor 1.295.0 → 1.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +6 -29
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -1,34 +1,11 @@
1
- ## Editor Platform SDK
1
+ # Editor SDK
2
2
 
3
- This package contains the Editor Platform SDK, which is a set of API shapes that allow you to build custom editor apps.
3
+ This package provides an API that 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.
4
4
 
5
- ### Installation
5
+ For comprehensive documentation, refer to the official [Wix JavaScript SDK Reference](https://dev.wix.com/docs/sdk/host-modules/editor/introduction).
6
6
 
7
- ```bash
8
- yarn add @wix/editor
9
- ```
10
-
11
- ### Usage with `@wix/sdk`
12
-
13
- ```js
14
- import { editor, info, widget } from '@wix/editor';
15
- import { createClient } from '@wix/sdk';
16
-
17
- const client = createClient({
18
- host: editor.host(),
19
- modules: {
20
- info,
21
- widget,
22
- },
23
- });
24
-
25
- // --
26
- await client.widget.setProp('test', 1)
27
- console.log(await client.widget.getProp('test'));
7
+ ## Installation
28
8
 
29
- // --
30
- console.log({
31
- languageCode: await client.info.getLanguageCode(),
32
- viewMode: await client.info.getViewMode(),
33
- });
9
+ ```sh
10
+ npm install @wix/editor
34
11
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/editor",
3
- "version": "1.295.0",
3
+ "version": "1.297.0",
4
4
  "license": "UNLICENSED",
5
5
  "author": {
6
6
  "name": "Editor Platform <editor-platform-dev@wix.com>",
@@ -30,11 +30,11 @@
30
30
  "*.{js,ts}": "yarn lint"
31
31
  },
32
32
  "dependencies": {
33
- "@wix/editor-application": "1.315.0",
34
- "@wix/editor-application-context": "1.238.0",
33
+ "@wix/editor-application": "1.316.0",
34
+ "@wix/editor-application-context": "1.239.0",
35
35
  "@wix/editor-platform-transport": "1.8.0",
36
36
  "@wix/public-editor-platform-errors": "1.8.0",
37
- "@wix/public-editor-platform-interfaces": "1.2.0"
37
+ "@wix/public-editor-platform-interfaces": "1.3.0"
38
38
  },
39
39
  "devDependencies": {
40
40
  "@rollup/plugin-node-resolve": "^15.2.3",
@@ -58,5 +58,5 @@
58
58
  ]
59
59
  }
60
60
  },
61
- "falconPackageHash": "28be0dc84ce3547d2f7800ff3eb38c7405ee95769a5f236e2471fac9"
61
+ "falconPackageHash": "fd19c05e875ee295def4f844239f1b3346b89dc074de56fb951fe837"
62
62
  }