DocWorks for js-wixcode-sdk - 20 changes detected, but 15 issue detected

changes: Service $w.Accordion has changed description Service $w.CollapsedMixin property collapsed has changed description Service $w.CollapsedMixin operation expand has changed description Service $w.CustomClassList has changed description Service $w.Element property deleted has changed description Service $w.HiddenMixin property hidden has changed description Service $w.HiddenMixin property isVisible has changed description Service $w.HiddenMixin operation show has changed description Service $w.Image property clickAction has changed description Service $w.Image property tooltip has changed description Service $w.WixComments operation onCommentCreate.examples[0] has changed body Service $w has changed description Service site-monitoring.LogEntry has changed summary Service site-monitoring.LogEntry has changed description Service site-monitoring.LogEntry property timestamp has changed summary Service site-monitoring.LogEntry property timestamp has changed description Service site-monitoring has changed summary Service site-monitoring has changed description Service wix-window-frontend property formFactor has changed description Service wix-window property formFactor has changed description issues: Message ViewChangeEventOptions has an unknown property type * (ApppointmentFieldEvent.js (8)) Property target is missing a type annotation (GalleryNavigationStartEvent.js (15)) Operation postMessage has an unknown param type * (HtmlComponent.js (97)) Property data has an unknown type * (HtmlComponentMessageEvent.js (17)) Property fileLimit has mismatching types for get (number) and set (string) (UploadButton.js (128, 149)) Operation set has an unknown param type * (window-frontend.js (201)) Operation get has an unknown return type * (window-frontend.js (234)) Operation set has an unknown param type * (window.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOp ...
wix-incubator · Jul 31, 2024 · ca4b0fb · ca4b0fb
1 parent 117082b
commit ca4b0fb
Show file tree

Hide file tree

Showing 13 changed files with 106 additions and 84 deletions.
diff --git a/js-wixcode-sdk/$w.service.json b/js-wixcode-sdk/$w.service.json
@@ -1,6 +1,7 @@
 { "name": "$w",
   "mixes": [],
-  "labels": [],
+  "labels":
+    [ "changed" ],
   "location":
     { "lineno": 1,
       "filename": "wixCode.js" },
@@ -15,10 +16,12 @@
           "",
           " You do not need to import `$w`.",
           "",
-          " > **Note:** Most `$w` elements, nodes, and events are described here under Wix Editor Elements. Some `$w` ",
-          " elements are described in context of their functionality. For example, the [`WixForms`](wix-crm-frontend.html#$w-wixforms) ",
-          " element is described under the `wix-crm-frontend` namespace because using the API for the Wix Forms app is most relevant in the ",
-          " context of site contacts and visitors. ",
+          " > **Notes:**",
+          " > - Most `$w` elements, nodes, and events are described here under Wix Editor Elements. Some `$w`",
+          " elements are described in context of their functionality. For example, the [`WixForms`](wix-crm-frontend.html#$w-wixforms)",
+          " element is described under the `wix-crm-frontend` namespace because using the API for the Wix Forms app is most relevant in the",
+          " context of site contacts and visitors.",
+          " > - Some `$w` elements change their size dynamically, which can [affect the page layout](https://dev.wix.com/docs/develop-websites/articles/wix-editor-elements/formatting-layout/how-page-layout-is-affected-when-elements-change-size).",
           "",
           " Get hands-on experience with the `$w` API on our [Hello World](https://www.wix.com/velo/example/hello-world) example page." ],
       "links": [],
@@ -42,7 +45,7 @@
                     [ "$w.Element" ] } ],
             "doc": "A single selected element or an array of selected elements." },
         "locations":
-          [ { "lineno": 23,
+          [ { "lineno": 24,
               "filename": "wixCode.js" } ],
         "docs":
           { "summary": "Selects and returns elements from a page.",
@@ -129,7 +132,7 @@
           { "type": "$w.$w",
             "doc": "A selector function for the given context." },
         "locations":
-          [ { "lineno": 127,
+          [ { "lineno": 125,
               "filename": "wixCode.js" } ],
         "docs":
           { "summary": "Gets a selector function for a specific context.",
@@ -165,7 +168,7 @@
         "ret":
           { "type": "void" },
         "locations":
-          [ { "lineno": 72,
+          [ { "lineno": 71,
               "filename": "wixCode.js" } ],
         "docs":
           { "summary": "Sets the function that runs when all the page elements have finished loading.",

diff --git a/js-wixcode-sdk/$w/Accordion.service.json b/js-wixcode-sdk/$w/Accordion.service.json
@@ -2,14 +2,15 @@
   "memberOf": "$w",
   "mixes":
     [ "$w.Element" ],
-  "labels": [],
+  "labels":
+    [ "changed" ],
   "location":
     { "lineno": 1,
       "filename": "Accordion.js" },
   "docs":
     { "summary": "An [accordion element](https://support.wix.com/en/article/editor-x-adding-and-customizing-an-accordion-5177642#adding-and-managing-accordion-items)\nis a container that holds multiple collapsible accordion item elements.",
       "description":
-        [ "> This feature is currently only available in Wix Studio and Editor X.",
+        [ "> This feature is currently only available in Wix Studio.",
           "",
           "An accordion element holds multiple, collapsible item elements in a vertical stack,",
           "each with different content.",

diff --git a/js-wixcode-sdk/$w/CollapsedMixin.service.json b/js-wixcode-sdk/$w/CollapsedMixin.service.json
@@ -1,7 +1,8 @@
 { "name": "CollapsedMixin",
   "memberOf": "$w",
   "mixes": [],
-  "labels": [],
+  "labels":
+    [ "changed" ],
   "location":
     { "lineno": 1,
       "filename": "CollapsedMixin.js" },
@@ -36,7 +37,8 @@
         {  } },
   "properties":
     [ { "name": "collapsed",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "get": true,
         "set": false,
         "type": "boolean",
@@ -65,7 +67,7 @@
                 " + Its [parent element]($w.Node.html#parent) is hidden or collapsed.",
                 " + It is a slide in a [Slideshow]($w.Slideshow.html) which is",
                 "   currently not being displayed.",
-                " + In Editor X, it has been marked as \"Don't Display\" for the current breakpoint.",
+                " + In Wix Studio, it has been set to **Hide** in the [Layers panel](https://wix.wixanswers.com/apps/widget/v1/wix/53f85d67-f8b0-41ca-9dc8-5a16390cc74f/view/en/article/9b13ee7a-06b1-4fde-80e7-8f978d9d3195#:~:text=a%20specific%20breakpoint%3F-,Yes,-.%C2%A0You%20can%20hide) in that breakpoint. ",
                 "",
                 "",
                 " Even if the element is not displayed due to the conditions",
@@ -164,7 +166,8 @@
         "extra":
           {  } },
       { "name": "expand",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "nameParams": [],
         "params": [],
         "ret":
@@ -186,10 +189,10 @@
                 " see the [`collapsed`](#collapsed) property.",
                 "",
                 "> **Notes:** ",
-                "> + In Editor X, an element will not become visible by using `expand()` if it has been marked as \"Don't Display\" for the current breakpoint. Calling `expand()` will however, change the `collapsed` property of the element to `false`.",
+                "> + In Wix Studio, an element will not become visible by using `expand()` if it has been marked as \"Don't Display\" for the current breakpoint. Calling `expand()` will however, change the `collapsed` property of the element to `false`.",
                 "> ",
                 ">",
-                "> + It is recommended not to mix `expand()` and `collapse()` with \"Don't Display\" in Editor X." ],
+                "> + It is recommended **not** to mix `expand()` and `collapse()` with [**Hide**](https://wix.wixanswers.com/apps/widget/v1/wix/53f85d67-f8b0-41ca-9dc8-5a16390cc74f/view/en/article/9b13ee7a-06b1-4fde-80e7-8f978d9d3195#:~:text=a%20specific%20breakpoint%3F-,Yes,-.%C2%A0You%20can%20hide) and **Show** in Wix Studio." ],
             "links":
               [ "[expand( )](#expand)",
                 "[collapsed](#collapsed)",

diff --git a/js-wixcode-sdk/$w/CustomClassList.service.json b/js-wixcode-sdk/$w/CustomClassList.service.json
@@ -1,7 +1,8 @@
 { "name": "CustomClassList",
   "memberOf": "$w",
   "mixes": [],
-  "labels": [],
+  "labels":
+    [ "changed" ],
   "location":
     { "lineno": 1,
       "filename": "CustomClassList.js" },
@@ -20,7 +21,7 @@
           "see [Add CSS to your site](https://www.wix.com/velo/reference/$w/styling-elements-with-css#$w_styling-elements-with-css_add-css-to-your-site) ",
           "and [About CSS editing](https://support.wix.com/en/article/editor-x-about-css-editing). ",
           "",
-          "> **Note:** This mixin is currently only available in Editor X.  ",
+          "> **Note:** This mixin is currently only available in Wix Studio.  ",
           " ",
           "**About Mixins**",
           "",

diff --git a/js-wixcode-sdk/$w/Element.service.json b/js-wixcode-sdk/$w/Element.service.json
@@ -3,7 +3,8 @@
   "mixes":
     [ "$w.Node",
       "$w.ViewportMixin" ],
-  "labels": [],
+  "labels":
+    [ "changed" ],
   "location":
     { "lineno": 1,
       "filename": "Element.js" },
@@ -75,7 +76,8 @@
         "extra":
           {  } },
       { "name": "deleted",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "get": true,
         "set": false,
         "type": "boolean",
@@ -91,7 +93,7 @@
                 "",
                 ">**Notes:**",
                 "> - An element whose `deleted` status is `true` can be edited.",
-                "> - In Editor X, an element whose `deleted` status is `false` will not be displayed if the element has been set to \"Don't Display\"." ],
+                "> - In Wix Studio, an element whose `deleted` status is `false` will not be displayed if the element has been set to **Hide**." ],
             "links":
               [ "[collapsed]($w.HiddenCollapsedMixin.html#collapsed)",
                 "[hidden]($w.HiddenCollapsedMixin.html#hidden)",

diff --git a/js-wixcode-sdk/$w/HiddenMixin.service.json b/js-wixcode-sdk/$w/HiddenMixin.service.json
@@ -1,7 +1,8 @@
 { "name": "HiddenMixin",
   "memberOf": "$w",
   "mixes": [],
-  "labels": [],
+  "labels":
+    [ "changed" ],
   "location":
     { "lineno": 1,
       "filename": "HiddenMixin.js" },
@@ -36,7 +37,8 @@
         {  } },
   "properties":
     [ { "name": "hidden",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "get": true,
         "set": false,
         "type": "boolean",
@@ -60,7 +62,7 @@
                 " + Its [parent element]($w.Node.html#parent) is hidden or collapsed.",
                 " + It is a slide in a [Slideshow]($w.Slideshow.html) which is",
                 "   currently not being displayed.",
-                " + In Editor X, it has been marked as \"Don't Display\" for the current breakpoint.",
+                " + In Wix Studio, it has been set to **Hide** for the current breakpoint.",
                 "",
                 "",
                 " Even if the element is not displayed due to the conditions",
@@ -108,7 +110,8 @@
         "extra":
           {  } },
       { "name": "isVisible",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "get": true,
         "set": false,
         "type": "boolean",
@@ -140,7 +143,7 @@
                 ">   another element completely covers it so that a user cannot see it.",
                 ">",
                 ">",
-                "> + In Editor X, even if the `isVisible` property of the element is `true`, it will not be displayed if the element has been set to \"Don't Display\" for the current breakpoint." ],
+                "> + In Wix Studio, even if the `isVisible` property of the element is `true`, it will not be displayed if the element has been set to **Hide** for the current breakpoint in the Layers more actions menu." ],
             "links":
               [ "[hidden](#hidden)",
                 "[collapsed]($w.CollapsedMixin.html#collapsed)",
@@ -277,7 +280,8 @@
         "extra":
           {  } },
       { "name": "show",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "nameParams": [],
         "params":
           [ { "name": "effectName",
@@ -344,10 +348,10 @@
                 "",
                 "> **Notes:**",
                 ">",
-                "> + In Editor X, `show ()` will not make an element visible for a given breakpoint",
-                ">   if the element has been set to \"Don't Display\" for that breakpoint.",
-                ">   Calling `show()` will however, change the `hidden` property of the element to `false`.",
-                "> + It is recommended not to mix `show` and `hide` with \"Don't Display\" in Editor X." ],
+                "> + In Wix Studio, the `show ()` function will not make an element visible for a given breakpoint",
+                ">   if the element has been set to \"**Hide** for that breakpoint in the Layers more actions menu.",
+                ">   Calling `show()` however, will change the `hidden` property of the element to `false`.",
+                "> + It is recommended **not** to mix `show()` and `hide()` with **Hide** and **Show** in Wix Studio." ],
             "links":
               [ "[hide( )](#hide)",
                 "[hidden](#hidden)",

diff --git a/js-wixcode-sdk/$w/Image.service.json b/js-wixcode-sdk/$w/Image.service.json
@@ -6,7 +6,8 @@
       "$w.LinkableMixin",
       "$w.ClickableMixin",
       "$w.EffectsMixin" ],
-  "labels": [],
+  "labels":
+    [ "changed" ],
   "location":
     { "lineno": 1,
       "filename": "Image.js" },
@@ -61,14 +62,15 @@
         "extra":
           {  } },
       { "name": "clickAction",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "get": true,
         "set": true,
         "type": "string",
         "locations":
-          [ { "lineno": 118,
+          [ { "lineno": 117,
               "filename": "Image.js" },
-            { "lineno": 145,
+            { "lineno": 143,
               "filename": "Image.js" } ],
         "docs":
           { "summary": "Sets or gets the action that occurs when an image is clicked.",
@@ -85,8 +87,7 @@
                 "",
                 "",
                 " Getting the `clickAction` property returns what happens when",
-                " an image is clicked.",
-                "> **Note:** `expand ` and `magnified` are not supported in Editor X. [Learn more](https://support.wix.com/en/article/editor-x-adding-and-editing-images-on-your-site) about Editor X and images." ],
+                " an image is clicked." ],
             "links": [],
             "examples":
               [ { "title": "Get the action that occurs when an image is clicked",
@@ -110,9 +111,9 @@
         "type": "string",
         "defaultValue": "\"fill\"",
         "locations":
-          [ { "lineno": 152,
+          [ { "lineno": 150,
               "filename": "Image.js" },
-            { "lineno": 217,
+            { "lineno": 215,
               "filename": "Image.js" } ],
         "docs":
           { "summary": "Sets or gets how an image is placed inside an image element.",
@@ -190,9 +191,9 @@
         "type": "string",
         "defaultValue": "An empty string",
         "locations":
-          [ { "lineno": 81,
+          [ { "lineno": 80,
               "filename": "Image.js" },
-            { "lineno": 111,
+            { "lineno": 110,
               "filename": "Image.js" } ],
         "docs":
           { "summary": "Sets or gets the file location of the image.",
@@ -234,22 +235,22 @@
         "extra":
           {  } },
       { "name": "tooltip",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "get": true,
         "set": true,
         "type": "string",
         "defaultValue": "An empty string",
         "locations":
           [ { "lineno": 56,
               "filename": "Image.js" },
-            { "lineno": 74,
+            { "lineno": 73,
               "filename": "Image.js" } ],
         "docs":
           { "summary": "Sets or gets an image's tooltip.",
             "description":
               [ "An image's tooltip text is displayed when a user hovers over the image",
-                " or when the image opens in a popup.",
-                "> **Note:** `tooltip` is not supported in Editor X. [Learn more](https://support.wix.com/en/article/editor-x-adding-and-editing-images-on-your-site) about Editor X and images." ],
+                " or when the image opens in a popup." ],
             "links": [],
             "examples":
               [ { "title": "Get the image's tooltip text",

diff --git a/js-wixcode-sdk/$w/WixComments.service.json b/js-wixcode-sdk/$w/WixComments.service.json
@@ -2,7 +2,8 @@
   "memberOf": "$w",
   "mixes":
     [ "$w.Element" ],
-  "labels": [],
+  "labels":
+    [ "changed" ],
   "location":
     { "lineno": 1,
       "filename": "WixComments.js" },
@@ -189,7 +190,8 @@
         "extra":
           {  } },
       { "name": "onCommentCreate",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "nameParams": [],
         "params":
           [ { "name": "callback",
@@ -212,7 +214,7 @@
             "examples":
               [ { "title": "Add an event handler for when a new comment is created",
                   "body":
-                    [ "$w(\"#myCommentsWidget\").onCreateComment((widgetComment) => { ",
+                    [ "$w(\"#myCommentsWidget\").onCommentCreate((widgetComment) => { ",
                       "  console.log(widgetComment);",
                       "});" ],
                   "extra":