Skip to content

Commit 44e00f4

Browse files
wix-docs-fedschristopherbWIX
wix-docs-feds
and
christopherbWIX
authored
added hello world example references and content
* DocWorks for js-wixcode-sdk - 14 changes detected, but 9 issue detected changes: Service wix-window.Lightbox has changed description Service wix-window.Lightbox operation close.examples[2] has changed title Service wix-window.Lightbox operation close.examples[2] has changed body Service wix-window.Lightbox operation close.examples[2] has changed extra.description Service wix-window.Lightbox operation close.examples has 1 new examples Service wix-window.Lightbox operation getContext.examples[1] has changed title Service wix-window.Lightbox operation getContext.examples[1] has changed body Service wix-window.Lightbox operation getContext.examples[1] has changed extra.description Service wix-window.Lightbox operation getContext.examples has 1 new examples Service wix-window property lightbox has changed description Service wix-window operation openLightbox.examples[4] has changed title Service wix-window operation openLightbox.examples[4] has changed body Service wix-window operation openLightbox.examples[4] has changed extra.description Service wix-window operation openLightbox.examples has 1 new examples 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) * DocWorks for js-wixcode-sdk - no significant changes detected, but 9 issue detected 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) * DocWorks for js-wixcode-sdk - 6 changes detected, but 9 issue detected changes: Service wix-window.Lightbox operation close.examples[2] has changed title Service wix-window.Lightbox operation close.examples[2] has changed body Service wix-window.Lightbox operation getContext.examples[1] has changed title Service wix-window.Lightbox operation getContext.examples[1] has changed body Service wix-window operation openLightbox.examples[4] has changed title Service wix-window operation openLightbox.examples[4] has changed body 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) * DocWorks for js-wixcode-sdk - 3 changes detected, but 9 issue detected changes: Service wix-window.Lightbox operation close.examples[2] has changed title Service wix-window.Lightbox operation getContext.examples[1] has changed title Service wix-window operation openLightbox.examples[4] has changed title 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) * DocWorks for js-wixcode-sdk - 3 changes detected, but 9 issue detected changes: Service wix-window.Lightbox operation close.examples[2] has changed body Service wix-window.Lightbox operation getContext.examples[1] has changed body Service wix-window operation openLightbox.examples[4] has changed body 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) * DocWorks for js-wixcode-sdk - 6 changes detected, but 9 issue detected changes: Service wix-storage.Storage has changed description Service wix-storage.Storage operation clear.examples has 1 new examples Service wix-storage.Storage operation getItem.examples has 1 new examples Service wix-storage.Storage operation removeItem.examples has 1 new examples Service wix-storage.Storage operation setItem.examples has 1 new examples Service wix-storage has changed description 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) * DocWorks for js-wixcode-sdk - no significant changes detected, but 9 issue detected 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) * DocWorks for js-wixcode-sdk - no significant changes detected, but 9 issue detected 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) * DocWorks for js-wixcode-sdk - no significant changes detected, but 10 issue detected 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) ERROR: The @snippet tag - file 'velo-docs/examples/Storage-Hello_Multistate_Boxes.es6' not found. File: MultiStateBox.js line: 56 * DocWorks for js-wixcode-sdk - 1 change detected, but 10 issue detected changes: Service $w.MultiStateBox has changed description 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) ERROR: The @snippet tag - file 'velo-docs/examples/Storage-Hello_Multistate_Boxes.es6' not found. File: MultiStateBox.js line: 58 * DocWorks for js-wixcode-sdk - 4 changes detected, but 9 issue detected changes: Service $w.MultiStateBox operation changeState.examples[4] has changed title Service $w.MultiStateBox operation changeState.examples[4] has changed body Service $w.MultiStateBox operation changeState.examples[4] has changed extra.description Service $w.MultiStateBox operation changeState.examples has 1 new examples 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) * DocWorks for js-wixcode-sdk - 1 change detected, but 9 issue detected changes: Service $w.MultiStateBox has changed description 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) * DocWorks for wix-realtime - 1 change detected, but 2 issue detected changes: Service wix-realtime has changed description issues: Message Message has an unknown property type * (realtime.js (77)) ERROR: The @snippet tag - file 'velo-docs/examples/realtime-Realtime.es6' not found. File: realtime.js line: 96 * DocWorks for wix-realtime-backend - 3 changes detected, but 1 issue detected changes: Service wix-realtime-backend has changed description Service wix-realtime-backend operation publish.examples has 1 new examples Service wix-realtime-backend operation realtime_check_permission.examples has 1 new examples issues: Operation publish has an unknown param type * (publisher.js (82)) * DocWorks for wix-realtime-backend - 1 change detected, but 1 issue detected changes: Service wix-realtime-backend has changed description issues: Operation publish has an unknown param type * (publisher.js (82)) * DocWorks for wix-realtime-backend - 1 change detected, but 1 issue detected changes: Service wix-realtime-backend has changed description issues: Operation publish has an unknown param type * (publisher.js (82)) * DocWorks for wix-realtime - 1 change detected, but 2 issue detected changes: Service wix-realtime has changed description issues: Message Message has an unknown property type * (realtime.js (77)) ERROR: The @snippet tag - file 'velo-docs/examples/realtime-Realtime.es6' not found. File: realtime.js line: 96 * DocWorks for wix-realtime - 4 changes detected, but 1 issue detected changes: Service wix-realtime operation subscribe.examples[2] has changed title Service wix-realtime operation subscribe.examples[2] has changed body Service wix-realtime operation subscribe.examples[2] has changed extra.description Service wix-realtime operation subscribe.examples has 1 new examples issues: Message Message has an unknown property type * (realtime.js (77)) * DocWorks for wix-realtime - no significant changes detected, but 1 issue detected issues: Message Message has an unknown property type * (realtime.js (77)) * DocWorks for wix-realtime-backend - no significant changes detected, but 1 issue detected issues: Operation publish has an unknown param type * (publisher.js (82)) * DocWorks for wix-realtime-backend - no significant changes detected, but 1 issue detected issues: Operation publish has an unknown param type * (publisher.js (82)) * DocWorks for js-wixcode-sdk - 9 changes detected, but 9 issue detected changes: Service $w.HtmlComponent has changed description Service $w.HtmlComponent operation onMessage.examples[1] has changed title Service $w.HtmlComponent operation onMessage.examples[1] has changed body Service $w.HtmlComponent operation onMessage.examples[1] has changed extra.description Service $w.HtmlComponent operation onMessage.examples has 1 new examples Service $w.HtmlComponent operation postMessage.examples[1] has changed title Service $w.HtmlComponent operation postMessage.examples[1] has changed body Service $w.HtmlComponent operation postMessage.examples[1] has changed extra.description Service $w.HtmlComponent operation postMessage.examples has 1 new examples issues: Message ViewChangeEventOptions has an unknown property type * (ApppointmentFieldEvent.js (8)) Operation postMessage has an unknown param type * (HtmlComponent.js (99)) 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) * DocWorks for wix-animations - 15 changes detected, but 2 issue detected changes: Service wix-animations.TimeLine operation add.examples[0] has changed title Service wix-animations.TimeLine operation add.examples[0] has changed body Service wix-animations.TimeLine operation add.examples[0] has changed extra.description Service wix-animations.TimeLine operation add.examples[1] has changed title Service wix-animations.TimeLine operation add.examples[1] has changed body Service wix-animations.TimeLine operation add.examples[2] has changed title Service wix-animations.TimeLine operation add.examples[2] has changed body Service wix-animations.TimeLine operation add.examples[3] has changed title Service wix-animations.TimeLine operation add.examples[3] has changed body Service wix-animations.TimeLine operation add.examples has 1 new examples Service wix-animations has changed description Service wix-animations operation timeline.examples[3] has changed title Service wix-animations operation timeline.examples[3] has changed body Service wix-animations operation timeline.examples[3] has changed extra.description Service wix-animations operation timeline.examples has 1 new examples issues: Operation add has an unknown param type $w.Element (timeline.js (137)) Operation add has an unknown param type $w.Element (timeline.js (137)) * DocWorks for wix-animations - no significant changes detected, but 2 issue detected issues: Operation add has an unknown param type $w.Element (timeline.js (137)) Operation add has an unknown param type $w.Element (timeline.js (137)) * DocWorks for wix-router - 3 changes detected, but 2 issue detected changes: Service wix-router has changed description Service wix-router operation router.examples has 1 new examples Service wix-router operation sitemap.examples has 1 new examples issues: Operation customizeQuery has an unknown param type wix-data.WixDataQuery (router.js (308)) Operation customizeQuery has an unknown return type wix-data.WixDataQuery (router.js (308)) * DocWorks for wix-router - no significant changes detected, but 2 issue detected issues: Operation customizeQuery has an unknown param type wix-data.WixDataQuery (router.js (308)) Operation customizeQuery has an unknown return type wix-data.WixDataQuery (router.js (308)) * DocWorks for js-wixcode-sdk - 1 change detected, but 9 issue detected changes: Service wix-location property queryParams has changed summary issues: Message ViewChangeEventOptions has an unknown property type * (ApppointmentFieldEvent.js (8)) Operation postMessage has an unknown param type * (HtmlComponent.js (99)) 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) * DocWorks for js-wixcode-sdk - 2 changes detected, but 13 issue detected changes: Service wix-location.QueryParams has changed summary Service wix-location property queryParams has changed summary issues: Message ViewChangeEventOptions has an unknown property type * (ApppointmentFieldEvent.js (8)) Operation postMessage has an unknown param type * (HtmlComponent.js (99)) 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) ERROR: The @snippet tag - file 'velo-docs/examples/Location-queryPrams-Hello_Query_Parameters.es6' not found. File: location.js line: 145 ERROR: The @snippet tag - file 'velo-docs/examples/Location-queryPrams-Hello_Query_Parameters.es6' not found. File: location.js line: 170 ERROR: The @snippet tag - file 'velo-docs/examples/Location-queryPrams-Hello_Query_Parameters.es6' not found. File: location.js line: 184 ERROR: The @snippet tag - file 'velo-docs/examples/Location-queryPrams-Hello_Query_Parameters.es6' not found. File: location.js line: 224 * DocWorks for js-wixcode-sdk - 4 changes detected, but 9 issue detected changes: Service wix-location.QueryParams operation add.examples has 1 new examples Service wix-location.QueryParams operation remove.examples has 1 new examples Service wix-location property query.examples has 1 new examples Service wix-location property queryParams.examples has 1 new examples issues: Message ViewChangeEventOptions has an unknown property type * (ApppointmentFieldEvent.js (8)) Operation postMessage has an unknown param type * (HtmlComponent.js (99)) 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) * DocWorks for wix-ui-santa - 3 changes detected, but 97 issue detected changes: Service $w.CustomElement has changed description Service $w.CustomElement operation on.examples has 1 new examples Service $w.CustomElement operation setAttribute.examples has 1 new examples issues: Mixin $w.LabelMixin not found (AddressInput.js (50)) Mixin $w.FormElement not found (AddressInput.js (50)) Mixin $w.DisabledMixin not found (AddressInput.js (50)) Mixin $w.RequiredMixin not found (AddressInput.js (50)) Mixin $w.ReadOnlyMixin not found (AddressInput.js (50)) Mixin $w.HiddenCollapsedMixin not found (AddressInput.js (50)) Mixin $w.FocusMixin not found (AddressInput.js (50)) Mixin $w.ClickableMixin not found (AddressInput.js (50)) Mixin $w.Element not found (Captcha.js (1)) Mixin $w.FocusMixin not found (Captcha.js (1)) Mixin $w.HiddenCollapsedMixin not found (Captcha.js (1)) Mixin $w.Element not found (CustomElement.js (1)) Mixin $w.HiddenCollapsedMixin not found (CustomElement.js (1)) Operation onPlay has an unknown param type $w.EventHandler (MusicPlayer.js (348)) Operation onPause has an unknown param type $w.EventHandler (MusicPlayer.js (368)) Operation onEnded has an unknown param type $w.EventHandler (MusicPlayer.js (388)) Operation onProgress has an unknown param type $w.EventHandler (MusicPlayer.js (408)) Mixin $w.Element not found (MusicPlayer.js (1)) Mixin $w.HiddenCollapsedMixin not found (MusicPlayer.js (1)) Operation onChange has an unknown param type $w.EventHandler (Pagination.js (32)) Mixin $w.Element not found (Pagination.js (1)) Mixin $w.DisabledMixin not found (Pagination.js (1)) Mixin $w.HiddenCollapsedMixin not found (Pagination.js (1)) Mixin $w.ClickableMixin not found (Pagination.js (1)) Mixin $w.ViewportMixin not found (Pagination.js (1)) Property style has an unknown type $w.Style (ProgressBar.js (27)) Mixin $w.Element not found (ProgressBar.js (1)) Mixin $w.HiddenCollapsedMixin not found (ProgressBar.js (1)) Mixin $w.StyleMixin not found (ProgressBar.js ... * DocWorks for wix-ui-santa - 2 changes detected, but 97 issue detected changes: Service $w.CustomElement operation on.examples[2] has changed body Service $w.CustomElement operation setAttribute.examples[2] has changed body issues: Mixin $w.LabelMixin not found (AddressInput.js (50)) Mixin $w.FormElement not found (AddressInput.js (50)) Mixin $w.DisabledMixin not found (AddressInput.js (50)) Mixin $w.RequiredMixin not found (AddressInput.js (50)) Mixin $w.ReadOnlyMixin not found (AddressInput.js (50)) Mixin $w.HiddenCollapsedMixin not found (AddressInput.js (50)) Mixin $w.FocusMixin not found (AddressInput.js (50)) Mixin $w.ClickableMixin not found (AddressInput.js (50)) Mixin $w.Element not found (Captcha.js (1)) Mixin $w.FocusMixin not found (Captcha.js (1)) Mixin $w.HiddenCollapsedMixin not found (Captcha.js (1)) Mixin $w.Element not found (CustomElement.js (1)) Mixin $w.HiddenCollapsedMixin not found (CustomElement.js (1)) Operation onPlay has an unknown param type $w.EventHandler (MusicPlayer.js (348)) Operation onPause has an unknown param type $w.EventHandler (MusicPlayer.js (368)) Operation onEnded has an unknown param type $w.EventHandler (MusicPlayer.js (388)) Operation onProgress has an unknown param type $w.EventHandler (MusicPlayer.js (408)) Mixin $w.Element not found (MusicPlayer.js (1)) Mixin $w.HiddenCollapsedMixin not found (MusicPlayer.js (1)) Operation onChange has an unknown param type $w.EventHandler (Pagination.js (32)) Mixin $w.Element not found (Pagination.js (1)) Mixin $w.DisabledMixin not found (Pagination.js (1)) Mixin $w.HiddenCollapsedMixin not found (Pagination.js (1)) Mixin $w.ClickableMixin not found (Pagination.js (1)) Mixin $w.ViewportMixin not found (Pagination.js (1)) Property style has an unknown type $w.Style (ProgressBar.js (27)) Mixin $w.Element not found (ProgressBar.js (1)) Mixin $w.HiddenCollapsedMixin not found (ProgressBar.js (1)) Mixin $w.StyleMixin not found (ProgressBar.js (1)) Mixin $w.Element not found (RangeSlider.j ... * DocWorks for js-wixcode-sdk - 3 changes detected, but 9 issue detected changes: Service wix-window.Lightbox operation close.examples[2] has changed body Service wix-window.Lightbox operation getContext.examples[1] has changed body Service wix-window operation openLightbox.examples[4] has changed body issues: Message ViewChangeEventOptions has an unknown property type * (ApppointmentFieldEvent.js (8)) Operation postMessage has an unknown param type * (HtmlComponent.js (99)) 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.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) * DocWorks for wix-router - 2 changes detected, but 2 issue detected changes: Service wix-router operation router.examples[5] has changed body Service wix-router operation sitemap.examples[4] has changed body issues: Operation customizeQuery has an unknown param type wix-data.WixDataQuery (router.js (308)) Operation customizeQuery has an unknown return type wix-data.WixDataQuery (router.js (308)) --------- Co-authored-by: christopherbWIX <[email protected]>
1 parent 9ec9218 commit 44e00f4

19 files changed

+1236
-185
lines changed

‎js-wixcode-sdk/$w/Form.service.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66
"$w.ContainableMixin",
77
"$w.HiddenCollapsedMixin",
88
"$w.StyleMixin" ],
9-
"labels":
10-
[ "changed" ],
9+
"labels": [],
1110
"location":
1211
{ "lineno": 1,
1312
"filename": "Form.js" },

‎js-wixcode-sdk/$w/HtmlComponent.service.json

+42-7
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
" [`onMessage()`](#onMessage) functions. To learn more about what code an HTML",
1616
" component can hold, see [here](https://support.wix.com/en/article/using-iframes-to-display-visible-content-on-your-site).",
1717
"",
18+
" Get hands-on experience with the HTML Components on our [Hello HTML Component](https://www.wix.com/velo/example/hello-html-component) example page. ",
19+
"",
1820
" For an overview of working with an HTML Component using code, see [Working with the HTML Element](https://support.wix.com/en/article/working-with-the-html-element).",
1921
"",
2022
"> **Note:** To embed a PDF in an `HtmlComponent` you must upgrade your site to a [Premium Plan](https://support.wix.com/en/article/upgrading-your-site-to-premium-3066683)." ],
@@ -29,9 +31,9 @@
2931
"set": true,
3032
"type": "string",
3133
"locations":
32-
[ { "lineno": 63,
34+
[ { "lineno": 65,
3335
"filename": "HtmlComponent.js" },
34-
{ "lineno": 70,
36+
{ "lineno": 72,
3537
"filename": "HtmlComponent.js" } ],
3638
"docs":
3739
{ "summary": "Sets or gets whether the HTML Component displays scrollbars.",
@@ -69,9 +71,9 @@
6971
"set": true,
7072
"type": "string",
7173
"locations":
72-
[ { "lineno": 31,
74+
[ { "lineno": 33,
7375
"filename": "HtmlComponent.js" },
74-
{ "lineno": 38,
76+
{ "lineno": 40,
7577
"filename": "HtmlComponent.js" } ],
7678
"docs":
7779
{ "summary": "Sets or gets the URL of the HTML Component's code.",
@@ -110,7 +112,7 @@
110112
"ret":
111113
{ "type": "$w.HtmlComponent" },
112114
"locations":
113-
[ { "lineno": 216,
115+
[ { "lineno": 224,
114116
"filename": "HtmlComponent.js" } ],
115117
"docs":
116118
{ "summary": "Allows the HTML Component to be put into full screen mode.",
@@ -139,7 +141,7 @@
139141
{ "type": "$w.HtmlComponent",
140142
"doc": "The HTML Code element that triggered the event." },
141143
"locations":
142-
[ { "lineno": 166,
144+
[ { "lineno": 171,
143145
"filename": "HtmlComponent.js" } ],
144146
"docs":
145147
{ "summary": "Adds an event handler that runs when the HTML Component\n sends a message.",
@@ -175,6 +177,21 @@
175177
"} );" ],
176178
"extra":
177179
{ } },
180+
{ "title": "Communicate with an HTML Component",
181+
"body":
182+
[ "$w.onReady(() => {",
183+
" // Send message to HTML Component",
184+
" $w('#sendButton').onClick(() => {",
185+
" $w('#htmlComponent').postMessage('HELLO FROM THE PAGE');",
186+
" });",
187+
"",
188+
" // Handle messages that the HTML Component sends to the page",
189+
" $w('#htmlComponent').onMessage((event) => {",
190+
" $w('#message').text = event.data;",
191+
" });",
192+
"});" ],
193+
"extra":
194+
{ "description": "This example shows how to send information from the page to the HTML Component and from the HTML Component to the page. \n You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=d39789d7-13ee-4208-8467-8a939cd8ed8c&templateId=cfd24f07-e15f-4091-b110-2b8b889fa1e3&autoDevMode=true)." } },
178195
{ "title": "Send a message to an HTML Component and receive a confirmation",
179196
"body":
180197
[ "/* * * * * * * * * * * * * * * * * * * * * * * * *",
@@ -255,7 +272,7 @@
255272
"ret":
256273
{ "type": "void" },
257274
"locations":
258-
[ { "lineno": 97,
275+
[ { "lineno": 99,
259276
"filename": "HtmlComponent.js" } ],
260277
"docs":
261278
{ "summary": "Sends a message to the HTML Component.",
@@ -312,6 +329,21 @@
312329
[ "$w(\"#myHtmlComponent\").postMessage(\"Message from page code!\");" ],
313330
"extra":
314331
{ } },
332+
{ "title": "Communicate with an HTML Component",
333+
"body":
334+
[ "$w.onReady(() => {",
335+
" // Send message to HTML Component",
336+
" $w('#sendButton').onClick(() => {",
337+
" $w('#htmlComponent').postMessage('HELLO FROM THE PAGE');",
338+
" });",
339+
"",
340+
" // Handle messages that the HTML Component sends to the page",
341+
" $w('#htmlComponent').onMessage((event) => {",
342+
" $w('#message').text = event.data;",
343+
" });",
344+
"});" ],
345+
"extra":
346+
{ "description": "This example shows how to send information from the page to the HTML Component and from the HTML Component to the page. \n You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=d39789d7-13ee-4208-8467-8a939cd8ed8c&templateId=cfd24f07-e15f-4091-b110-2b8b889fa1e3&autoDevMode=true)." } },
315347
{ "title": "Send a message to an HTML Component and receive a confirmation",
316348
"body":
317349
[ "/* * * * * * * * * * * * * * * * * * * * * * * * *",
@@ -381,6 +413,9 @@
381413
{ "queryable": true },
382414
"relatedContent":
383415
[ { "icon": "example",
416+
"text": "Hello HTML Component (Getting Started)",
417+
"url": "https://www.wix.com/velo/example/hello-html-component" },
418+
{ "icon": "example",
384419
"text": "Adding Multiple Markers in Google Maps",
385420
"url": "https://www.wix.com/code/home/forum/wix-tips-and-updates/example-multiple-markers-google-maps" },
386421
{ "icon": "example",

‎js-wixcode-sdk/$w/MultiStateBox.service.json

+28-5
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
[ "A [multi-state box](https://support.wix.com/en/article/velo-about-multi-state-boxes) contains",
1616
"multiple states, each with different content. A multi-state box displays one state at a time.",
1717
"",
18-
"For a tutorial on working with your multi-state box and Velo, click [here](https://support.wix.com/en/article/velo-tutorial-working-with-multi-state-boxes-and-code)." ],
18+
"For a tutorial on working with your multi-state box and Velo, click [here](https://support.wix.com/en/article/velo-tutorial-working-with-multi-state-boxes-and-code).",
19+
"",
20+
"Get hands-on experience with multi-state box on our [Hello Multi-state Boxes](https://www.wix.com/velo/example/hello-multi-state-boxes) example page." ],
1921
"links": [],
2022
"examples": [],
2123
"extra":
@@ -27,7 +29,7 @@
2729
"set": false,
2830
"type": "$w.State",
2931
"locations":
30-
[ { "lineno": 45,
32+
[ { "lineno": 48,
3133
"filename": "MultiStateBox.js" } ],
3234
"docs":
3335
{ "summary": "Gets the multi-state box's current state.",
@@ -53,7 +55,7 @@
5355
"typeParams":
5456
[ "$w.State" ] },
5557
"locations":
56-
[ { "lineno": 92,
58+
[ { "lineno": 98,
5759
"filename": "MultiStateBox.js" } ],
5860
"docs":
5961
{ "summary": "Gets a list of all the states contained in the multi-state box.",
@@ -85,7 +87,7 @@
8587
[ "$w.State" ] },
8688
"doc": "Fulfilled - The state that the multi-state box changed to.\nRejected - Error message: If no argument was provided or the argument is not a string or an existing state." },
8789
"locations":
88-
[ { "lineno": 59,
90+
[ { "lineno": 62,
8991
"filename": "MultiStateBox.js" } ],
9092
"docs":
9193
{ "summary": "Change the multi-state box's current state to a specific state.",
@@ -134,6 +136,24 @@
134136
"" ],
135137
"extra":
136138
{ "description": "This example demonstrates how to switch back and forth between 2 states. The multi-state box has 2 states, with IDs `state1` and `state2`. Each state has a button. When a site visitor clicks the button, the multi-state box moves to the other state." } },
139+
{ "title": "Switch between 3 states",
140+
"body":
141+
[ "$w.onReady(() => {",
142+
" $w('#newYorkButton').onClick(() => {",
143+
" $w('#statebox').changeState('newYork');",
144+
" });",
145+
"",
146+
" $w('#texasButton').onClick(() => {",
147+
" $w('#statebox').changeState('texas');",
148+
" });",
149+
"",
150+
" $w('#californiaButton').onClick(() => {",
151+
" $w('#statebox').changeState('california');",
152+
" });",
153+
"});",
154+
"" ],
155+
"extra":
156+
{ "description": "This example shows how to change between states in multi-state boxes using code. \n You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=65aa0783-be71-42bc-ac6b-c21b454748f5&templateId=d87fbeb3-300c-49da-b93a-a2a5b4e620c6&autoDevMode=true)." } },
137157
{ "title": "State per Status",
138158
"body":
139159
[ "wixLocation.onChange(() => {",
@@ -173,7 +193,7 @@
173193
{ "type": "$w.MultiStateBox",
174194
"doc": "The multi-state box on which the event is now registered." },
175195
"locations":
176-
[ { "lineno": 23,
196+
[ { "lineno": 26,
177197
"filename": "MultiStateBox.js" } ],
178198
"docs":
179199
{ "summary": "Adds an event handler that runs when the multi-state box moves to a new state.",
@@ -200,6 +220,9 @@
200220
{ "queryable": true },
201221
"relatedContent":
202222
[ { "icon": "example",
223+
"text": "Hello Multi-state Boxes (Getting Started)",
224+
"url": "https://www.wix.com/velo/example/hello-multi-state-boxes" },
225+
{ "icon": "example",
203226
"text": "State Toggle",
204227
"url": "https://www.wix.com/velo/example/state-toggle" },
205228
{ "icon": "article",

‎js-wixcode-sdk/wix-location.service.json

+71-9
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
"set": false,
7272
"type": "string",
7373
"locations":
74-
[ { "lineno": 247,
74+
[ { "lineno": 260,
7575
"filename": "location.js" } ],
7676
"docs":
7777
{ "summary": "Gets the base URL of the current page.",
@@ -243,7 +243,38 @@
243243
"",
244244
"let query = wixLocation.query; // {\"species\": \"african-elephant\"}" ],
245245
"extra":
246-
{ } } ],
246+
{ } },
247+
{ "title": "Add, update, remove, and get URL query parameters",
248+
"body":
249+
[ "import wixLocation from 'wix-location';",
250+
"",
251+
"$w.onReady(function () {",
252+
" $w(\"#addButton\").onClick((event) => {",
253+
" const key = $w('#addKey').value;",
254+
" const value = $w('#addValue').value;",
255+
" if (key && value) {",
256+
" const toAdd = { [key]: value };",
257+
" wixLocation.queryParams.add(toAdd);",
258+
" $w('#addKey').value = undefined;",
259+
" $w('#addValue').value = undefined;",
260+
" }",
261+
" });",
262+
"",
263+
" $w(\"#removeButton\").onClick((event) => {",
264+
" const paramToRemove = [$w('#removeKey').value];",
265+
" wixLocation.queryParams.remove(paramToRemove);",
266+
" $w('#removeKey').value = undefined;",
267+
" });",
268+
"",
269+
" $w(\"#getButton\").onClick((event) => {",
270+
" const query = wixLocation.query;",
271+
" if (query) {",
272+
" $w('#getText').value = JSON.stringify(query, null, 2);",
273+
" }",
274+
" });",
275+
"});" ],
276+
"extra":
277+
{ "description": "Note: It's easiest to test this example in a published version of your site. If you test using preview, you will see a lot of extra query parameters from the Editor URL.\n You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=a0d93d05-628d-47e1-9476-337899e39c10&templateId=4d236c8a-3fe4-4aa1-87fa-d5663d866420&autoDevMode=true)." } } ],
247278
"extra":
248279
{ } },
249280
"extra":
@@ -254,7 +285,7 @@
254285
"set": false,
255286
"type": "wix-location.QueryParams",
256287
"locations":
257-
[ { "lineno": 173,
288+
[ { "lineno": 177,
258289
"filename": "location.js" } ],
259290
"docs":
260291
{ "summary": "Gets an object used to manage the query segment of the current page's URL.",
@@ -292,7 +323,38 @@
292323
"// URL after removal:",
293324
"// www.mysite.com/page?key2=value2" ],
294325
"extra":
295-
{ } } ],
326+
{ } },
327+
{ "title": "Add, update, remove, and get URL query parameters",
328+
"body":
329+
[ "import wixLocation from 'wix-location';",
330+
"",
331+
"$w.onReady(function () {",
332+
" $w(\"#addButton\").onClick((event) => {",
333+
" const key = $w('#addKey').value;",
334+
" const value = $w('#addValue').value;",
335+
" if (key && value) {",
336+
" const toAdd = { [key]: value };",
337+
" wixLocation.queryParams.add(toAdd);",
338+
" $w('#addKey').value = undefined;",
339+
" $w('#addValue').value = undefined;",
340+
" }",
341+
" });",
342+
"",
343+
" $w(\"#removeButton\").onClick((event) => {",
344+
" const paramToRemove = [$w('#removeKey').value];",
345+
" wixLocation.queryParams.remove(paramToRemove);",
346+
" $w('#removeKey').value = undefined;",
347+
" });",
348+
"",
349+
" $w(\"#getButton\").onClick((event) => {",
350+
" const query = wixLocation.query;",
351+
" if (query) {",
352+
" $w('#getText').value = JSON.stringify(query, null, 2);",
353+
" }",
354+
" });",
355+
"});" ],
356+
"extra":
357+
{ "description": "Note: It's easiest to test this example in a published version of your site. If you test using preview, you will see a lot of extra query parameters from the Editor URL.\n You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=a0d93d05-628d-47e1-9476-337899e39c10&templateId=4d236c8a-3fe4-4aa1-87fa-d5663d866420&autoDevMode=true)." } } ],
296358
"extra":
297359
{ } },
298360
"extra":
@@ -344,7 +406,7 @@
344406
"ret":
345407
{ "type": "void" },
346408
"locations":
347-
[ { "lineno": 363,
409+
[ { "lineno": 376,
348410
"filename": "location.js" } ],
349411
"docs":
350412
{ "summary": "Adds an event handler that runs when an application page's URL changes.",
@@ -398,7 +460,7 @@
398460
"ret":
399461
{ "type": "void" },
400462
"locations":
401-
[ { "lineno": 275,
463+
[ { "lineno": 288,
402464
"filename": "location.js" } ],
403465
"docs":
404466
{ "summary": "Directs the browser to navigate to the specified URL.",
@@ -542,7 +604,7 @@
542604
"ret":
543605
{ "type": "void" },
544606
"locations":
545-
[ { "lineno": 356,
607+
[ { "lineno": 369,
546608
"filename": "location.js" } ],
547609
"docs":
548610
{ "summary": "Handles location change events.",
@@ -555,7 +617,7 @@
555617
"messages":
556618
[ { "name": "Location",
557619
"locations":
558-
[ { "lineno": 348,
620+
[ { "lineno": 361,
559621
"filename": "location.js" } ],
560622
"docs":
561623
{ "summary": "An object containing information about a location.",
@@ -583,7 +645,7 @@
583645
"labels": [] },
584646
{ "name": "NavOptions",
585647
"locations":
586-
[ { "lineno": 267,
648+
[ { "lineno": 280,
587649
"filename": "location.js" } ],
588650
"docs":
589651
{ "summary": "An object containing navigation and scrolling options.",

0 commit comments

Comments
 (0)