From 9389a4d4b90fc12138d6dc7408477a9bdc60cf4f Mon Sep 17 00:00:00 2001 From: ryangec Date: Mon, 15 Apr 2024 17:12:45 +0300 Subject: [PATCH] DocWorks for js-wixcode-sdk - 8 changes detected, but 14 issue detected changes: Service $w.Button property label.examples[0] has changed body Service $w.Menu has changed description Service $w.MenuContainer property menuItems was removed Service $w.MenuContainer operation onItemClick was removed Service $w.MenuContainer operation onItemDblClick was removed Service $w.MenuContainer operation onItemMouseIn was removed Service $w.MenuContainer operation onItemMouseOut was removed Service $w.MenuContainer message MenuItem was removed issues: Message ViewChangeEventOptions has an unknown property type * (ApppointmentFieldEvent.js (8)) Operation postMessage has an unknown param type * (HtmlComponent.js (97)) Property data has an unknown type * (HtmlComponentMessageEvent.js (16)) 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 ViewChangeOperation is defined two or more times (AppointmentField.js (347), DatePicker.js (472)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Callback ViewChangeEventHandler is defined two or more times (AppointmentField.js (362), DatePicker.js (466)) Callback Validator has an unknown param type * (ValidatableMixin.js (143)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) --- js-wixcode-sdk/$w.service.json | 4 ++-- js-wixcode-sdk/$w/Button.service.json | 8 ++++--- js-wixcode-sdk/$w/Image.service.json | 9 +++----- js-wixcode-sdk/$w/Menu.service.json | 11 +++++----- js-wixcode-sdk/$w/MenuContainer.service.json | 21 ++++++++++++------- .../$w/MenuItemMouseEvent.service.json | 18 ++++++++-------- .../wix-window-frontend.service.json | 6 ++---- .../ConsentPolicy.service.json | 6 ++---- .../wix-window/ConsentPolicy.service.json | 6 ++---- 9 files changed, 45 insertions(+), 44 deletions(-) diff --git a/js-wixcode-sdk/$w.service.json b/js-wixcode-sdk/$w.service.json index 9eae3cdab5..b4fc98bc23 100644 --- a/js-wixcode-sdk/$w.service.json +++ b/js-wixcode-sdk/$w.service.json @@ -1,4 +1,4 @@ -{"name": "$w", +{ "name": "$w", "mixes": [], "labels": [], "location": @@ -948,4 +948,4 @@ { "title": "Elements in a repeater have the same ID for each repeater item. So how do I select an element in a specific repeater item?", "markdown": "You can get an element from a specific repeater item by using the [`at()`](https://www.wix.com/code/reference/$w.html#at) function. You pass the function a [`context`](https://www.wix.com/code/reference/$w.Event.html#context) from an event handler's `event` property. The function returns a selector function that selects elements from the same item that triggered the event whose context you passed it. You can then use that selector to select the specific element you want." }, { "title": "Why are my $w() selections not working?", - "markdown": "You can only select page elements using [`$w()`](https://www.wix.com/velo/reference/$w.html#$w) when the page is ready. If you use [`$w()`](https://www.wix.com/velo/reference/$w.html#$w) in code that runs before the page is ready, like global page code, the page elements are not ready to be selected. Use [`$w()`](https://www.wix.com/velo/reference/$w.html#$w) to select elements in the [`onReady()`](https://www.wix.com/velo/reference/$w.html#onReady) event handler, element event handlers, or any functions called by the above. \n\nAlso, be sure to check your selection syntax is correct. When selecting individual elements, make sure you have the proper ID and include a hash. For example: `$w(\"#myElement\")`. When selecting elements by type, make sure you have the proper type name and don't include a hash or `$w.` before the type name. For example: `$w(\"Text\")`. " } ] } + "markdown": "You can only select page elements using [`$w()`](https://www.wix.com/velo/reference/$w.html#$w) when the page is ready. If you use [`$w()`](https://www.wix.com/velo/reference/$w.html#$w) in code that runs before the page is ready, like global page code, the page elements are not ready to be selected. Use [`$w()`](https://www.wix.com/velo/reference/$w.html#$w) to select elements in the [`onReady()`](https://www.wix.com/velo/reference/$w.html#onReady) event handler, element event handlers, or any functions called by the above. \n\nAlso, be sure to check your selection syntax is correct. When selecting individual elements, make sure you have the proper ID and include a hash. For example: `$w(\"#myElement\")`. When selecting elements by type, make sure you have the proper type name and don't include a hash or `$w.` before the type name. For example: `$w(\"Text\")`. " } ] } \ No newline at end of file diff --git a/js-wixcode-sdk/$w/Button.service.json b/js-wixcode-sdk/$w/Button.service.json index 0458d1f139..01840de3ab 100644 --- a/js-wixcode-sdk/$w/Button.service.json +++ b/js-wixcode-sdk/$w/Button.service.json @@ -9,7 +9,8 @@ "$w.StyleMixin", "$w.LabelMixin", "$w.EffectsMixin" ], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "Button.js" }, @@ -131,7 +132,8 @@ "extra": { } }, { "name": "label", - "labels": [], + "labels": + [ "changed" ], "get": true, "set": true, "type": "string", @@ -147,7 +149,7 @@ "examples": [ { "title": "Get a button's label", "body": - [ "let buttonLabel = $w(\"#myButton\").label; // \"Submit\"" ], + [ "let buttonLabel = $w(\"#mobileButton1\").label; // \"Submit\"" ], "extra": { } }, { "title": "Set a button's label", diff --git a/js-wixcode-sdk/$w/Image.service.json b/js-wixcode-sdk/$w/Image.service.json index 3c5a084e04..c342bcca02 100644 --- a/js-wixcode-sdk/$w/Image.service.json +++ b/js-wixcode-sdk/$w/Image.service.json @@ -6,8 +6,7 @@ "$w.LinkableMixin", "$w.ClickableMixin", "$w.EffectsMixin" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "Image.js" }, @@ -105,8 +104,7 @@ "extra": { } }, { "name": "fitMode", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": true, "type": "string", @@ -186,8 +184,7 @@ "extra": { } }, { "name": "src", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": true, "type": "string", diff --git a/js-wixcode-sdk/$w/Menu.service.json b/js-wixcode-sdk/$w/Menu.service.json index 03486bd1f6..1c865dcc44 100644 --- a/js-wixcode-sdk/$w/Menu.service.json +++ b/js-wixcode-sdk/$w/Menu.service.json @@ -3,7 +3,8 @@ "mixes": [ "$w.Element", "$w.HiddenCollapsedMixin" ], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "Menu.js" }, @@ -26,7 +27,7 @@ " | Horizontal menus | Yes | Up to 2 additional levels (see note below) |", " | Vertical menus | Yes | Up to 1 additional level |", " | Drop-down menus | Yes | Up to 1 additional level |", - " | [Mobile menus](/$w/menucontainer) | Yes | Up to 1 additional level |", + " | Mobile menus | Yes | Up to 1 additional level |", "", " > **Note:** To have the option for 2 additional submenus available, you must first set ", " your horizontal menu as an advanced menu. To set as an advanced menu, ", @@ -218,7 +219,7 @@ { "type": "$w.Menu.MenuItem", "doc": "The menu item on which the event is now registered." }, "locations": - [ { "lineno": 79, + [ { "lineno": 49, "filename": "menuItemMouseEvents.js" } ], "docs": { "summary": "Adds an event handler that runs when a user clicks a menu item.", @@ -247,7 +248,7 @@ { "type": "$w.Menu.MenuItem", "doc": "The menu item on which the event is now registered." }, "locations": - [ { "lineno": 103, + [ { "lineno": 62, "filename": "menuItemMouseEvents.js" } ], "docs": { "summary": "Adds an event handler that runs when a user double clicks a menu item.", @@ -321,7 +322,7 @@ { "type": "$w.Menu.MenuItem", "doc": "The menu item on which the event is now registered." }, "locations": - [ { "lineno": 49, + [ { "lineno": 34, "filename": "menuItemMouseEvents.js" } ], "docs": { "summary": "Adds an event handler that runs when a user stops hovering over a menu item.", diff --git a/js-wixcode-sdk/$w/MenuContainer.service.json b/js-wixcode-sdk/$w/MenuContainer.service.json index bcc0e84c8c..26de68c9ef 100644 --- a/js-wixcode-sdk/$w/MenuContainer.service.json +++ b/js-wixcode-sdk/$w/MenuContainer.service.json @@ -2,7 +2,8 @@ "memberOf": "$w", "mixes": [ "$w.Element" ], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "MenuContainer.js" }, @@ -22,7 +23,8 @@ { } }, "properties": [ { "name": "menuItems", - "labels": [], + "labels": + [ "removed" ], "get": true, "set": true, "type": @@ -194,7 +196,8 @@ "extra": { } }, { "name": "onItemClick", - "labels": [], + "labels": + [ "removed" ], "nameParams": [], "params": [ { "name": "handler", @@ -223,7 +226,8 @@ "extra": { "eventType": "ItemMouseClick" } }, { "name": "onItemDblClick", - "labels": [], + "labels": + [ "removed" ], "nameParams": [], "params": [ { "name": "handler", @@ -252,7 +256,8 @@ "extra": { "eventType": "ItemMouseDblClick" } }, { "name": "onItemMouseIn", - "labels": [], + "labels": + [ "removed" ], "nameParams": [], "params": [ { "name": "handler", @@ -297,7 +302,8 @@ "extra": { "eventType": "ItemMouseIn" } }, { "name": "onItemMouseOut", - "labels": [], + "labels": + [ "removed" ], "nameParams": [], "params": [ { "name": "handler", @@ -417,7 +423,8 @@ "optional": true } ], "extra": { }, - "labels": [] } ], + "labels": + [ "removed" ] } ], "extra": { "queryable": true }, "relatedGuides": diff --git a/js-wixcode-sdk/$w/MenuItemMouseEvent.service.json b/js-wixcode-sdk/$w/MenuItemMouseEvent.service.json index 6166c1a422..d477e81e10 100644 --- a/js-wixcode-sdk/$w/MenuItemMouseEvent.service.json +++ b/js-wixcode-sdk/$w/MenuItemMouseEvent.service.json @@ -21,7 +21,7 @@ "set": false, "type": "number", "locations": - [ { "lineno": 215, + [ { "lineno": 163, "filename": "menuItemMouseEvents.js" } ], "docs": { "summary": "Gets the distance in pixels between the pointer and the\n left edge of the browser's viewable area.", @@ -61,7 +61,7 @@ "set": false, "type": "number", "locations": - [ { "lineno": 235, + [ { "lineno": 183, "filename": "menuItemMouseEvents.js" } ], "docs": { "summary": "Gets the distance in pixels between the pointer and the\n top edge of the browser's viewable area.", @@ -101,7 +101,7 @@ "set": false, "type": "$w.Menu.MenuItem", "locations": - [ { "lineno": 127, + [ { "lineno": 75, "filename": "menuItemMouseEvents.js" } ], "docs": { "summary": "The menu item on which the event occurred.", @@ -133,7 +133,7 @@ "set": false, "type": "number", "locations": - [ { "lineno": 255, + [ { "lineno": 203, "filename": "menuItemMouseEvents.js" } ], "docs": { "summary": "Gets the distance in pixels between the pointer and the\n left edge of the element that triggered this event.", @@ -170,7 +170,7 @@ "set": false, "type": "number", "locations": - [ { "lineno": 273, + [ { "lineno": 221, "filename": "menuItemMouseEvents.js" } ], "docs": { "summary": "Gets the distance in pixels between the pointer and the\n top edge of the element that triggered this event.", @@ -207,7 +207,7 @@ "set": false, "type": "number", "locations": - [ { "lineno": 139, + [ { "lineno": 87, "filename": "menuItemMouseEvents.js" } ], "docs": { "summary": "Gets the distance in pixels between the pointer and the\n left edge of the page.", @@ -246,7 +246,7 @@ "set": false, "type": "number", "locations": - [ { "lineno": 158, + [ { "lineno": 106, "filename": "menuItemMouseEvents.js" } ], "docs": { "summary": "Gets the distance in pixels between the pointer and the\n top edge of the page.", @@ -285,7 +285,7 @@ "set": false, "type": "number", "locations": - [ { "lineno": 177, + [ { "lineno": 125, "filename": "menuItemMouseEvents.js" } ], "docs": { "summary": "Gets the distance in pixels between the pointer and the\n left edge of the screen or screens.", @@ -324,7 +324,7 @@ "set": false, "type": "number", "locations": - [ { "lineno": 196, + [ { "lineno": 144, "filename": "menuItemMouseEvents.js" } ], "docs": { "summary": "Gets the distance in pixels between the pointer and the\n top edge of the screen or screens.", diff --git a/js-wixcode-sdk/wix-window-frontend.service.json b/js-wixcode-sdk/wix-window-frontend.service.json index 639fb90aa9..8d1799a990 100644 --- a/js-wixcode-sdk/wix-window-frontend.service.json +++ b/js-wixcode-sdk/wix-window-frontend.service.json @@ -1,7 +1,6 @@ { "name": "wix-window-frontend", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "window-frontend.js" }, @@ -273,8 +272,7 @@ "extra": { } }, { "name": "viewMode", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": false, "type": "string", diff --git a/js-wixcode-sdk/wix-window-frontend/ConsentPolicy.service.json b/js-wixcode-sdk/wix-window-frontend/ConsentPolicy.service.json index 727f286fc1..99cb51b86f 100644 --- a/js-wixcode-sdk/wix-window-frontend/ConsentPolicy.service.json +++ b/js-wixcode-sdk/wix-window-frontend/ConsentPolicy.service.json @@ -1,8 +1,7 @@ { "name": "ConsentPolicy", "memberOf": "wix-window-frontend", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1251, "filename": "window-frontend.js" }, @@ -73,8 +72,7 @@ "extra": { } }, { "name": "onConsentPolicyChanged", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "handler", diff --git a/js-wixcode-sdk/wix-window/ConsentPolicy.service.json b/js-wixcode-sdk/wix-window/ConsentPolicy.service.json index 15dd576f8c..78dceb0cbc 100644 --- a/js-wixcode-sdk/wix-window/ConsentPolicy.service.json +++ b/js-wixcode-sdk/wix-window/ConsentPolicy.service.json @@ -1,8 +1,7 @@ { "name": "ConsentPolicy", "memberOf": "wix-window", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1325, "filename": "window.js" }, @@ -80,8 +79,7 @@ "extra": { } }, { "name": "onConsentPolicyChanged", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "handler",