Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DocWorks for js-wixcode-sdk - 8 changes detected, but 14 issue detected #2920

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions js-wixcode-sdk/$w.service.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{"name": "$w",
{ "name": "$w",
"mixes": [],
"labels": [],
"location":
Expand Down Expand Up @@ -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\")`. " } ] }
8 changes: 5 additions & 3 deletions js-wixcode-sdk/$w/Button.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
"$w.StyleMixin",
"$w.LabelMixin",
"$w.EffectsMixin" ],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "Button.js" },
Expand Down Expand Up @@ -131,7 +132,8 @@
"extra":
{ } },
{ "name": "label",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": true,
"type": "string",
Expand All @@ -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",
Expand Down
9 changes: 3 additions & 6 deletions js-wixcode-sdk/$w/Image.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@
"$w.LinkableMixin",
"$w.ClickableMixin",
"$w.EffectsMixin" ],
"labels":
[ "changed" ],
"labels": [],
"location":
{ "lineno": 1,
"filename": "Image.js" },
Expand Down Expand Up @@ -105,8 +104,7 @@
"extra":
{ } },
{ "name": "fitMode",
"labels":
[ "changed" ],
"labels": [],
"get": true,
"set": true,
"type": "string",
Expand Down Expand Up @@ -186,8 +184,7 @@
"extra":
{ } },
{ "name": "src",
"labels":
[ "changed" ],
"labels": [],
"get": true,
"set": true,
"type": "string",
Expand Down
11 changes: 6 additions & 5 deletions js-wixcode-sdk/$w/Menu.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
"mixes":
[ "$w.Element",
"$w.HiddenCollapsedMixin" ],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "Menu.js" },
Expand All @@ -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, ",
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down
21 changes: 14 additions & 7 deletions js-wixcode-sdk/$w/MenuContainer.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
"memberOf": "$w",
"mixes":
[ "$w.Element" ],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "MenuContainer.js" },
Expand All @@ -22,7 +23,8 @@
{ } },
"properties":
[ { "name": "menuItems",
"labels": [],
"labels":
[ "removed" ],
"get": true,
"set": true,
"type":
Expand Down Expand Up @@ -194,7 +196,8 @@
"extra":
{ } },
{ "name": "onItemClick",
"labels": [],
"labels":
[ "removed" ],
"nameParams": [],
"params":
[ { "name": "handler",
Expand Down Expand Up @@ -223,7 +226,8 @@
"extra":
{ "eventType": "ItemMouseClick" } },
{ "name": "onItemDblClick",
"labels": [],
"labels":
[ "removed" ],
"nameParams": [],
"params":
[ { "name": "handler",
Expand Down Expand Up @@ -252,7 +256,8 @@
"extra":
{ "eventType": "ItemMouseDblClick" } },
{ "name": "onItemMouseIn",
"labels": [],
"labels":
[ "removed" ],
"nameParams": [],
"params":
[ { "name": "handler",
Expand Down Expand Up @@ -297,7 +302,8 @@
"extra":
{ "eventType": "ItemMouseIn" } },
{ "name": "onItemMouseOut",
"labels": [],
"labels":
[ "removed" ],
"nameParams": [],
"params":
[ { "name": "handler",
Expand Down Expand Up @@ -417,7 +423,8 @@
"optional": true } ],
"extra":
{ },
"labels": [] } ],
"labels":
[ "removed" ] } ],
"extra":
{ "queryable": true },
"relatedGuides":
Expand Down
18 changes: 9 additions & 9 deletions js-wixcode-sdk/$w/MenuItemMouseEvent.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down
6 changes: 2 additions & 4 deletions js-wixcode-sdk/wix-window-frontend.service.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{ "name": "wix-window-frontend",
"mixes": [],
"labels":
[ "changed" ],
"labels": [],
"location":
{ "lineno": 1,
"filename": "window-frontend.js" },
Expand Down Expand Up @@ -273,8 +272,7 @@
"extra":
{ } },
{ "name": "viewMode",
"labels":
[ "changed" ],
"labels": [],
"get": true,
"set": false,
"type": "string",
Expand Down
6 changes: 2 additions & 4 deletions js-wixcode-sdk/wix-window-frontend/ConsentPolicy.service.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{ "name": "ConsentPolicy",
"memberOf": "wix-window-frontend",
"mixes": [],
"labels":
[ "changed" ],
"labels": [],
"location":
{ "lineno": 1251,
"filename": "window-frontend.js" },
Expand Down Expand Up @@ -73,8 +72,7 @@
"extra":
{ } },
{ "name": "onConsentPolicyChanged",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params":
[ { "name": "handler",
Expand Down
6 changes: 2 additions & 4 deletions js-wixcode-sdk/wix-window/ConsentPolicy.service.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{ "name": "ConsentPolicy",
"memberOf": "wix-window",
"mixes": [],
"labels":
[ "changed" ],
"labels": [],
"location":
{ "lineno": 1325,
"filename": "window.js" },
Expand Down Expand Up @@ -80,8 +79,7 @@
"extra":
{ } },
{ "name": "onConsentPolicyChanged",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params":
[ { "name": "handler",
Expand Down