diff --git a/js-wixcode-sdk/$w/AppointmentField.service.json b/js-wixcode-sdk/$w/AppointmentField.service.json index b26db6bb97..8791242fec 100644 --- a/js-wixcode-sdk/$w/AppointmentField.service.json +++ b/js-wixcode-sdk/$w/AppointmentField.service.json @@ -7,8 +7,7 @@ "$w.FocusMixin", "$w.ClickableMixin", "$w.RequiredMixin" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "AppointmentField.js" }, @@ -361,8 +360,7 @@ "extra": { } }, { "name": "value", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": true, "type": "Date", @@ -390,7 +388,7 @@ ">", ">", "> + To submit the new value using a dataset, set the field's value using the", - "> [`setFieldValue()`](wix-dataset.html#setFieldValue) function before", + "> [`setFieldValue()`](https://dev.wix.com/docs/velo/api-reference/$w/dataset/set-field-value) function before", "> performing the submit." ], "links": [ "[visitorTimeZone](#visitorTimeZone)" ], diff --git a/js-wixcode-sdk/$w/Button.service.json b/js-wixcode-sdk/$w/Button.service.json index a0e138f521..4b1c9b3ab7 100644 --- a/js-wixcode-sdk/$w/Button.service.json +++ b/js-wixcode-sdk/$w/Button.service.json @@ -10,8 +10,7 @@ "$w.LabelMixin", "$w.EffectsMixin", "$w.FocusMixin" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "Button.js" }, @@ -172,8 +171,7 @@ "extra": { } }, { "name": "label", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": true, "type": "string", @@ -189,7 +187,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", @@ -478,8 +476,7 @@ "extra": { } }, { "name": "onMouseOut", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "handler", @@ -511,7 +508,7 @@ { } }, { "title": "Change the button style when the mouse exits the button element", "body": - [ "$w('#myButton').onMouseOut((event) => {", + [ "$w('myButton').onMouseOut((event) => {", " $w('#myButton').style.backgroundColor = 'white';", " $w('#myButton').style.color = 'blue';", "});" ], diff --git a/js-wixcode-sdk/$w/CustomClassList.service.json b/js-wixcode-sdk/$w/CustomClassList.service.json index 4f6eac80ac..5e4c57d43a 100644 --- a/js-wixcode-sdk/$w/CustomClassList.service.json +++ b/js-wixcode-sdk/$w/CustomClassList.service.json @@ -1,15 +1,14 @@ { "name": "CustomClassList", "memberOf": "$w", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "CustomClassList.js" }, "docs": { "summary": "Provides functionality for manipulating custom CSS classes.", "description": - [ "> This property is not yet available to all users.", + [ "> This property is only available to Wix Studio users.", "", "CustomClassList is a mixin that provides functionality for manipulating an element's custom CSS classes. For example, ", "you can add a custom class to an element or replace an existing class with a new custom class.", diff --git a/js-wixcode-sdk/$w/Dataset.service.json b/js-wixcode-sdk/$w/Dataset.service.json index 9090a0267f..ee587b4ffd 100644 --- a/js-wixcode-sdk/$w/Dataset.service.json +++ b/js-wixcode-sdk/$w/Dataset.service.json @@ -1,8 +1,7 @@ { "name": "Dataset", "memberOf": "$w", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "datasetApi.js" }, @@ -811,8 +810,7 @@ "extra": { } }, { "name": "loadPage", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "pageIndex", @@ -833,7 +831,7 @@ { "summary": "Loads the specified page.", "description": [ "The `loadPage()` function returns a Promise that is resolved to", - " an array of the specified [page]($https://dev.wix.com/docs/velo/api-reference/$w/dataset/introduction#dataset-pages)'s items when:", + " an array of the specified [page](https://dev.wix.com/docs/velo/api-reference/$w/dataset/introduction#dataset-pages)'s items when:", "", " + The current item is saved in the collection (if necessary).", " + The specified [page of data](https://dev.wix.com/docs/velo/api-reference/$w/dataset/introduction#dataset-pages) is loaded.", diff --git a/js-wixcode-sdk/$w/DatePicker.service.json b/js-wixcode-sdk/$w/DatePicker.service.json index 78f8b66878..50266682f8 100644 --- a/js-wixcode-sdk/$w/DatePicker.service.json +++ b/js-wixcode-sdk/$w/DatePicker.service.json @@ -9,8 +9,7 @@ "$w.ReadOnlyMixin", "$w.ClickableMixin", "$w.RequiredMixin" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "DatePicker.js" }, @@ -607,8 +606,7 @@ "extra": { } }, { "name": "value", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": true, "type": "Date", @@ -633,7 +631,7 @@ ">", ">", "> + To submit the new value using a dataset, set the field's value using the", - "> [`setFieldValue()`](wix-dataset.html#setFieldValue) function before", + "> [`setFieldValue()`](https://dev.wix.com/docs/velo/api-reference/$w/dataset/set-field-value) function before", "> performing the submit." ], "links": [], "examples": diff --git a/js-wixcode-sdk/$w/Dropdown.service.json b/js-wixcode-sdk/$w/Dropdown.service.json index ee98e5e50d..70763c66ce 100644 --- a/js-wixcode-sdk/$w/Dropdown.service.json +++ b/js-wixcode-sdk/$w/Dropdown.service.json @@ -9,8 +9,7 @@ "$w.ClickableMixin", "$w.StyleMixin", "$w.RequiredMixin" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "DropDown.js" }, @@ -304,8 +303,7 @@ "extra": { } }, { "name": "value", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": true, "type": "string", @@ -325,7 +323,7 @@ "in code is not reflected in the submitted item.", "", "To submit the new value using a dataset, set the field's value using the", - "[`setFieldValue()`](wix-dataset.html#setFieldValue) function before", + "[`setFieldValue()`](https://dev.wix.com/docs/velo/api-reference/$w/dataset/set-field-value) function before", "performing the submit." ], "links": [], "examples": diff --git a/js-wixcode-sdk/$w/Element.service.json b/js-wixcode-sdk/$w/Element.service.json index 41288d46a1..971a82f009 100644 --- a/js-wixcode-sdk/$w/Element.service.json +++ b/js-wixcode-sdk/$w/Element.service.json @@ -3,8 +3,7 @@ "mixes": [ "$w.Node", "$w.ViewportMixin" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "Element.js" }, @@ -42,8 +41,7 @@ { } }, "properties": [ { "name": "customClassList", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": false, "type": "$w.CustomClassList", @@ -53,7 +51,7 @@ "docs": { "summary": "A property that represents an element's custom CSS classes.", "description": - [ "> This property is not yet available to all users.", + [ "> This property is only available to Wix Studio users.", "", "You can use this property to manipulate the custom CSS classes of an element. For example, ", "you can add a custom class to an element or replace an existing class with a new custom class.", diff --git a/js-wixcode-sdk/$w/Gallery.service.json b/js-wixcode-sdk/$w/Gallery.service.json index 17a7448d8e..539e086459 100644 --- a/js-wixcode-sdk/$w/Gallery.service.json +++ b/js-wixcode-sdk/$w/Gallery.service.json @@ -4,8 +4,7 @@ [ "$w.Element", "$w.HiddenCollapsedMixin", "$w.PlayableMixin" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 43, "filename": "BaseGallery.js" }, @@ -476,8 +475,7 @@ "extra": { } }, { "name": "navigateToIndex", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "index", @@ -497,7 +495,9 @@ "description": [ "The `navigateToIndex()` function navigates to the specified item's index.", "", - "Use the `animationDuration` parameter to set the speed of slide transitions during navigation." ], + "Use the `animationDuration` parameter to set the speed of slide transitions during navigation.", + "", + "> **Note:** This method isn't supported for [Pro Gallery](https://support.wix.com/en/article/wix-pro-gallery-an-overview) elements." ], "links": [], "examples": [ { "title": "Navigate to gallery item 10 (index 9)", @@ -568,7 +568,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 495, + [ { "lineno": 498, "filename": "BaseGallery.js" } ], "docs": { "summary": "Adds an event handler that runs when the gallery starts navigation.", @@ -655,7 +655,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 481, + [ { "lineno": 484, "filename": "BaseGallery.js" } ], "docs": { "summary": "Triggers a click event on the specified gallery item.", diff --git a/js-wixcode-sdk/$w/Menu.service.json b/js-wixcode-sdk/$w/Menu.service.json index 1719536572..75a74db6dd 100644 --- a/js-wixcode-sdk/$w/Menu.service.json +++ b/js-wixcode-sdk/$w/Menu.service.json @@ -3,8 +3,7 @@ "mixes": [ "$w.Element", "$w.HiddenCollapsedMixin" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "Menu.js" }, @@ -24,10 +23,11 @@ "", " | Menu Type | Velo support | Submenu support |", " | :-------- | :------: | :------- |", - " | Horizontal menus | Yes | Up to 2 additional levels (see note below) |", - " | Vertical menus | Yes | Up to 1 additional level |", - " | Drop-down menus (Deprecated) | Yes | Up to 1 additional level |", - " | Mobile menus | Yes | Up to 1 additional level |", + " | Menu (new) | Yes | Up to 2 additional levels (see note below) |", + " | Horizontal menu (old) | Yes | Up to 2 additional levels (see note below) |", + " | Vertical menu (old) | Yes | Up to 1 additional level |", + " | Drop-down menu (Deprecated) | Yes | Up to 1 additional level |", + " | Mobile menu | 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, ", @@ -39,7 +39,20 @@ "", "The drop-down menu component has been deprecated. It will continue to work, but can no longer be added in the editor.", "", - "" ], + "", + "", + "### Difference between old and new menu types", + "", + "We are in the process of replacing Horizontal and Vertical menu types with a new general Menu type, which has horizontal and vertical layout options. ", + "", + "The old and new menu types function similarly and are added by the same Horizontal and Vertical menu options in the editor's add panel. While we roll out the new Menu type, some users will get the new type of menu while others will have the old Horizontal and Vertical types.", + "You can check what type of menu you have by selecting the element in the editor. See the highlighted type in the image below:", + "", + " ![Menu types](images/menu-type.png \"Menu type\")", + "", + "There are some minor differences between the menu types:", + "- The types have different [CSS classes](https://dev.wix.com/docs/velo/api-reference/$w/menu/css-classes). ", + "- When you add a new item from the manage panel to the [structure mega](https://support.wix.com/en/article/studio-editor-adding-and-customizing-a-mega-menu) of a new Menu, the editor automatically adds a DropdownMenu component with the sub-menu and sub-sub-menu data. This component is not the same as the deprecated dropdownMenu menu type." ], "links": [], "examples": [], "extra": @@ -55,9 +68,9 @@ [ "$w.Menu.MenuItem" ] }, "defaultValue": "An array of menu items defined using the Editor.", "locations": - [ { "lineno": 99, + [ { "lineno": 114, "filename": "Menu.js" }, - { "lineno": 138, + { "lineno": 153, "filename": "Menu.js" } ], "docs": { "summary": "Sets or gets menu items.", @@ -368,7 +381,7 @@ "messages": [ { "name": "MenuItem", "locations": - [ { "lineno": 42, + [ { "lineno": 57, "filename": "Menu.js" } ], "docs": { "summary": "An object that contains the attributes of a menu item.", diff --git a/js-wixcode-sdk/$w/MultiStateBox.service.json b/js-wixcode-sdk/$w/MultiStateBox.service.json index 7578173062..627b5ec548 100644 --- a/js-wixcode-sdk/$w/MultiStateBox.service.json +++ b/js-wixcode-sdk/$w/MultiStateBox.service.json @@ -13,8 +13,9 @@ "docs": { "summary": "[Multi-state boxes](https://support.wix.com/en/article/velo-about-multi-state-boxes) are containers for states.", "description": - [ "A Multi-state box contains", - "multiple states, each with different content. A multi-state box displays one state at a time.", + [ "A Multi-state box is a container that holds multiple states, each with different content. A multi-state box displays one state at a time. You can use code to create conditions for each state to appear automatically, or allow site visitors to navigate through the states on their own. ", + "", + "It's important to ensure that your multi-state boxes are accessible to all visitors. For example, by [focusing](https://dev.wix.com/docs/velo/velo-only-apis/$w/button/focus) on a button within the multi-state box after a state changes. This allows visitors to directly access elements in the multi-state box with keyboard navigation, provides a visible indication of which element is currently selected, and enables screen readers to read the context, helping visitors see, hear, and understand what content is displayed and what actions are available. ", "", "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).", "", @@ -32,7 +33,7 @@ "set": false, "type": "$w.State", "locations": - [ { "lineno": 50, + [ { "lineno": 51, "filename": "MultiStateBox.js" } ], "docs": { "summary": "Gets the multi-state box's current state.", @@ -58,7 +59,7 @@ "typeParams": [ "$w.State" ] }, "locations": - [ { "lineno": 100, + [ { "lineno": 103, "filename": "MultiStateBox.js" } ], "docs": { "summary": "Gets a list of all the states contained in the multi-state box.", @@ -91,7 +92,7 @@ [ "$w.State" ] }, "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." }, "locations": - [ { "lineno": 64, + [ { "lineno": 65, "filename": "MultiStateBox.js" } ], "docs": { "summary": "Change the multi-state box's current state to a specific state.", @@ -181,7 +182,19 @@ "} );", "" ], "extra": - { "description": "This example demonstrates how to display different product badges for products on a Wix Stores product page. When a site visitor navigates to a product, we check the product's status (out of stock, on sale) and change the state to display the appropriate badge." } } ], + { "description": "This example demonstrates how to display different product badges for products on a Wix Stores product page. When a site visitor navigates to a product, we check the product's status (out of stock, on sale) and change the state to display the appropriate badge." } }, + { "title": "Focus on the button element in a multi-state box after switching states", + "body": + [ " $w(\"#buttonState1\").onClick(() => {", + " $w(\"#myStateBox\").changeState(\"state2\");", + "\t $w(\"#buttonState2\").focus()", + " });", + " $w(\"#buttonState2\").onClick(() => {", + " $w(\"#myStateBox\").changeState(\"state1\");", + "\t $w(\"#buttonState1\").focus()", + " });" ], + "extra": + { "description": "This example demonstrates how to make your multi-state box more accessible. When a site visitor changes the state, we focus on an element inside the state to enhance accessibility." } } ], "extra": { } }, "extra": @@ -197,7 +210,7 @@ { "type": "$w.MultiStateBox", "doc": "The multi-state box on which the event is now registered." }, "locations": - [ { "lineno": 28, + [ { "lineno": 29, "filename": "MultiStateBox.js" } ], "docs": { "summary": "Adds an event handler that runs when the multi-state box moves to a new state.", diff --git a/js-wixcode-sdk/$w/RadioButtonGroup.service.json b/js-wixcode-sdk/$w/RadioButtonGroup.service.json index db9e305dec..2150c049f7 100644 --- a/js-wixcode-sdk/$w/RadioButtonGroup.service.json +++ b/js-wixcode-sdk/$w/RadioButtonGroup.service.json @@ -9,8 +9,7 @@ "$w.ClickableMixin", "$w.StyleMixin", "$w.RequiredMixin" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "RadioButtonGroup.js" }, @@ -215,8 +214,7 @@ "extra": { } }, { "name": "value", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": true, "type": "string", @@ -250,7 +248,7 @@ ">", ">", "> + To submit the new value using a dataset, set the field's value using the", - "> [`setFieldValue()`](wix-dataset.html#setFieldValue) function before", + "> [`setFieldValue()`](https://dev.wix.com/docs/velo/api-reference/$w/dataset/set-field-value) function before", "> performing the submit." ], "links": [], "examples": diff --git a/js-wixcode-sdk/$w/Repeater.service.json b/js-wixcode-sdk/$w/Repeater.service.json index 166585cf2a..1046c98f83 100644 --- a/js-wixcode-sdk/$w/Repeater.service.json +++ b/js-wixcode-sdk/$w/Repeater.service.json @@ -4,8 +4,7 @@ [ "$w.Element", "$w.HiddenCollapsedMixin", "$w.EffectsMixin" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "Repeater.js" }, @@ -690,8 +689,7 @@ "extra": { } }, { "name": "onItemReady", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "handler", @@ -746,7 +744,7 @@ " populates the values of your page elements. Therefore, element values", " that you set using `onItemReady()` may be overridden when the dataset is", " ready. To change the values set by the dataset, use [`forEachItem`](#forEachItem)", - " inside the dataset's [`onReady()`](wix-dataset.html#onReady). For more", + " inside the dataset's [`onReady()`](https://dev.wix.com/docs/velo/api-reference/$w/dataset/on-ready). For more", " information, see the [`forEachItem`](#forEachItem) examples." ], "links": [], "examples": diff --git a/js-wixcode-sdk/$w/SearchButton.service.json b/js-wixcode-sdk/$w/SearchButton.service.json deleted file mode 100644 index 3479137d24..0000000000 --- a/js-wixcode-sdk/$w/SearchButton.service.json +++ /dev/null @@ -1,507 +0,0 @@ -{ "name": "SearchButton", - "memberOf": "$w", - "mixes": - [ "$w.Element", - "$w.HiddenCollapsedMixin", - "$w.DisabledMixin", - "$w.ClickableMixin", - "$w.StyleMixin", - "$w.LabelMixin", - "$w.EffectsMixin", - "$w.FocusMixin" ], - "labels": - [ "new" ], - "location": - { "lineno": 1, - "filename": "SearchButton.js" }, - "docs": - { "summary": "A button used to initiate a site [search](https://support.wix.com/en/article/about-wix-site-search).", - "description": - [ "> **Note:** This API can only be used in Wix Studio.", - "", - "A button used to initiate a site [search](https://support.wix.com/en/article/about-wix-site-search)." ], - "links": [], - "examples": [], - "extra": - { } }, - "properties": - [ { "name": "accessibility", - "labels": [], - "get": true, - "set": false, - "type": "$w.SearchButton.Accessibility", - "locations": - [ { "lineno": 196, - "filename": "SearchButton.js" } ], - "docs": - { "summary": "Sets and gets the [Accessible Rich Internet Application (ARIA) attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes) of the element.", - "description": - [ "ARIA attributes are a set of properties that define ways to make web content and applications more accessible to people with disabilities. The properties provide additional information about the structure, behavior, and state of elements to assistive technologies such as screen readers, braille displays, and voice control software. Set the accessibility properties to design your elements to be more inclusive and usable to users with visual, auditory, motor, and or cognitive disabilities. The accessibility object only affects how assistive technologies read and present site content to users. It doesn't affect the appearance, functionality, or SEO of your site. ", - "", - ">**Note:** Incorrect use of ARIA can worsen accessibility for assistive technology users. Use carefully and test with assistive technologies. ", - "", - "Learn more about [ARIA attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA)." ], - "links": [], - "examples": - [ { "title": "Set the accessibility properties of an element", - "body": - [ "$w('#myButton').accessibility.ariaDescribedBy = $w('#buttonDescriptionText');", - "$w('#myButton').accessibility.ariaExpanded = true;", - "$w('#myButton').accessibility.ariaHasPopup = false;", - "$w('#myButton').accessibility.ariaLabel = 'toggle button';", - "$w('#myButton').accessibility.ariaLabelledBy = $w('#buttonLabelText');", - "$w('#myButton').accessibility.ariaPressed = true;" ], - "extra": - { } }, - { "title": "Get the accessibility properties of an element", - "body": - [ "const myButtonAccessibility = $w('#myButton').accessibility;" ], - "extra": - { } } ], - "extra": - { } }, - "extra": - { } }, - { "name": "icon", - "labels": [], - "get": true, - "set": true, - "type": "string", - "locations": - [ { "lineno": 110, - "filename": "SearchButton.js" }, - { "lineno": 139, - "filename": "SearchButton.js" } ], - "docs": - { "summary": "Sets or gets the icon image displayed on the button.", - "description": - [ "The `icon` property defines the vector image used as the button’s icon.", - "", - "Setting `icon` changes the button icon to the image indicated by the new value.", - "Getting the `icon` property returns the location of the icon image file.", - "To delete a button's icon set `icon` to `null`, `undefined`, or an empty string.", - "", - "The following formats are supported:", - " + Vector images from the Media Manager: `wix:vector://v1//`", - " + Vector images from the web: `http(s)://`", - " + Vector XML string: `...`", - "", - ">**Note:** [Image Buttons](https://support.wix.com/en/article/wix-editor-adding-and-setting-up-an-image-button) don't support this property." ], - "links": - [ "[iconCollapsed](#iconCollapsed), [expandIcon](#expandIcon), [collapseIcon](#collapseIcon)" ], - "examples": - [ { "title": "Set a button's icon to a Media Manager image", - "body": - [ "$w('#myButton').icon = 'wix:vector://v1/ce0334_2cec984ab68c490891dda1b53a33fead.svg/my-vector-graphic.svg';" ], - "extra": - { } }, - { "title": "Set a button's icon to an XML string", - "body": - [ "$w('#myButton').icon = '';" ], - "extra": - { } }, - { "title": "Delete a button's icon", - "body": - [ "$w('#myButton').icon = '';" ], - "extra": - { } }, - { "title": "Get a button's icon", - "body": - [ "let iconLocation = $w('#myButton').icon;", - "// 'wix:vector://v1/ce0334_2cec984ab68c490891dda1b53a33fead.svg/my-vector-graphic.svg'" ], - "extra": - { } }, - { "title": "Change a button's icon when a site visitor clicks the button", - "body": - [ "$w('#myButton').onClick((event) => {", - " $w('#myButton').icon = 'wix:vector://v1/ce0334_2cec984ab68c490891dda1b53a33fead.svg/my-vector-graphic.svg';", - "});" ], - "extra": - { } } ], - "extra": - { } }, - "extra": - { } }, - { "name": "iconCollapsed", - "labels": [], - "get": true, - "set": false, - "type": "boolean", - "locations": - [ { "lineno": 146, - "filename": "SearchButton.js" } ], - "docs": - { "summary": "Indicates if the button’s icon is collapsed or expanded.", - "description": - [ "If `iconCollapsed` is `true`, the icon isn't displayed in the button under any circumstances. ", - "", - "If `iconCollapsed` is `false`, the icon is displayed unless the icon's button is hidden or collapsed.", - "", - "To set the iconCollapsed property on an element, use the element's [collapseIcon()](#collapseIcon) and [expandIcon()](#expandIcon) functions.", - "", - "> **Note:** ", - "> * A collapsed icon doesn't take up any space in the button.", - "> * If you delete a button's icon, `iconCollapsed` retains the deleted icon's final state." ], - "links": - [ "[icon](#icon), [expandIcon](#expandIcon), [collapseIcon](#collapseIcon)" ], - "examples": - [ { "title": "Check if a button's icon is collapsed", - "body": - [ "let iconStatus = $w('#myButton').iconCollapsed; // true" ], - "extra": - { } }, - { "title": "Expand a button's icon if it's collapsed", - "body": - [ "if ($w('#myButton').iconCollapsed) {", - " $w('#myButton').expandIcon();", - "}" ], - "extra": - { } }, - { "title": "Display tooltip text when hovering over a button if its icon is displayed", - "body": - [ "$w('#myButton').onMouseIn( (event) => {", - " // check if an icon exists and is displayed", - " if($w('#myButton').icon && !$w('#myButton').iconCollapsed){", - " // display a text box with tooltip instructions relating to the icon", - " $w('#tooltipText').expand();", - " }", - "});" ], - "extra": - { } } ], - "extra": - { } }, - "extra": - { } }, - { "name": "label", - "labels": [], - "get": true, - "set": true, - "type": "string", - "defaultValue": "Empty string", - "locations": - [ { "lineno": 56, - "filename": "SearchButton.js" }, - { "lineno": 72, - "filename": "SearchButton.js" } ], - "docs": - { "summary": "Sets or gets a button's label.", - "links": [], - "examples": - [ { "title": "Get a button's label", - "body": - [ "let buttonLabel = $w(\"#myButton\").label; // \"Submit\"" ], - "extra": - { } }, - { "title": "Set a button's label", - "body": - [ "$w(\"#myButton\").label = \"New Label\";" ], - "extra": - { } } ], - "extra": - { } }, - "extra": - { } }, - { "name": "style", - "labels": [], - "get": true, - "set": false, - "type": "$w.Style", - "locations": - [ { "lineno": 20, - "filename": "SearchButton.js" } ], - "docs": - { "summary": "Gets an object containing information about the button's styles.", - "description": - [ "The following styles can be used with buttons:", - "", - " + [`backgroundColor`]($w.Style.html#backgroundColor)", - " + [`borderColor`]($w.Style.html#borderColor)", - " + [`borderRadius`]($w.Style.html#borderRadius)", - " + [`borderWidth`]($w.Style.html#borderWidth)", - " + [`color`]($w.Style.html#color)", - " + [`hover`]($w.Style.html#hover)", - " + [`disabled`]($w.Style.html#disabled)", - "", - "", - " Getting or setting a button's `hover` and `disabled` styles affects the button's ", - " appearance only in those respective states. All other available styles apply solely ", - " to the button's regular state. ", - "", - " > **Note:** Not all styles can be used on all button designs. To determine which styles", - " work with a specific button design, go to the **Button Design** panel in", - " the Editor, choose a design, and click **Customize Design**. The design", - " options that you see in the **Button Design** panel for your particular", - " button are the styles you can use in your code." ], - "links": [], - "examples": - [ { "title": "Set the background color", - "body": - [ "$w(\"#myElement\").style.backgroundColor = \"rgba(255,0,0,0.5)\";" ], - "extra": - { } }, - { "title": "Get the background color", - "body": - [ "let bgColor = $w(\"#myElement\").style.backgroundColor;" ], - "extra": - { } } ], - "extra": - { } }, - "extra": - { } }, - { "name": "tabIndex", - "labels": [], - "get": true, - "set": true, - "type": "number", - "defaultValue": "undefined", - "locations": - [ { "lineno": 241, - "filename": "SearchButton.js" }, - { "lineno": 256, - "filename": "SearchButton.js" } ], - "docs": - { "summary": "Sets or gets the tab index of an element on a site page.", - "description": - [ "The `tabIndex` property determines the order in which elements can be focused on or selected using the tab key on the keyboard. By default, web browsers only assign a tab index to interactive elements such as links and form controls. When set to `0`, the element becomes part of the keyboard tab and focus order. When set to `-1`, the element isn't part of the keyboard focus order but can still become focusable using the [`focus()`](#focus) function.", - "", - "Supported values: `-1`, `0`" ], - "links": [], - "examples": - [ { "title": "Set the tab index of an element", - "body": - [ "const myElement = $w(\"#myElement\");", - "myElement.tabIndex = 0;" ], - "extra": - { } } ], - "extra": - { } }, - "extra": - { } }, - { "name": "type", - "labels": [], - "get": true, - "set": false, - "type": "string", - "locations": - [ { "lineno": 263, - "filename": "SearchButton.js" } ], - "docs": - { "summary": "Gets the element's type.", - "description": - [ "Returns `$w.SearchButton`." ], - "links": [], - "examples": - [ { "title": "Get the element's type.", - "body": - [ "let myType = $w(\"#myElement\").type; // \"$w.SearchButton\"" ], - "extra": - { } } ], - "extra": - { } }, - "extra": - { } } ], - "operations": - [ { "name": "collapseIcon", - "labels": [], - "nameParams": [], - "params": [], - "ret": - { "type": - { "name": "Promise", - "typeParams": - [ "void" ] }, - "doc": "Fulfilled - when the element's `iconCollapsed` property is set to `true`." }, - "locations": - [ { "lineno": 181, - "filename": "SearchButton.js" } ], - "docs": - { "summary": "Collapses the button’s icon and sets its `iconCollapsed` property to `true`.", - "description": - [ "The `collapseIcon()` function returns a Promise that resolves when the element's `iconCollapsed` property is set to `true`." ], - "links": - [ "[icon](#icon), [iconCollapsed](#iconCollapsed), [expandIcon](#expandIcon)" ], - "examples": - [ { "title": "Collapse a button's icon", - "body": - [ "$w('#myButton').collapseIcon();" ], - "extra": - { } }, - { "title": "Collapse a button's icon when a site visitor stops hovering over the button", - "body": - [ "$w('#myButton').onMouseOut( (event) => {", - "\t$w(\"#myButton\").collapseIcon();", - "});" ], - "extra": - { } } ], - "extra": - { } }, - "extra": - { } }, - { "name": "expandIcon", - "labels": [], - "nameParams": [], - "params": [], - "ret": - { "type": - { "name": "Promise", - "typeParams": - [ "void" ] }, - "doc": "Fulfilled - when the element's `iconCollapsed` property is set to `false`." }, - "locations": - [ { "lineno": 169, - "filename": "SearchButton.js" } ], - "docs": - { "summary": "Expands the button’s icon and sets its `iconCollapsed` property to `false`.", - "description": - [ "The `expandIcon()` function returns a Promise that resolves when the element's `iconCollapsed` property is set to `false`." ], - "links": - [ "[icon](#icon), [iconCollapsed](#iconCollapsed), [collapseIcon](#collapseIcon)" ], - "examples": - [ { "title": "Expand a button's icon", - "body": - [ "$w('#myButton').expandIcon();" ], - "extra": - { } }, - { "title": "Expand a button's icon when a site visitor hovers over the button", - "body": - [ "$w('#myButton').onMouseIn((event) => {", - " $w(\"#myButton\").expandIcon();", - "});" ], - "extra": - { } } ], - "extra": - { } }, - "extra": - { } }, - { "name": "onMouseIn", - "labels": [], - "nameParams": [], - "params": - [ { "name": "handler", - "type": "$w.MouseEventHandler", - "doc": "The name of the function or\n the function expression to run when the pointer is moved onto the\n element." } ], - "ret": - { "type": "$w.SearchButton", - "doc": "The element to which the event handler was added." }, - "locations": - [ { "lineno": 79, - "filename": "SearchButton.js" } ], - "docs": - { "summary": "Adds an event handler that runs when the pointer is moved\n onto the element.", - "links": [], - "examples": - [ { "title": "Get the mouse event info when the mouse enters an element", - "body": - [ "$w(\"#myElement\").onMouseIn( (event) => {", - " let clientX = event.clientX; // 362", - " let clientY = event.clientY; // 244", - " let offsetX = event.offsetX; // 10", - " let offsetY = event.offsetY; // 12", - " let pageX = event.pageX; // 362", - " let pageY = event.pageY; // 376", - " let screenX = event.screenX; // 3897", - " let screenY = event.screenY; // 362", - "} );" ], - "extra": - { } }, - { "title": "Change the button style when the mouse enters the button element", - "body": - [ "$w('#myButton').onMouseIn((event) => {", - " $w('#myButton').style.backgroundColor = 'blue';", - " $w('#myButton').style.color = 'white';", - "});" ], - "extra": - { } } ], - "extra": - { } }, - "extra": - { } }, - { "name": "onMouseOut", - "labels": [], - "nameParams": [], - "params": - [ { "name": "handler", - "type": "$w.MouseEventHandler", - "doc": "The name of the function or\n the function expression to run when the pointer is moved off of\n the element." } ], - "ret": - { "type": "$w.SearchButton", - "doc": "The element to which the event handler was added." }, - "locations": - [ { "lineno": 95, - "filename": "SearchButton.js" } ], - "docs": - { "summary": "Adds an event handler that runs when the pointer is moved\n off of the element.", - "links": [], - "examples": - [ { "title": "Get the mouse event info when the mouse exits an element", - "body": - [ "$w(\"#myElement\").onMouseOut( (event) => {", - " let clientX = event.clientX; // 362", - " let clientY = event.clientY; // 244", - " let offsetX = event.offsetX; // 10", - " let offsetY = event.offsetY; // 12", - " let pageX = event.pageX; // 362", - " let pageY = event.pageY; // 376", - " let screenX = event.screenX; // 3897", - " let screenY = event.screenY; // 362", - "} );" ], - "extra": - { } }, - { "title": "Change the button style when the mouse exits the button element", - "body": - [ "$w('#myButton').onMouseOut((event) => {", - " $w('#myButton').style.backgroundColor = 'white';", - " $w('#myButton').style.color = 'blue';", - "});" ], - "extra": - { } } ], - "extra": - { } }, - "extra": - { } } ], - "callbacks": [], - "messages": - [ { "name": "Accessibility", - "locations": - [ { "lineno": 218, - "filename": "SearchButton.js" } ], - "docs": - { "summary": "An object containing attributes to make your Wix elements more accessible.", - "links": [], - "examples": [], - "extra": - { } }, - "members": - [ { "name": "ariaLabel", - "type": "string", - "doc": "Sets or gets the [accessible name](https://www.w3.org/WAI/ARIA/apg/practices/names-and-descriptions/), a concise and descriptive label, of the element. Use `ariaLabel` when an element, such as an icon button, doesn't have a visual text label present, or has a label that should be overridden to provide clearer context. \n\nMax: 1000 characters", - "optional": true }, - { "name": "ariaLabelledBy", - "type": - [ "$w.Text", - "$w.CollapsibleText" ], - "doc": "Sets or gets the accessible name or contextual label of an element by referencing another element by ID. `ariaLabelledBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. When an element's accessible name is set using `ariaLabelledBy`, it takes precedence over any label set using the `ariaLabel` property. Make sure that any element referenced by `ariaLabelledBy` is present in the DOM to avoid errors and confusion for assistive technology users. \n\nExample: `$w(“#myElement”).accessibility.ariaLabelledBy = $w(\"#text1\");`", - "optional": true }, - { "name": "ariaDescribedBy", - "type": - [ "$w.Text", - "$w.CollapsibleText" ], - "doc": "Sets or gets the contextual description of an element by referencing another element by ID. `ariaDescribedBy` can reference either a single text element or a collapsible text element. Both visible and non-visible text elements can be referenced. The contextual description can include descriptive text, instructions, or error messages that give more context to the element's label. \n\nExample: `$w(“#myElement”).accessibility.ariaDescribedBy = $w(\"#text1\");`", - "optional": true }, - { "name": "ariaExpanded", - "type": "boolean", - "doc": "Indicates to assistive technology users whether the element is currently expanded or collapsed. `ariaExpanded` helps screen readers understand when content is displayed or hidden as a result of user interaction on your site. If `ariaExpanded` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies.", - "optional": true }, - { "name": "ariaPressed", - "type": "string", - "doc": "Indicates to assistive technology users whether the element is currently pressed. `ariaPressed` is only relevant for buttons that act as toggles or have a pressed/unpressed state. If `ariaPressed` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies. \n\nSupported values: `'true'`, `'false'`", - "optional": true }, - { "name": "ariaHasPopup", - "type": "string", - "doc": "Indicates to assistive technology users whether an element triggers an interactive popup such as a menu or dropdown. If `ariaHasPopup` isn't explicitly set, the default is `undefined` and the property isn't read by assistive technologies.\n\nSupported values: `'true'`, `'false'`", - "optional": true } ], - "extra": - { }, - "labels": [] } ], - "extra": - { } } \ No newline at end of file diff --git a/js-wixcode-sdk/$w/TableRowEvent.service.json b/js-wixcode-sdk/$w/TableRowEvent.service.json index c2f85890d7..38656bbf30 100644 --- a/js-wixcode-sdk/$w/TableRowEvent.service.json +++ b/js-wixcode-sdk/$w/TableRowEvent.service.json @@ -2,8 +2,7 @@ "memberOf": "$w", "mixes": [ "$w.Event" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 8, "filename": "TableRowEvent.js" }, @@ -21,8 +20,7 @@ { } }, "properties": [ { "name": "rowData", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": false, "type": "Object", @@ -39,8 +37,8 @@ " fields from the dataset item that are not connected to table columns.", "", " To retrieve the dataset item data that corresponds to the table row data,", - " use the dataset [`getCurrentItem()`](wix-dataset.Dataset.html#getCurrentItem)", - " function in the dataset [`onCurrentIndexChanged()`](wix-dataset.Dataset.html#onCurrentIndexChanged)", + " use the dataset [`getCurrentItem()`](https://dev.wix.com/docs/velo/api-reference/$w/dataset/get-current-item)", + " function in the dataset [`onCurrentIndexChanged()`](https://dev.wix.com/docs/velo/api-reference/$w/dataset/on-current-index-changed)", " event handler.", "", " Getting the `rowData` gets the same object that is returned in the array", diff --git a/js-wixcode-sdk/$w/TextBox.service.json b/js-wixcode-sdk/$w/TextBox.service.json index 85e1bb3ffe..1a8e1af64d 100644 --- a/js-wixcode-sdk/$w/TextBox.service.json +++ b/js-wixcode-sdk/$w/TextBox.service.json @@ -11,8 +11,7 @@ "$w.ClickableMixin", "$w.StyleMixin", "$w.RequiredMixin" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "TextBox.js" }, @@ -132,8 +131,7 @@ "extra": { } }, { "name": "value", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": true, "type": "string", @@ -159,7 +157,7 @@ ">", ">", "> + To submit the new value using a dataset, set the field's value using the", - "> [`setFieldValue()`](wix-dataset.Dataset.html#setFieldValue) function before", + "> [`setFieldValue()`](https://dev.wix.com/docs/velo/api-reference/$w/dataset/set-field-value) function before", "> performing the submit." ], "links": [], "examples": diff --git a/js-wixcode-sdk/$w/TextInput.service.json b/js-wixcode-sdk/$w/TextInput.service.json index dfea014055..d0b716bd88 100644 --- a/js-wixcode-sdk/$w/TextInput.service.json +++ b/js-wixcode-sdk/$w/TextInput.service.json @@ -11,8 +11,7 @@ "$w.ClickableMixin", "$w.StyleMixin", "$w.RequiredMixin" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "TextInput.js" }, @@ -360,8 +359,7 @@ "extra": { } }, { "name": "value", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": true, "type": "string", @@ -394,7 +392,7 @@ ">", ">", "> + To submit the new value using a dataset, set the field's value using the", - "> [`setFieldValue()`](wix-dataset/dataset/set-field-value) function before", + "> [`setFieldValue()`](https://dev.wix.com/docs/velo/api-reference/$w/dataset/set-field-value) function before", "> performing the submit." ], "links": [], "examples": diff --git a/js-wixcode-sdk/$w/ValueMixin.service.json b/js-wixcode-sdk/$w/ValueMixin.service.json index 1717cfaf7c..23d43fd7ab 100644 --- a/js-wixcode-sdk/$w/ValueMixin.service.json +++ b/js-wixcode-sdk/$w/ValueMixin.service.json @@ -1,8 +1,7 @@ { "name": "ValueMixin", "memberOf": "$w", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "ValueMixin.js" }, @@ -36,8 +35,7 @@ { } }, "properties": [ { "name": "value", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": true, "type": "*", @@ -62,7 +60,7 @@ ">", ">", "> + To submit the new value using a dataset, set the field's value using the", - "> [`setFieldValue()`](wix-dataset.html#setFieldValue) function before", + "> [`setFieldValue()`](https://dev.wix.com/docs/velo/api-reference/$w/dataset/set-field-value) function before", "> performing the submit." ], "links": [], "examples": diff --git a/js-wixcode-sdk/$w/WixComments.service.json b/js-wixcode-sdk/$w/WixComments.service.json index 3ec19bb58d..8413e0146f 100644 --- a/js-wixcode-sdk/$w/WixComments.service.json +++ b/js-wixcode-sdk/$w/WixComments.service.json @@ -2,8 +2,7 @@ "memberOf": "$w", "mixes": [ "$w.Element" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "WixComments.js" }, @@ -19,8 +18,7 @@ { } }, "properties": [ { "name": "customClassList", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": false, "type": "$w.CustomClassList", @@ -30,7 +28,7 @@ "docs": { "summary": "Note: This standard element property is not relevant for this WixComments element.", "description": - [ "> This property is not yet available to all users.", + [ "> This property is only available to Wix Studio users.", "", "You can use this property to manipulate the custom CSS classes of an element. For example, ", "you can add a custom class to an element or replace an existing class with a new custom class.", diff --git a/js-wixcode-sdk/site-monitoring.service.json b/js-wixcode-sdk/site-monitoring.service.json index c319eb00e2..bcd1fc475e 100644 --- a/js-wixcode-sdk/site-monitoring.service.json +++ b/js-wixcode-sdk/site-monitoring.service.json @@ -1,7 +1,6 @@ { "name": "site-monitoring", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "siteMonitoring.js" }, @@ -67,7 +66,7 @@ " analyze logs. [Learn more](https://support.wix.com/en/article/velo-connecting-wix-logs-to-a-monitoring-tool-advanced).", "", "", - "To learn how to generate logs on your site, click [here](https://dev.wix.com/docs/develop-websites/articles/workspace-tools/testing-monitoring/testing-troubleshooting/testing-and-troubleshooting-your-code#debugging-with-logs)." ], + "To learn how to generate logs on your site, click [here](https://dev.wix.com/docs/develop-websites/articles/workspace-tools/testing-monitoring/testing-troubleshooting/about-debugging-your-code#debugging-with-wix-logs)." ], "links": [], "examples": [], "extra": diff --git a/js-wixcode-sdk/wix-site-frontend.service.json b/js-wixcode-sdk/wix-site-frontend.service.json index bfa3676cc1..de39a1061b 100644 --- a/js-wixcode-sdk/wix-site-frontend.service.json +++ b/js-wixcode-sdk/wix-site-frontend.service.json @@ -1,7 +1,6 @@ { "name": "wix-site-frontend", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "site-frontend.js" }, @@ -257,8 +256,7 @@ { } } ], "operations": [ { "name": "getFontsHtml", - "labels": - [ "removed" ], + "labels": [], "nameParams": [], "params": [ { "name": "fonts", @@ -487,8 +485,7 @@ "extra": { } }, { "name": "getSiteThemeHtml", - "labels": - [ "removed" ], + "labels": [], "nameParams": [], "params": [ { "name": "options", @@ -1307,8 +1304,7 @@ "doc": "An identifier that is added in a `data-test-id` attribute on the returned HTML element. Use this identifier to locate the HTML element when testing your code." } ], "extra": { }, - "labels": - [ "removed" ] }, + "labels": [] }, { "name": "getSiteThemeHtmlOptions", "locations": [ { "lineno": 316, @@ -1325,8 +1321,7 @@ "doc": "An identifier that is added in a `data-test-id` attribute on the returned HTML element. You can use this identifier to locate the HTML element when testing your code." } ], "extra": { }, - "labels": - [ "removed" ] } ], + "labels": [] } ], "extra": { "scopes": [ "frontend" ] } } \ No newline at end of file diff --git a/js-wixcode-sdk/wix-window-frontend.service.json b/js-wixcode-sdk/wix-window-frontend.service.json index 968f58cf2c..4ba93b4e7e 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" }, @@ -14,7 +13,7 @@ " import wixWindowFrontend from 'wix-window-frontend';", " ```", "", - " The APIs in `wix-window-frontend` can only be used in front-end code.", + " The APIs in `wix-window-frontend` can only be used in frontend code.", "", " > Learn more about wix-window-frontend in [Getting Started](/getting-started/window-api) and on [Wix Learn](https://www.wix.com/learn/online-course/coding-with-velo/velo-frontend#use-wix-window-api)." ], "links": [], @@ -23,19 +22,18 @@ { } }, "properties": [ { "name": "browserLocale", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": false, "type": "string", "locations": - [ { "lineno": 369, + [ { "lineno": 355, "filename": "window-frontend.js" } ], "docs": - { "summary": "Gets the locale of the site visitor's browser.", + { "summary": "Gets the locale of a site visitor's browser.", "description": [ "A locale, also known as an IETF language tag, is an abbreviated code", - " that defines the language, country, and other aspects of the site ", + " that defines the language, country, and other aspects of a site ", " visitor's browser, such as number format and date format.", "", " Some common locales include:", @@ -49,7 +47,7 @@ " + `\"it-IT\"`: Italian, Italy" ], "links": [], "examples": - [ { "title": "Get the locale of a visitor's browser", + [ { "title": "Get the locale of a site visitor's browser", "body": [ "import wixWindowFrontend from 'wix-window-frontend';", "", @@ -63,28 +61,29 @@ "extra": { } }, { "name": "consentPolicy", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": false, "type": "wix-window-frontend.ConsentPolicy", "locations": - [ { "lineno": 1276, + [ { "lineno": 1227, "filename": "window-frontend.js" } ], "docs": - { "summary": "The ConsentPolicy API is used to perform actions related to the user's allowed cookies and 3rd-party data transfer, such as for GDPR or CCPA purposes.", + { "summary": "The ConsentPolicy API manages site visitor cookie preferences and 3rd-party data transfers for GDPR and CCPA compliance.", "description": - [ "The consent policy helps you comply with [GDPR](https://support.wix.com/en/article/preparing-your-wix-site-for-the-gdpr) and [CCPA](https://support.wix.com/en/article/preparing-your-wix-site-for-ccpa) regulations and lets your users", - "control their information. The site owner sets up the site consent policy and cookie consent banners in", - "the site's [Privacy Center](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Privacy%20Center&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcookie-consent-settings-app?referralInfo=corvid-docs).", + [ ">**Note:** The APIs in `wix-window-frontend.ConsentPolicy` can only be used in frontend code.", + "", + "The consent policy helps you comply with [GDPR](https://support.wix.com/en/article/preparing-your-wix-site-for-the-gdpr) and [CCPA](https://support.wix.com/en/article/preparing-your-wix-site-for-ccpa) regulations, and allows site visitors to", + "control their information. ", + "", + "Set up the site consent policy and cookie consent banners in", + "a site's [Privacy Center](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Privacy%20Center&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcookie-consent-settings-app?referralInfo=corvid-docs).", "", " To use the ConsentPolicy API, import `{ consentPolicy }` from the `wix-window-frontend` module:", "", " ```javascript", " import { consentPolicy } from 'wix-window-frontend';", - " ```", - "", - "The APIs in `wix-window-frontend.ConsentPolicy` can only be used in front-end code." ], + " ```" ], "links": [], "examples": [], "extra": @@ -92,20 +91,19 @@ "extra": { } }, { "name": "formFactor", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": false, "type": "string", "locations": - [ { "lineno": 411, + [ { "lineno": 397, "filename": "window-frontend.js" } ], "docs": - { "summary": "Gets what kind of device is being used to view the page.", + { "summary": "Gets what kind of device is being used to view a page.", "description": [ "
", "", - ">**Note:** This property only checks the site visitor's device, and not which [Studio Editor's breakpoint](https://support.wix.com/en/article/studio-editor-designing-across-breakpoints#defining-breakpoints) they are using. ", + ">**Note:** This property only checks a site visitor's device, and not which [Studio Editor's breakpoint](https://support.wix.com/en/article/studio-editor-designing-across-breakpoints#defining-breakpoints) they are using. ", "", " The `formFactor` property gets one of:", "", @@ -113,12 +111,7 @@ " + `\"Mobile\"`: When viewed in a mobile browser.", " + `\"Tablet\"`: When viewed in a tablet browser.", "", - "
", - "", - "__Important:__", - "Some tablet devices (such as iPads) are identified in this property as \"Desktop\".", - "", - "
" ], + ">**Important:** Some tablet devices (such as iPads) are identified in this property as \"Desktop\"." ], "links": [], "examples": [ { "title": "Get a device's form factor", @@ -135,18 +128,17 @@ "extra": { } }, { "name": "lightbox", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": false, "type": "wix-window-frontend.Lightbox", "locations": - [ { "lineno": 347, + [ { "lineno": 333, "filename": "window-frontend.js" } ], "docs": - { "summary": "A [lightbox](https://support.wix.com/en/article/about-lightboxes) pops up on your site to grab your visitor's attention.", + { "summary": "A [lightbox](https://support.wix.com/en/article/about-lightboxes) pops up on a site to grab a site visitor's attention.", "description": - [ "Get hands-on experience with Lightboxes on our [Hello Lightboxes](https://www.wix.com/velo/example/hello-lightboxes) example page.", + [ "To learn more about lightboxes, see the [Hello Lightboxes](https://www.wix.com/velo/example/hello-lightboxes) example page.", "", " To use the Lightbox API, import `wixWindowFrontend` from the `wix-window-frontend` module:", "", @@ -154,7 +146,7 @@ " import wixWindowFrontend from 'wix-window-frontend';", " ```", "", - "The APIs in `wix-window-frontend.Lightbox` can only be used in front-end code." ], + "The APIs in `wix-window-frontend.Lightbox` can only be used in frontend code." ], "links": [], "examples": [ { "title": "Set the lightbox to close after 6 seconds", @@ -180,7 +172,7 @@ "set": false, "type": "wix-window-frontend.Multilingual", "locations": - [ { "lineno": 1118, + [ { "lineno": 1065, "filename": "window-frontend.js" } ], "docs": { "summary": "The Multilingual API is used when working with languages in a multilingual site.", @@ -203,24 +195,23 @@ "extra": { } }, { "name": "referrer", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": false, "type": "string", "locations": - [ { "lineno": 421, + [ { "lineno": 403, "filename": "window-frontend.js" } ], "docs": { "summary": "Gets the HTTP referrer header field.", "description": - [ "The `referrer` is the address of the previous web page that the user was", + [ "The `referrer` is the address of the web page a site visitor was previously", " on before arriving at the current page, typically by clicking a link.", "", - " > **Note:** When visitors move from page to page within your site, the `referrer` property", - " does not contain the address of the page the visitor came from. This is because", + " > **Note:** When site visitors move from page to page within your site, the `referrer` property", + " does not contain the address of the page the site visitor came from. This is because", " Wix sites are built as [single page applications](https://en.wikipedia.org/wiki/Single-page_application).", - " To get the previous page a visitor was visiting within your site, you can", + " To get the previous page a site visitor was visiting within your site, you can", " use [`wix-storage-frontend`](wix-storage-frontend.html) to store the visitor's current page", " and retrieve the visitor's previous page." ], "links": [], @@ -260,7 +251,7 @@ "set": false, "type": "wix-window-frontend.Rendering", "locations": - [ { "lineno": 305, + [ { "lineno": 291, "filename": "window-frontend.js" } ], "docs": { "summary": "The [Rendering API](wix-window-frontend.html#rendering) is used to control when code is run as a page is being loaded.", @@ -285,21 +276,20 @@ "extra": { } }, { "name": "viewMode", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": false, "type": "string", "locations": - [ { "lineno": 394, + [ { "lineno": 380, "filename": "window-frontend.js" } ], "docs": - { "summary": "Gets which mode the site is currently being viewed in.", + { "summary": "Gets which mode a site is currently being viewed in.", "description": [ "The `viewMode` property gets either:", "", - " + `\"Preview\"`: When previewing the site using the **Preview** button in the editor.", - " + `\"Site\"`: When viewing the published site.", + " + `\"Preview\"`: When previewing a site using the **Preview** button in the editor.", + " + `\"Site\"`: When viewing a published site.", " + `\"Editor\"`: When viewing a [Wix Blocks](https://support.wix.com/en/article/wix-blocks-check-out-our-articles) built widget in the editor." ], "links": [], "examples": @@ -322,7 +312,7 @@ "set": false, "type": "wix-window-frontend.WarmupData", "locations": - [ { "lineno": 170, + [ { "lineno": 156, "filename": "window-frontend.js" } ], "docs": { "summary": "The Warmup Data API is used to optimize data loading for sites that render both on the server and in the browser, \n allowing costly data fetching operations to be done only once.", @@ -362,8 +352,7 @@ { } } ], "operations": [ { "name": "copyToClipboard", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "text", @@ -374,26 +363,26 @@ { "name": "Promise", "typeParams": [ "void" ] }, - "doc": "Fulfilled - When the copy is complete or the site visitor closes the modal popup." }, + "doc": "Fulfilled - When the copy is complete or a site visitor closes the modal popup." }, "locations": - [ { "lineno": 542, + [ { "lineno": 525, "filename": "window-frontend.js" } ], "docs": - { "summary": "Copies text to the site visitor's clipboard.", + { "summary": "Copies text to a site visitor's clipboard.", "description": - [ "The `copyToClipboard()` function copies the specified text to the site visitor's clipboard.", + [ "The `copyToClipboard()` method copies the specified text to a site visitor's clipboard.", "", - " If the site visitor's browser does not support copying text to the clipboard", + " If a site visitor's browser doesn't support copying text to the clipboard", " programmatically, a modal popup that allows copying will be displayed.", - " For example, when calling `copyToClipboard` from a Firefox or Edge browser", - " the site visitor will see something similar to the popup shown below.", + " For example, when calling `copyToClipboard()` from a Firefox or Edge browser,", + " a site visitor will see something similar to the popup shown below.", "", " ![Copy To Clipboard Popup](images/copyToClipboardModal.png \"Copy To Clipboard Popup\")", "", " The Promise returned by `copyToClipboard()` resolves when the", " specified text is copied to clipboard or the modal popup is closed.", " The Promise is rejected if a `null` value is passed as the `toCopy` parameter", - " or if the visitor's browser blocks the modal popup from opening." ], + " or if a site visitor's browser blocks the modal popup from opening." ], "links": [], "examples": [ { "title": "Copy text to clipboard", @@ -416,28 +405,27 @@ "extra": { } }, { "name": "getAppPageData", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [], "ret": { "type": "Object", "doc": "The data passed to the app page." }, "locations": - [ { "lineno": 1420, + [ { "lineno": 1363, "filename": "window-frontend.js" } ], "docs": - { "summary": "Returns the data passed to a [custom app page](https://dev.wix.com/docs/develop-websites/articles/wix-apps/build-a-custom-wix-business-app-page).", + { "summary": "Gets the data passed to a [custom app page](https://dev.wix.com/docs/develop-websites/articles/wix-apps/build-a-custom-wix-business-app-page).", "description": - [ "Wix passes data to custom app pages that you can use when implementing the page's business logic.", - "Call the `getAppPageData()` function to retrieve the data and use it in your code.", - "The data retrieved by this function is different for each type of custom app page.", - "For more information, see [App Page Data](#app-page-data).", + [ "Wix passes data to custom app pages that you can use when implementing a page's business logic.", + "Call the `getAppPageData()` method to retrieve the data and use it in your code.", + "The data retrieved by this method is different for each type of custom app page.", + "For more information, see [App Page Data](https://dev.wix.com/docs/velo/api-reference/wix-window-frontend/app-page-data).", "", "Learn more about [building custom app pages](https://dev.wix.com/docs/develop-websites/articles/wix-apps/build-a-custom-wix-business-app-page).", "", - "If you call the `getAppPageData()` function in the code for a page that isn't", - "a custom app page, the function returns `null`." ], + ">**Note:** If you call `getAppPageData()` for a page that isn't", + "a custom app page, it returns `null`." ], "links": [], "examples": [ { "title": "Get the data passed to a custom app page", @@ -454,8 +442,7 @@ "extra": { } }, { "name": "getBoundingRect", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [], "ret": @@ -463,19 +450,20 @@ { "name": "Promise", "typeParams": [ "wix-window-frontend.WindowSizeInfo" ] }, - "doc": "Fulfilled - An object containing information about the window's size, the document's size, and the current scroll position." }, + "doc": "Fulfilled - An object containing information about a window's size, document's size, and current scroll position." }, "locations": - [ { "lineno": 528, + [ { "lineno": 510, "filename": "window-frontend.js" } ], "docs": - { "summary": "Returns information about the window.", + { "summary": "Gets information about a window.", "description": - [ "The `getBoundingRect()` function returns a Promise that resolves to an object", - " containing information about the current window's size, the document's size,", - " and the current scroll position." ], + [ "Returns information about a window's size, document's size,", + " and current scroll position.", + "", + " This method returns `null` for sites with [SSR](https://developer.mozilla.org/en-US/docs/Glossary/SSR)." ], "links": [], "examples": - [ { "title": "Get information about the window", + [ { "title": "Get information about a window", "body": [ "import wixWindowFrontend from 'wix-window-frontend';", "", @@ -497,8 +485,7 @@ "extra": { } }, { "name": "getCurrentGeolocation", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [], "ret": @@ -506,20 +493,17 @@ { "name": "Promise", "typeParams": [ "wix-window-frontend.CurrentGeolocation" ] }, - "doc": "Fulfilled - An object containing the coordinates and timestamp of the current location.\nRejected - The user blocked the geolocation popup." }, + "doc": "Fulfilled - An object containing the coordinates and timestamp of the current location.\nRejected - The site visitor blocked the geolocation popup." }, "locations": - [ { "lineno": 645, + [ { "lineno": 615, "filename": "window-frontend.js" } ], "docs": - { "summary": "Returns the current geolocation of the user.", + { "summary": "Gets the current geolocation of a site visitor.", "description": - [ "The `getCurrentGeolocation()` function returns a Promise that resolves to an", - " object containing the current geolocation of the user.", - "", - " The `getCurrentGeolocation()` function has the following limitations:", + [ "The `getCurrentGeolocation()` method has the following limitations:", " ", " + On Chrome, the function only works on HTTPS sites.", - " + On Chrome, Firefox, and Safari, the function only works if the user", + " + On Chrome, Firefox, and Safari, the function only works if the site visitor", " approves a popup. If they do not approve, the promise is rejected.", " + Run `getCurrentGeolocation()` with a [`setTimeout()`](https://www.w3schools.com/js/js_timing.asp) in case the browser is set to not detect the locale. Adding the timeout lets you handle the unfulfilled promise." ], "links": [], @@ -551,31 +535,26 @@ "extra": { } }, { "name": "getRouterData", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [], "ret": { "type": "Object", "doc": "The data returned by the router." }, "locations": - [ { "lineno": 626, + [ { "lineno": 600, "filename": "window-frontend.js" } ], "docs": - { "summary": "Returns the data that a router passed to the page in its response.", + { "summary": "Gets the data sent by a router to a page as part of its response.", "description": - [ "When you create a router and define its functionality in its [router()](wix-router.html#router)", - " function, you can choose to send data along with the router's [response](wix-router.WixRouterResponse.html).", - " That data is retrieved in the code of the page that was routed to using the", - " `getRouterData()` function.", - "", - " If you call the `getRouterData()` function from a non-router page or a router", - " page that wasn't sent any data, the function returns `null`." ], + [ "When you define a router and its functionality in the router() method, you can include data in the router's response. ", + " This data can then be accessed in the code of the routed page by calling the getRouterData() method. If you call this method from a non-router page or a router", + " page that wasn't sent any data, the method returns `null`." ], "links": [ "[router( )](wix-router.html#router)", "[WixRouterResponse](wix-router.WixRouterResponse.html)" ], "examples": - [ { "title": "Get the data passed by a router", + [ { "title": "Get the data sent by a router", "body": [ "import wixWindowFrontend from 'wix-window-frontend';", "", @@ -589,8 +568,7 @@ "extra": { } }, { "name": "openLightbox", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "name", @@ -607,45 +585,24 @@ [ "Object" ] }, "doc": "Fulfilled - The returned data from the lightbox.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 667, + [ { "lineno": 635, "filename": "window-frontend.js" } ], "docs": { "summary": "Opens a lightbox and optionally passes it the given data.", "description": - [ "The `openLightbox()` function returns a Promise which is resolved when the", - " lightbox closes. If the lightbox is closed programmatically using its", - " [`close()`](wix-window-frontend.Lightbox.html#close) function, and the", - " [`close()`](wix-window-frontend.Lightbox.html#close) function was invoked", - " with a data parameter, then the Promise resolves to that data object.", - "", - " If you send a data object to the lightbox, use the [`getContext()`](wix-window-frontend.Lightbox.html#getContext)", - " function in the lightbox's code to access the received data.", + [ "The `openLightbox()` method opens a lightbox and allows you to pass data to it.", + " Lightboxes that are opened automatically on page load, or via a link from a page element don't receive passed data. ", "", - " To pass data to the lightbox that is opened, you must open the lightbox", - " programmatically using the [`openLightbox()`](wix-window-frontend.html#openLightbox)", - " function. If the lightbox is opened automatically when the page loads or", - " by a link from a page element, data will not be passed to the lightbox.", - " Therefore, if you want to pass data to the lightbox, make sure", - " **Automatically display lightbox on pages** is [set](https://support.wix.com/en/article/wix-editor-adding-and-setting-up-a-lightbox#step-3-set-the-lightbox-trigger) to **No** in the", - " **Lightbox Settings** panel in the Editor and don't set any element's link", - " to open the lightbox. Instead, create your own method for opening", - " the lightbox programmatically. For example, you can add a button with an `onClick` event", - " handler that calls the [`openLightbox()`](wix-window-frontend.html#openLightbox) function.", + " To ensure data can be passed:", + " 1. Call this method to open a lightbox programmatically. For example, add a button with an `onClick` event handler that calls `openLightbox()`.", + " 2. Set **Automatically display lightbox on pages** to **No** in the lightbox's settings under [**Set Triggers**](https://support.wix.com/en/article/studio-editor-using-lightboxes#setting-triggers-for-a-lightbox).", "", - " To pass data back to the page that opened the lightbox, you must close the", - " lightbox programmatically using the `close()` function. If the lightbox is", - " closed by the site visitor clicking the 'X' icon, close button, or lightbox", - " overlay, data will not be passed back the the page that opened the lightbox.", - " Therefore, if you want to make sure data is passed back to the page that", - " opened the lightbox, [disable all of the methods mentioned above](https://support.wix.com/en/article/wix-editor-adding-and-setting-up-a-lightbox#step-4-choose-how-visitors-close-the-lightbox) and create your own method for closing", - " the lightbox programmatically. For example, you can add a button with an `onClick` event", - " handler that calls the `close()` function.", + " If you pass data to a lightbox, call the [`getContext()`](https://dev.wix.com/docs/velo/api-reference/wix-window-frontend/lightbox/get-context)", + " method in the lightbox's code to access the received data.", "", - " > **Notes:** Use the name of the lightbox and not the lightbox's ID when calling", - " `openLightbox()`. You can find the lightbox's name by selecting the ", - " lightbox and clicking the settings button.", - " >", - " > Only call `openLightBox` after the [`onReady`](https://dev.wix.com/docs/velo/api-reference/$w/on-ready) event has fired." ], + " > **Notes:** ", + " > + Use the name of the lightbox and not the lightbox's ID when calling `openLightbox()`. You can find the lightbox's name by selecting the lightbox and clicking the settings button.", + " > + Only call `openLightBox()` after the [`onReady()`](https://dev.wix.com/docs/velo/api-reference/$w/on-ready) method, once all page elements have finished loading." ], "links": [ "[openModal( )](#openModal)" ], "examples": @@ -735,7 +692,7 @@ "", "" ], "extra": - { "description": "In this example, we demonstrate how to open and close a lightbox using code, as well as how to send information from the page to the lightbox and from the lightbox to the page. \n You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=36f51075-ed17-41e6-aea6-68f9ca7de0be&templateId=63b643a6-6dc1-43ed-ad90-025371ca06fd&autoDevMode=true)." } }, + { "description": "In this example, we demonstrate how to open and close a lightbox using code, as well as how to send information from the page to the lightbox and from the lightbox to the page. \n Test the code in the [example template](https://manage.wix.com/edit-template/from?originTemplateId=36f51075-ed17-41e6-aea6-68f9ca7de0be&templateId=63b643a6-6dc1-43ed-ad90-025371ca06fd&autoDevMode=true)." } }, { "title": "A scenario where information is passed between a page and a lightbox", "body": [ "/*************", @@ -781,8 +738,7 @@ "extra": { } }, { "name": "openModal", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "url", @@ -790,7 +746,7 @@ "doc": "The URL of the page to show in the modal window." }, { "name": "options", "type": "wix-window-frontend.OpenModalOptions", - "doc": "The options used for the modal window." } ], + "doc": "Modal window options." } ], "ret": { "type": { "name": "Promise", @@ -798,20 +754,20 @@ [ "void" ] }, "doc": "Fulfilled - When the modal window is closed.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 1049, + [ { "lineno": 996, "filename": "window-frontend.js" } ], "docs": { "summary": "Opens a modal window that displays the specified web page.", "description": [ "A modal window displays the page specified by the `url` property over", - " your current page. Unlike a [lightbox](wix-window-frontend.Lightbox.html), which", - " is opened using the [`openLightbox()`](#openLightbox) function, the window", - " opened by `openModal()` is not part of your site structure.", + " your current page. Unlike a [lightbox](https://dev.wix.com/docs/velo/api-reference/wix-window-frontend/lightbox/introduction), which", + " is opened by calling the [`openLightbox()`](https://dev.wix.com/docs/velo/api-reference/wix-window-frontend/open-lightbox) method, a window", + " opened by `openModal()` is not part of a site's structure.", "", " Only one modal window can be open at any given time. Therefore, opening", " a modal window closes an already open modal window if there is one.", "", - " > **Note:** The specified `url` must be an HTTPS URL." ], + " > **Note:** The specified `url` must be an HTTPS URL." ], "links": [ "[openLightbox( )](#openLightbox)" ], "examples": @@ -847,8 +803,7 @@ "extra": { } }, { "name": "postMessage", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "message", @@ -856,7 +811,7 @@ "doc": "The message to send." }, { "name": "target", "type": "string", - "doc": "The target to send the message to. Must be `\"parent\"` or omitted. Defaults to `\"parent\"`.", + "doc": "The target to send the message to. Must be `\"parent\"` or omitted. Default: `\"parent\"`.", "optional": true } ], "ret": { "type": @@ -865,18 +820,18 @@ [ "Object" ] }, "doc": "Fulfilled - The data returned from the page's parent.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 1074, + [ { "lineno": 1021, "filename": "window-frontend.js" } ], "docs": - { "summary": "Sends a message to the page's parent.", + { "summary": "Sends a message to a page's parent.", "description": - [ "If a page is embedded within another site, using an [HtmlComponent]($w.HtmlComponent.html)", + [ "If a page is embedded within another site, using an [HtmlComponent](https://dev.wix.com/docs/velo/api-reference/$w/html-component/introduction)", " on a Wix site or an [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe)", - " on a non-Wix site, you can use the `postMessage()` function to send a", + " on a non-Wix site, call this method to send a", " message from the inner site to the outer site.", "", - " When the parent site is a Wix site, use the [`onMessage()`]($w.HtmlComponent.html#onMessage)", - " function to receive the message on the parent page.", + " When the parent site is a Wix site, call [`onMessage()`](https://dev.wix.com/docs/velo/api-reference/$w/html-component/on-message)", + " to receive the message on the parent page.", "", " When the parent site is a non-Wix site, use the page's `window.onMessage`", " event handler to read the `data` property of the received `MessageEvent`", @@ -932,8 +887,7 @@ "extra": { } }, { "name": "scrollBy", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "x", @@ -949,20 +903,17 @@ [ "void" ] }, "doc": "Fulfilled - When the scroll is complete." }, "locations": - [ { "lineno": 606, + [ { "lineno": 583, "filename": "window-frontend.js" } ], "docs": - { "summary": "Scrolls the page by a given number of pixels.", + { "summary": "Scrolls a page by the specified number of pixels.", "description": - [ "The `scrollBy()` function returns a Promise that resolves when the current", - " page has been scrolled by the given number of pixels,", - "", - " The `x` and `y` parameters determine the number of horizontal and vertical", + [ "The `x` and `y` parameters determine the number of horizontal and vertical", " pixels to scroll the current page. Negative numbers scroll up or to the", " left and positive numbers scroll down or to the right." ], "links": [], "examples": - [ { "title": "Scroll the page by a given number of pixels", + [ { "title": "Scroll a page by the specified number of pixels", "body": [ "import wixWindowFrontend from 'wix-window-frontend';", "", @@ -971,7 +922,7 @@ "wixWindowFrontend.scrollBy(100, 500);" ], "extra": { } }, - { "title": "Scroll the page by a given number of pixels and log message when done", + { "title": "Scroll the page by the specified number of pixels and log message when done", "body": [ "import wixWindowFrontend from 'wix-window-frontend';", "", @@ -988,8 +939,7 @@ "extra": { } }, { "name": "scrollTo", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "x", @@ -1009,24 +959,18 @@ [ "void" ] }, "doc": "Fulfilled - When the scroll is complete." }, "locations": - [ { "lineno": 576, + [ { "lineno": 559, "filename": "window-frontend.js" } ], "docs": - { "summary": "Scrolls the page to a specific location on the page.", + { "summary": "Scrolls a page to the specified location.", "description": - [ "The `scrollTo()` function returns a Promise that resolves when the current", - " page has been scrolled to a given location on the page.", - "", - " The `x` and `y` parameters determine the top-left pixel that is", + [ "The `x` and `y` parameters determine the top-left pixel that is", " displayed on screen after the scroll.", "", - " > **Tip**: To get the coordinates for scrolling, display the Wix Editor Toolbar. In the Editor, ", - " move the cursor to the top-left pixel where you want the page to scroll to. The **X** ", + " > **Tip**: To get the coordinates for scrolling, click on an element to open the [Inspector panel](https://support.wix.com/en/article/studio-editor-using-the-inspector-panel) (Wix Studio), or open the [Editor toolbar](https://support.wix.com/en/article/wix-editor-using-the-editor-toolbar-to-adjust-elements) (Wix Editor). ", + " Then move the cursor to the top-left pixel where you want the page to scroll to. The **X** ", " and **Y** axis **Position** values show the coordinates.", "", - " To scroll to a specific element on the page, see the `$w.Node`", - " [`scrollTo()`]($w.Node.html) function.", - "", " Use the `options` parameter to specify the options to use when scrolling." ], "links": [], "examples": @@ -1065,8 +1009,7 @@ "extra": { } }, { "name": "trackEvent", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "eventName", @@ -1090,13 +1033,12 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 980, + [ { "lineno": 928, "filename": "window-frontend.js" } ], "docs": { "summary": "Sends a tracking event to external analytics tools.", "description": - [ "The `trackEvent()` function sends an event to analytics tools connected", - " to your site. It can send events to Google Analytics, Facebook Pixel or analytics tools set up with the Google Tag Manager.", + [ "Sends an event to analytics tools connected to your site. It can send events to Google Analytics, Facebook Pixel or analytics tools set up with the Google Tag Manager.", "", " Learn more about:", "", @@ -1105,10 +1047,10 @@ " + [Connecting a Google Analytics Property to Your Wix Site](https://support.wix.com/en/article/tracking-events-on-your-wix-site-with-a-google-analytics-property)", " + [Connecting Your Google Tag Manager Account to Your Wix Site](https://support.wix.com/en/article/connecting-your-google-tag-manager-account-to-your-wix-site)", "", - " > **Note:** The `trackEvent()` function only runs on published versions of your site.", + " > **Note:** This method only runs on published versions of your site.", " It doesn't work when previewing your site.", "", - " The `trackEvent()` function lets you track both standard and custom events.", + " The `trackEvent()` method lets you track both standard and custom events.", "", " The following standard events are supported:", "", @@ -1188,7 +1130,7 @@ "messages": [ { "name": "Coordinates", "locations": - [ { "lineno": 449, + [ { "lineno": 431, "filename": "window-frontend.js" } ], "docs": { "summary": "An object that defines the location.", @@ -1237,17 +1179,16 @@ "doc": "The accuracy in meters of the `altitude` property. This value may be null." }, { "name": "heading", "type": "number", - "doc": "The direction in degrees in which the device is traveling. It indicates how far off from heading true north the device is. If `speed` is `0`, the heading is `NaN`. This value may be null if the browser cannot provide the data." }, + "doc": "The direction in degrees in which the device is traveling. It indicates how far off from heading true north the device is. If `speed` is `0`, the heading is `NaN`. This value may be null if the browser can't provide the data." }, { "name": "speed", "type": "number", - "doc": "The velocity in meters per second of the device. This value may be null if the browser cannot provide the data." } ], + "doc": "The velocity in meters per second of the device. This value may be null if the browser can't provide the data." } ], "extra": { }, - "labels": - [ "changed" ] }, + "labels": [] }, { "name": "CurrentGeolocation", "locations": - [ { "lineno": 481, + [ { "lineno": 463, "filename": "window-frontend.js" } ], "docs": { "summary": "An object returned by the `getCurrentGeolocation()` function that contains information about the current geolocation.", @@ -1290,7 +1231,7 @@ "labels": [] }, { "name": "CustomType", "locations": - [ { "lineno": 846, + [ { "lineno": 794, "filename": "window-frontend.js" } ], "docs": { "summary": "A custom parameter used when sending a CustomEvent track event.", @@ -1305,7 +1246,7 @@ "labels": [] }, { "name": "DocumentSize", "locations": - [ { "lineno": 500, + [ { "lineno": 482, "filename": "window-frontend.js" } ], "docs": { "summary": "An object containing the size of the actual body of the page, which may be larger or smaller than the current window.", @@ -1343,7 +1284,7 @@ "labels": [] }, { "name": "OpenModalOptions", "locations": - [ { "lineno": 1039, + [ { "lineno": 986, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when opening a modal window.", @@ -1376,7 +1317,7 @@ "labels": [] }, { "name": "ScrollOffset", "locations": - [ { "lineno": 509, + [ { "lineno": 491, "filename": "window-frontend.js" } ], "docs": { "summary": "An object containing the scroll offset of the page within the window from the top-left corner.", @@ -1414,7 +1355,7 @@ "labels": [] }, { "name": "ScrollToOptions", "locations": - [ { "lineno": 567, + [ { "lineno": 550, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used for providing options for the `scrollTo()` method.", @@ -1441,7 +1382,7 @@ "labels": [] }, { "name": "WindowSize", "locations": - [ { "lineno": 491, + [ { "lineno": 473, "filename": "window-frontend.js" } ], "docs": { "summary": "An object containing the size of the viewable area of the current browser window.", @@ -1479,14 +1420,14 @@ "labels": [] }, { "name": "WindowSizeInfo", "locations": - [ { "lineno": 518, + [ { "lineno": 500, "filename": "window-frontend.js" } ], "docs": - { "summary": "An object returned by the `getBoundingRect()` function that contains information about the window's size, the document's size, and the current scroll position.", + { "summary": "An object returned by the `getBoundingRect()` method that contains information about a window's size, document's size, and current scroll position.", "links": [ "[getBoundingRect( )](#getBoundingRect)" ], "examples": - [ { "title": "Get information about the window", + [ { "title": "Get information about a window", "body": [ "import wixWindowFrontend from 'wix-window-frontend';", "", @@ -1517,11 +1458,10 @@ "doc": "An object containing the scroll offset of the page within the window from the top-left corner." } ], "extra": { }, - "labels": - [ "changed" ] }, + "labels": [] }, { "name": "trackingParameters", "locations": - [ { "lineno": 737, + [ { "lineno": 685, "filename": "window-frontend.js" } ], "docs": { "summary": "Objects used when calling the [`trackEvent()`](wix-window-frontend.html#trackEvent) function.", @@ -1585,7 +1525,7 @@ "labels": [] }, { "name": "trackingParametersAddPaymentInfoEvent", "locations": - [ { "lineno": 730, + [ { "lineno": 678, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending an `AddPaymentInfo` track event.", @@ -1609,7 +1549,7 @@ "labels": [] }, { "name": "trackingParametersAddProductImpressionEvent", "locations": - [ { "lineno": 767, + [ { "lineno": 715, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending an AddProductImpression track event.", @@ -1664,7 +1604,7 @@ "labels": [] }, { "name": "trackingParametersAddProductImpressionEventContents", "locations": - [ { "lineno": 777, + [ { "lineno": 725, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending an AddProductImpression track event.", @@ -1748,7 +1688,7 @@ "labels": [] }, { "name": "trackingParametersAddToCartEvent", "locations": - [ { "lineno": 795, + [ { "lineno": 743, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending an AddToCart track event.", @@ -1824,7 +1764,7 @@ "labels": [] }, { "name": "trackingParametersCheckoutStepEvent", "locations": - [ { "lineno": 814, + [ { "lineno": 762, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending an CheckoutStep track event.", @@ -1867,7 +1807,7 @@ "labels": [] }, { "name": "trackingParametersClickProductEvent", "locations": - [ { "lineno": 827, + [ { "lineno": 775, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending a ClickProduct track event.", @@ -1942,7 +1882,7 @@ "labels": [] }, { "name": "trackingParametersCustomEvent", "locations": - [ { "lineno": 853, + [ { "lineno": 801, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending a CustomEvent track event.", @@ -1998,7 +1938,7 @@ "labels": [] }, { "name": "trackingParametersInitiateCheckoutEvent", "locations": - [ { "lineno": 866, + [ { "lineno": 814, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending an InitiateCheckout track event.", @@ -2051,7 +1991,7 @@ "labels": [] }, { "name": "trackingParametersInitiateCheckoutEventContents", "locations": - [ { "lineno": 876, + [ { "lineno": 824, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending an InitiateCheckout track event.", @@ -2129,7 +2069,7 @@ "labels": [] }, { "name": "trackingParametersLeadEvent", "locations": - [ { "lineno": 892, + [ { "lineno": 840, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending a Lead track event.", @@ -2156,7 +2096,7 @@ "labels": [] }, { "name": "trackingParametersPurchaseEvent", "locations": - [ { "lineno": 901, + [ { "lineno": 849, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending a Purchase track event.", @@ -2231,7 +2171,7 @@ "labels": [] }, { "name": "trackingParametersPurchaseEventContents", "locations": - [ { "lineno": 917, + [ { "lineno": 865, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending an Purchase track event.", @@ -2303,7 +2243,7 @@ "labels": [] }, { "name": "trackingParametersRemoveFromCartEvent", "locations": - [ { "lineno": 933, + [ { "lineno": 881, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending a RemoveFromCart track event.", @@ -2375,7 +2315,7 @@ "labels": [] }, { "name": "trackingParametersStartPaymentEvent", "locations": - [ { "lineno": 951, + [ { "lineno": 899, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending an StartPayment track event.", @@ -2408,7 +2348,7 @@ "labels": [] }, { "name": "trackingParametersViewContentEvent", "locations": - [ { "lineno": 961, + [ { "lineno": 909, "filename": "window-frontend.js" } ], "docs": { "summary": "An object used when sending a ViewContent track event.", diff --git a/js-wixcode-sdk/wix-window-frontend/ConsentPolicy.service.json b/js-wixcode-sdk/wix-window-frontend/ConsentPolicy.service.json index 11b6f9769d..bcf9ba9783 100644 --- a/js-wixcode-sdk/wix-window-frontend/ConsentPolicy.service.json +++ b/js-wixcode-sdk/wix-window-frontend/ConsentPolicy.service.json @@ -1,25 +1,26 @@ { "name": "ConsentPolicy", "memberOf": "wix-window-frontend", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": - { "lineno": 1258, + { "lineno": 1205, "filename": "window-frontend.js" }, "docs": - { "summary": "The ConsentPolicy API is used to perform actions related to the user's allowed cookies and 3rd-party data transfer, such as for GDPR or CCPA purposes.", + { "summary": "The ConsentPolicy API manages site visitor cookie preferences and 3rd-party data transfers for GDPR and CCPA compliance.", "description": - [ "The consent policy helps you comply with [GDPR](https://support.wix.com/en/article/preparing-your-wix-site-for-the-gdpr) and [CCPA](https://support.wix.com/en/article/preparing-your-wix-site-for-ccpa) regulations and lets your users", - "control their information. The site owner sets up the site consent policy and cookie consent banners in", - "the site's [Privacy Center](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Privacy%20Center&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcookie-consent-settings-app?referralInfo=corvid-docs).", + [ ">**Note:** The APIs in `wix-window-frontend.ConsentPolicy` can only be used in frontend code.", + "", + "The consent policy helps you comply with [GDPR](https://support.wix.com/en/article/preparing-your-wix-site-for-the-gdpr) and [CCPA](https://support.wix.com/en/article/preparing-your-wix-site-for-ccpa) regulations, and allows site visitors to", + "control their information. ", + "", + "Set up the site consent policy and cookie consent banners in", + "a site's [Privacy Center](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Privacy%20Center&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcookie-consent-settings-app?referralInfo=corvid-docs).", "", " To use the ConsentPolicy API, import `{ consentPolicy }` from the `wix-window-frontend` module:", "", " ```javascript", " import { consentPolicy } from 'wix-window-frontend';", - " ```", - "", - "The APIs in `wix-window-frontend.ConsentPolicy` can only be used in front-end code." ], + " ```" ], "links": [], "examples": [], "extra": @@ -27,21 +28,18 @@ "properties": [], "operations": [ { "name": "getCurrentConsentPolicy", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [], "ret": { "type": "wix-window-frontend.ConsentPolicy.PolicyDetails" }, "locations": - [ { "lineno": 1296, + [ { "lineno": 1249, "filename": "window-frontend.js" } ], "docs": - { "summary": "Gets the visitor's consent policy regarding allowed cookies and 3rd-party data transfer, such as for GDPR or CCPA purposes.", + { "summary": "Gets the site visitor's consent policy regarding allowed cookies and 3rd-party data transfers for GDPR or CCPA compliance.", "description": - [ "The `getCurrentConsentPolicy()` function returns the", - "consent policy details of the visitor, meaning, which cookies the visitor allows and whether data transfer", - "to 3rd parties is allowed." ], + [ "Retrieves the site visitor's consent policy details, including which cookies are allowed and whether data transfer to 3rd parties is permitted." ], "links": [], "examples": [ { "title": "Get a members's consent policy", @@ -74,8 +72,7 @@ "extra": { } }, { "name": "onConsentPolicyChanged", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "handler", @@ -84,23 +81,22 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 1367, + [ { "lineno": 1313, "filename": "window-frontend.js" } ], "docs": - { "summary": "Sets the function that runs\nwhen a visitor's consent policy was changed using\n[`setConsentPolicy()`](#setConsentPolicy) or reset using\n[`resetConsentPolicy()`](#resetConsentPolicy).", + { "summary": "Triggered when a site visitor's consent policy was changed using\n[`setConsentPolicy()`](https://dev.wix.com/docs/velo/api-reference/wix-window-frontend/consent-policy/set-consent-policy) or reset using\n[`resetConsentPolicy()`](https://dev.wix.com/docs/velo/api-reference/wix-window-frontend/consent-policy/reset-consent-policy).", "description": - [ "Use the `onConsentPolicyChanged()` function for code you want to run after", - "the visitor's current consent policy was changed using", + [ "Use the `onConsentPolicyChanged()` method for code you want to run after", + "the site visitor's current consent policy was changed using", "[`setConsentPolicy()`](#setConsentPolicy) or reset using", "[`resetConsentPolicy()`](#resetConsentPolicy).", "", "", - "Usually, you want to call the `onConsentPolicyChanged()` function in the **masterpage.js** file in the", - "code editor so that the `onConsentPolicyChanged()` event handler runs no matter which", + "Usually, you want to call the `onConsentPolicyChanged()` method in the **masterpage.js** file so that the `onConsentPolicyChanged()` event handler runs no matter which", "page on your site is used to change the policy." ], "links": [], "examples": - [ { "title": "Run code when a visitor's consent policy changed", + [ { "title": "Run code when a site visitor's consent policy changed", "body": [ "import { consentPolicy } from 'wix-window-frontend';", "", @@ -129,8 +125,7 @@ "extra": { } }, { "name": "resetConsentPolicy", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [], "ret": @@ -140,12 +135,10 @@ [ "void" ] }, "doc": "Fulfilled - When the reset is complete.\nRejected - Error message." }, "locations": - [ { "lineno": 1310, + [ { "lineno": 1261, "filename": "window-frontend.js" } ], "docs": - { "summary": "Removes the current policy from the visitor's browser\nand resets the visitor's consent policy to the default policy for the site.", - "description": - [ "The `resetConsentPolicy()` function returns a Promise that resolves when the policy is reset." ], + { "summary": "Removes the current policy from the site visitor's browser\nand resets the site visitor's consent policy to the default policy for the site.", "links": [], "examples": [ { "title": "Reset a visitor's consent policy", @@ -169,36 +162,31 @@ "extra": { } }, { "name": "setConsentPolicy", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "policy", "type": "wix-window-frontend.ConsentPolicy.Policy", - "doc": "An object representing the cookies of the visitor's consent policy." } ], + "doc": "An object representing the cookies of the site visitor's consent policy." } ], "ret": { "type": { "name": "Promise", "typeParams": [ "wix-window-frontend.ConsentPolicy.PolicyDetails" ] }, - "doc": "Fulfilled - All the details of the visitor's consent policy, including if the the current policy is the default site policy and the policy's allowed cookies.\nRejected - Error message." }, + "doc": "Fulfilled - All the details of the site visitor's consent policy, including if the the current policy is the default site policy and the policy's allowed cookies.\nRejected - Error message." }, "locations": - [ { "lineno": 1325, + [ { "lineno": 1275, "filename": "window-frontend.js" } ], "docs": - { "summary": "Sets the current visitor's consent policy\nregarding allowed cookies and data transfer to 3rd parties,\nsuch as for GDPR or CCPA purposes.", + { "summary": "Sets the current site visitor's consent policy\nregarding allowed cookies and data transfer to 3rd parties,\nsuch as for GDPR or CCPA purposes.", "description": - [ "The `setConsentPolicy()` function returns a Promise that resolves to the", - "consent policy details of the visitor.", - "", - "", - "You can use the [`onConsentPolicyChanged()`](#onConsentPolicyChanged) event to listen for", - "changes made when a visitor changes their consent policy with `setConsentPolicy()`. Handle", - "the policy change accordingly in the event handler's [ConsentPolicyChangedHandler callback function](#ConsentPolicyChangedHandler).", + [ "You can use the [`onConsentPolicyChanged()`](https://dev.wix.com/docs/velo/api-reference/wix-window-frontend/consent-policy/on-consent-policy-changed) event to listen for", + "changes made when a site visitor changes their consent policy with `setConsentPolicy()`. Handle", + "the policy change accordingly in the event handler.", "Changes to the consent policy take affect after the page is refreshed." ], "links": [], "examples": - [ { "title": "Set a visitor's consent policy", + [ { "title": "Set a site visitor's consent policy", "body": [ "import { consentPolicy } from 'wix-window-frontend';", "", @@ -242,8 +230,7 @@ { } } ], "callbacks": [ { "name": "ConsentPolicyChangedHandler", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "event", @@ -252,10 +239,10 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 1350, + [ { "lineno": 1296, "filename": "window-frontend.js" } ], "docs": - { "summary": "Function that runs when a user's consent policy was changed using [`setConsentPolicy()`](#setConsentPolicy).", + { "summary": "Function that runs when a site visitor's consent policy was changed using [`setConsentPolicy()`](#setConsentPolicy).", "links": [], "examples": [], "extra": @@ -265,7 +252,7 @@ "messages": [ { "name": "ConsentPolicyChangedEvent", "locations": - [ { "lineno": 1358, + [ { "lineno": 1304, "filename": "window-frontend.js" } ], "docs": { "summary": "The event that occurred when the consent policy changed.", @@ -304,15 +291,15 @@ "labels": [] }, { "name": "Policy", "locations": - [ { "lineno": 1406, + [ { "lineno": 1349, "filename": "window-frontend.js" } ], "docs": - { "summary": "The current user's consent policy settings.", + { "summary": "The current site visitor's consent policy settings.", "description": - [ "An object containing the consent policy cookie settings, by type, of the user currently viewing the site." ], + [ "An object containing the consent policy cookie settings, by type, of the site visitor currently viewing the site." ], "links": [], "examples": - [ { "title": "Get the current user's consent policy", + [ { "title": "Get the current site visitor's consent policy", "body": [ "import { consentPolicy } from 'wix-window-frontend';", "", @@ -342,32 +329,30 @@ "members": [ { "name": "essential", "type": "boolean", - "doc": "Consent for mandatory cookies for Wix websites, such as for security cookies. Wix places these cookies on your device and these cookies do not require user consent. Always `true`." }, + "doc": "Consent for mandatory cookies for Wix websites, such as for security cookies. Wix places these cookies on the site visitor's device. These cookies don't require site visitor consent. Always `true`." }, { "name": "functional", "type": "boolean", - "doc": "Consent for cookies placed on the user's device that \"remember\" user settings to improve user experience. For example, an indication that the user dismissed a popup. The default is `true`." }, + "doc": "Consent for cookies placed on the site visitor's device that \"remember\" their user settings to improve user experience. For example, an indication that the user dismissed a popup. Default: `true`." }, { "name": "analytics", "type": "boolean", - "doc": "Consent for cookies used for analytics, such as Wix analytics, Google Analytics, Yandex Metrica, and so on. The default is `true`." }, + "doc": "Consent for cookies used for analytics, such as Wix analytics, Google Analytics, Yandex Metrica, and so on. Default: `true`." }, { "name": "advertising", "type": "boolean", - "doc": "Consent for cookies used for advertising purposes. This includes 3rd-party scripts and pixels that may potentially place advertising cookies on the device (such as Twitter page view and Facebook Pixel). The default is `true`." }, + "doc": "Consent for cookies used for advertising purposes. This includes 3rd-party scripts and pixels that may potentially place advertising cookies on the device. For example, Twitter page view and Facebook Pixel. Default: `true`." }, { "name": "dataToThirdParty", "type": "boolean", - "doc": "Consent for a user's personal data to be transferred to a 3rd party (such as Google Analytics, Facebook Pixel, and FullStory). The default is `true`." } ], + "doc": "Consent for a site visitor's personal data to be transferred to a 3rd party. For example, Google Analytics, Facebook Pixel, and FullStory. Default: `true`." } ], "extra": { }, - "labels": - [ "changed" ] }, + "labels": [] }, { "name": "PolicyDetails", "locations": - [ { "lineno": 1393, + [ { "lineno": 1337, "filename": "window-frontend.js" } ], "docs": - { "summary": "The complete details of the current user's consent policy.", + { "summary": "The complete details of the current site visitor's consent policy.", "description": - [ "An object containing all the details about the consent policy of the user currently viewing the site.", - " This is returned in the Promise of the `setConsentPolicy()` function." ], + [ "An object containing all the details about the consent policy of the site visitor currently viewing the site." ], "links": [], "examples": [], "extra": @@ -375,17 +360,16 @@ "members": [ { "name": "defaultPolicy", "type": "boolean", - "doc": "Whether the policy is the default consent policy set by the site owner. If `true`, either the user has not set a policy or the site owner has reset the policy." }, + "doc": "Whether the current consent policy is the default one you set. If `true`, either the site visitor hasn't set a policy, or you’ve reset it to its default settings." }, { "name": "policy", "type": "wix-window-frontend.ConsentPolicy.Policy", - "doc": "An object representing the user's current consent policy." }, + "doc": "An object representing the site visitor's current consent policy." }, { "name": "createdDate", "type": "Date", - "doc": "If a cookie exists in the browser defining the current consent policy, the date the policy was set. Otherwise, undefined.", + "doc": "The date the consent policy was set, if a cookie defining the current policy exists in the browser. Otherwise, it's undefined.", "optional": true } ], "extra": { }, - "labels": - [ "changed" ] } ], + "labels": [] } ], "extra": { } } \ No newline at end of file diff --git a/js-wixcode-sdk/wix-window-frontend/Lightbox.service.json b/js-wixcode-sdk/wix-window-frontend/Lightbox.service.json index 017964f19f..57cd04051a 100644 --- a/js-wixcode-sdk/wix-window-frontend/Lightbox.service.json +++ b/js-wixcode-sdk/wix-window-frontend/Lightbox.service.json @@ -1,15 +1,14 @@ { "name": "Lightbox", "memberOf": "wix-window-frontend", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": - { "lineno": 327, + { "lineno": 313, "filename": "window-frontend.js" }, "docs": - { "summary": "A [lightbox](https://support.wix.com/en/article/about-lightboxes) pops up on your site to grab your visitor's attention.", + { "summary": "A [lightbox](https://support.wix.com/en/article/about-lightboxes) pops up on a site to grab a site visitor's attention.", "description": - [ "Get hands-on experience with Lightboxes on our [Hello Lightboxes](https://www.wix.com/velo/example/hello-lightboxes) example page.", + [ "To learn more about lightboxes, see the [Hello Lightboxes](https://www.wix.com/velo/example/hello-lightboxes) example page.", "", " To use the Lightbox API, import `wixWindowFrontend` from the `wix-window-frontend` module:", "", @@ -17,7 +16,7 @@ " import wixWindowFrontend from 'wix-window-frontend';", " ```", "", - "The APIs in `wix-window-frontend.Lightbox` can only be used in front-end code." ], + "The APIs in `wix-window-frontend.Lightbox` can only be used in frontend code." ], "links": [], "examples": [ { "title": "Set the lightbox to close after 6 seconds", @@ -38,37 +37,30 @@ "properties": [], "operations": [ { "name": "close", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "data", "type": "Object", - "doc": "The data to pass back to [`openLightbox()`](wix-window-frontend.html#openLightbox) function.", + "doc": "The data to pass back to the [`openLightbox()`](https://dev.wix.com/docs/velo/api-reference/wix-window-frontend/open-lightbox) method.", "optional": true } ], "ret": { "type": "void" }, "locations": - [ { "lineno": 64, + [ { "lineno": 56, "filename": "window-frontend.js" } ], "docs": - { "summary": "Closes the lightbox.", + { "summary": "Closes a lightbox.", "description": - [ "The `close()` function closes the lightbox and returns the given data to the", - " [`openLightbox()`](wix-window-frontend.html#openLightbox) function that was used to", - " open the lightbox.", + [ "The `close()` method closes a lightbox and allows you to pass data from the lightbox to the page that opened the lightbox. ", + " If a lightbox is closed through the 'X' icon, close button, or lightbox overlay, data will not be returned to the original page. ", "", - " To pass data back to the page that opened the lightbox, you must close the", - " lightbox programmatically using the `close()` function. If the lightbox is", - " closed by the site visitor clicking the 'X' icon, close button, or lightbox", - " overlay, data will not be passed back the the page that opened the lightbox.", - " Therefore, if you want to make sure data is passed back to the page that", - " opened the lightbox, [disable all of the methods mentioned above](https://support.wix.com/en/article/wix-editor-adding-and-setting-up-a-lightbox#step-4-choose-how-visitors-close-the-lightbox) and create your own method for closing", - " the lightbox programmatically. For example, you can add a button with an `onClick` event", - " handler that calls the `close()` function." ], + " To ensure data can be passed:", + " 1. Call this method to close a lightbox programmatically. For example, add a button with an `onClick` event handler that calls `close()`.", + " 2. Disable these closing options in the lightbox's settings under [**Set Triggers**](https://support.wix.com/en/article/studio-editor-using-lightboxes#setting-triggers-for-a-lightbox)." ], "links": [], "examples": - [ { "title": "Close the lightbox", + [ { "title": "Close a lightbox", "body": [ "import wixWindowFrontend from 'wix-window-frontend';", "", @@ -77,7 +69,7 @@ "wixWindowFrontend.lightbox.close();" ], "extra": { } }, - { "title": "Close the lightbox and pass back data to the opening function", + { "title": "Close a lightbox and pass back the data", "body": [ "import wixWindowFrontend from 'wix-window-frontend';", "", @@ -86,7 +78,7 @@ "wixWindowFrontend.lightbox.close(dataObj);" ], "extra": { } }, - { "title": "Open and close a lightbox, and send information between the lightbox and the page", + { "title": "Open and close a lightbox, and send information between the lightbox and a page", "body": [ "/******************", " * Home Page Code *", @@ -130,7 +122,7 @@ "", "" ], "extra": - { "description": "In this example, we demonstrate how to open and close a lightbox using code, as well as how to send information from the page to the lightbox and from the lightbox to the page. \n You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=36f51075-ed17-41e6-aea6-68f9ca7de0be&templateId=63b643a6-6dc1-43ed-ad90-025371ca06fd&autoDevMode=true)." } }, + { "description": "This example demonstrates how to open and close a lightbox using code, as well as how to send information from a page to a lightbox and from a lightbox to a page. \n Test the code in the [example template](https://manage.wix.com/edit-template/from?originTemplateId=36f51075-ed17-41e6-aea6-68f9ca7de0be&templateId=63b643a6-6dc1-43ed-ad90-025371ca06fd&autoDevMode=true)." } }, { "title": "A scenario where information is passed between a page and a lightbox", "body": [ "/*************", @@ -170,14 +162,13 @@ "}", "" ], "extra": - { "description": "This example demonstrates how to pass data from a page to a lightbox that\n it opens and from the lightbox back to the page as it closes.\n\n It assumes that the page has:\n\n + An open button that is used to open the lightbox.\n + Two text inputs where information that is to be passed to the lightbox is entered.\n + Two text elements where information that is passed from the lightbox is displayed.\n\n\n It assumes that the lightbox has:\n\n + A close button that is used to close the lightbox.\n + Two text inputs where information that is to be passed to the page is entered.\n + Two text elements where information that is passed from the page is displayed." } } ], + { "description": "This example demonstrates how to pass data from a page to an opened lightbox and back to the page when the lightbox closes.\n\n It assumes that the page has:\n\n + An open button to open the lightbox.\n + Two text inputs where information to be passed to the lightbox is entered.\n + Two text elements to display information passed from the lightbox.\n\n\n It assumes that the lightbox has:\n\n + A close button to close the lightbox.\n + Two text inputs where information to be passed to the page is entered.\n + Two text elements to display information passed from the page." } } ], "extra": { } }, "extra": { } }, { "name": "getContext", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [], "ret": @@ -187,26 +178,17 @@ [ { "lineno": 20, "filename": "window-frontend.js" } ], "docs": - { "summary": "Returns the data object that was passed to a lightbox.", + { "summary": "Gets the data object that was passed to a lightbox.", "description": - [ "The `getContext()` function returns the data object passed when the lightbox", - " was opened using the [`openLightbox()`](wix-window-frontend.html#openLightbox) function,", - " if any data was passed. If the lightbox was opened another way,", - " `getContext()` returns `undefined`.", + [ "Retrieves the data object, if any, that was passed when a lightbox", + " was opened via the [`openLightbox()`](https://dev.wix.com/docs/velo/api-reference/wix-window-frontend/open-lightbox) method.", + " If a lightbox was opened in any other way, `getContext()` returns `undefined`.", "", - " To pass data to the lightbox that is opened, you must open the lightbox", - " programmatically using the [`openLightbox()`](wix-window-frontend.html#openLightbox)", - " function. If the lightbox is opened automatically when the page loads or", - " by a link from a page element, data will not be passed to the lightbox.", - " Therefore, if you want to pass data to the lightbox, make sure", - " **Automatically display lightbox on pages** is [set](https://support.wix.com/en/article/wix-editor-adding-and-setting-up-a-lightbox#step-3-set-the-lightbox-trigger) to **No** in the", - " **Lightbox Settings** panel in the Editor and don't set any element's link", - " to open the lightbox. Instead, create your own method for opening", - " the lightbox programmatically. For example, you can add a button with an `onClick` event", - " handler that calls the [`openLightbox()`](wix-window-frontend.html#openLightbox) function." ], + " To pass data to a lightbox, it must be opened programmatically using the [`openLightbox()`](https://dev.wix.com/docs/velo/api-reference/wix-window-frontend/open-lightbox)", + " method. Lightboxes that are opened automatically on page load, or via a link from a page element don't receive passed data." ], "links": [], "examples": - [ { "title": "Get the data that was passed to the lightbox", + [ { "title": "Get the data that was passed to a lightbox", "body": [ "import wixWindowFrontend from 'wix-window-frontend';", "", @@ -215,7 +197,7 @@ "let receivedData = wixWindowFrontend.lightbox.getContext();" ], "extra": { } }, - { "title": "Open and close a lightbox, and send information between the lightbox and the page", + { "title": "Open and close a lightbox, and send information between a lightbox and a page", "body": [ "/******************", " * Home Page Code *", @@ -259,7 +241,7 @@ "", "" ], "extra": - { "description": "In this example, we demonstrate how to open and close a lightbox using code, as well as how to send information from the page to the lightbox and from the lightbox to the page. \n You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=36f51075-ed17-41e6-aea6-68f9ca7de0be&templateId=63b643a6-6dc1-43ed-ad90-025371ca06fd&autoDevMode=true)." } }, + { "description": "This example demonstrates how to open and close a lightbox using code, as well as how to send information from a page to a lightbox and from a lightbox to a page. \n Test the code in the [example template](https://manage.wix.com/edit-template/from?originTemplateId=36f51075-ed17-41e6-aea6-68f9ca7de0be&templateId=63b643a6-6dc1-43ed-ad90-025371ca06fd&autoDevMode=true)." } }, { "title": "A scenario where information is passed between a page and a lightbox", "body": [ "/*************", @@ -299,7 +281,7 @@ "}", "" ], "extra": - { "description": "This example demonstrates how to pass data from a page to a lightbox that\n it opens and from the lightbox back to the page as it closes.\n\n It assumes that the page has:\n\n + An open button that is used to open the lightbox.\n + Two text inputs where information that is to be passed to the lightbox is entered.\n + Two text elements where information that is passed from the lightbox is displayed.\n\n\n It assumes that the lightbox has:\n\n + A close button that is used to close the lightbox.\n + Two text inputs where information that is to be passed to the page is entered.\n + Two text elements where information that is passed from the page is displayed." } } ], + { "description": "This example demonstrates how to pass data from a page to a lightbox when it opens,\n and back to the page when it closes.\n\n It assumes that the page has:\n\n + An open button to open the lightbox.\n + Two text inputs where information to be passed to the lightbox is entered.\n + Two text elements to display information passed from the lightbox.\n\n\n It assumes that the lightbox has:\n\n + A close button to close the lightbox.\n + Two text inputs where information to be passed to the page is entered.\n + Two text elements to display information passed from the page." } } ], "extra": { } }, "extra": diff --git a/js-wixcode-sdk/wix-window-frontend/Multilingual.service.json b/js-wixcode-sdk/wix-window-frontend/Multilingual.service.json index 8f7c80c9f2..29f8e827c3 100644 --- a/js-wixcode-sdk/wix-window-frontend/Multilingual.service.json +++ b/js-wixcode-sdk/wix-window-frontend/Multilingual.service.json @@ -3,7 +3,7 @@ "mixes": [], "labels": [], "location": - { "lineno": 1100, + { "lineno": 1047, "filename": "window-frontend.js" }, "docs": { "summary": "The Multilingual API is used when working with languages in a multilingual site.", @@ -30,9 +30,9 @@ "set": true, "type": "string", "locations": - [ { "lineno": 1101, + [ { "lineno": 1048, "filename": "window-frontend.js" }, - { "lineno": 1149, + { "lineno": 1096, "filename": "window-frontend.js" } ], "docs": { "summary": "Sets or gets a site's current display language.", @@ -135,7 +135,7 @@ "set": false, "type": "boolean", "locations": - [ { "lineno": 1092, + [ { "lineno": 1039, "filename": "window-frontend.js" } ], "docs": { "summary": "Gets whether a site has been set up to be shown in multiple languages.", @@ -163,7 +163,7 @@ "typeParams": [ "wix-window-frontend.Multilingual.SiteLanguage" ] }, "locations": - [ { "lineno": 1231, + [ { "lineno": 1178, "filename": "window-frontend.js" } ], "docs": { "summary": "Gets information about a site's languages.", @@ -240,7 +240,7 @@ "messages": [ { "name": "SiteLanguage", "locations": - [ { "lineno": 1204, + [ { "lineno": 1151, "filename": "window-frontend.js" } ], "docs": { "summary": "An object returned by the `siteLanguages` property that contains information about a site's languages.", diff --git a/js-wixcode-sdk/wix-window-frontend/Rendering.service.json b/js-wixcode-sdk/wix-window-frontend/Rendering.service.json index 59f7e22ffc..ded1ee0c8f 100644 --- a/js-wixcode-sdk/wix-window-frontend/Rendering.service.json +++ b/js-wixcode-sdk/wix-window-frontend/Rendering.service.json @@ -3,7 +3,7 @@ "mixes": [], "labels": [], "location": - { "lineno": 275, + { "lineno": 261, "filename": "window-frontend.js" }, "docs": { "summary": "The Rendering API is used to control when code is run as a page is being loaded.", @@ -32,7 +32,7 @@ "set": false, "type": "string", "locations": - [ { "lineno": 103, + [ { "lineno": 89, "filename": "window-frontend.js" } ], "docs": { "summary": "Gets the current environment the rendering process is running in.", diff --git a/js-wixcode-sdk/wix-window-frontend/WarmupData.service.json b/js-wixcode-sdk/wix-window-frontend/WarmupData.service.json index 89eda48107..8bf5065165 100644 --- a/js-wixcode-sdk/wix-window-frontend/WarmupData.service.json +++ b/js-wixcode-sdk/wix-window-frontend/WarmupData.service.json @@ -3,7 +3,7 @@ "mixes": [], "labels": [], "location": - { "lineno": 129, + { "lineno": 115, "filename": "window-frontend.js" }, "docs": { "summary": "The Warmup Data API is used to optimize data loading for sites that render both on the server and in the browser, \n allowing costly data fetching operations to be done only once.", @@ -52,7 +52,7 @@ { "type": "*", "doc": "Returns one of the following: \n + The data corresponding to the `key` that was set with the `warmupData.set()` function in the backend.\n + `undefined` if not yet set.\n + `null` if called while on the server." }, "locations": - [ { "lineno": 234, + [ { "lineno": 220, "filename": "window-frontend.js" } ], "docs": { "summary": "Gets data from server-side code for use in client-side code.", @@ -126,7 +126,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 201, + [ { "lineno": 187, "filename": "window-frontend.js" } ], "docs": { "summary": "Sets data in server-side code for use in client-side code.", diff --git a/js-wixcode-sdk/wix-window.service.json b/js-wixcode-sdk/wix-window.service.json index 9f49878a08..1147df61d7 100644 --- a/js-wixcode-sdk/wix-window.service.json +++ b/js-wixcode-sdk/wix-window.service.json @@ -67,7 +67,7 @@ "set": false, "type": "wix-window.ConsentPolicy", "locations": - [ { "lineno": 1351, + [ { "lineno": 1345, "filename": "window.js" } ], "docs": { "summary": "The ConsentPolicy API is used to perform actions related to the user's allowed cookies and 3rd-party data transfer, such as for GDPR or CCPA purposes.", @@ -243,7 +243,7 @@ "set": false, "type": "wix-window.Multilingual", "locations": - [ { "lineno": 1193, + [ { "lineno": 1187, "filename": "window.js" } ], "docs": { "summary": "The Multilingual API is used when working with the languages in a multilingual site.", @@ -483,7 +483,7 @@ { "type": "Object", "doc": "The data passed to the app page." }, "locations": - [ { "lineno": 1519, + [ { "lineno": 1513, "filename": "window.js" } ], "docs": { "summary": "Returns the data passed to a [custom app page]().", @@ -565,7 +565,7 @@ [ "wix-window.CurrentGeolocation" ] }, "doc": "Fulfilled - An object containing the coordinates and timestamp of the current location.\nRejected - The user blocked the geolocation popup." }, "locations": - [ { "lineno": 720, + [ { "lineno": 714, "filename": "window.js" } ], "docs": { "summary": "Returns the current geolocation of the user.", @@ -615,7 +615,7 @@ { "type": "Object", "doc": "The data returned by the router." }, "locations": - [ { "lineno": 701, + [ { "lineno": 695, "filename": "window.js" } ], "docs": { "summary": "Returns the data that a router passed to the page in its response.", @@ -662,7 +662,7 @@ [ "Object" ] }, "doc": "Fulfilled - The returned data from the lightbox.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 742, + [ { "lineno": 736, "filename": "window.js" } ], "docs": { "summary": "Opens a lightbox and optionally passes it the given data.", @@ -852,7 +852,7 @@ [ "void" ] }, "doc": "Fulfilled - When the modal window is closed.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 1124, + [ { "lineno": 1118, "filename": "window.js" } ], "docs": { "summary": "Opens a modal window that displays the specified web page.", @@ -918,7 +918,7 @@ [ "Object" ] }, "doc": "Fulfilled - The data returned from the page's parent.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 1149, + [ { "lineno": 1143, "filename": "window.js" } ], "docs": { "summary": "Sends a message to the page's parent.", @@ -1001,7 +1001,7 @@ [ "void" ] }, "doc": "Fulfilled - When the scroll is complete." }, "locations": - [ { "lineno": 681, + [ { "lineno": 675, "filename": "window.js" } ], "docs": { "summary": "Scrolls the page by a given number of pixels.", @@ -1064,20 +1064,13 @@ [ { "lineno": 651, "filename": "window.js" } ], "docs": - { "summary": "Scrolls the page to a specific location on the page.", + { "summary": "Scrolls a page to the specified location.", "description": - [ "The `scrollTo()` function returns a Promise that resolves when the current", - " page has been scrolled to a given location on the page.", + [ "The `x` and `y` parameters determine the top-left pixel that is displayed on screen after the scroll.", "", - " The `x` and `y` parameters determine the top-left pixel that is", - " displayed on screen after the scroll.", "", - " > **Tip**: To get the coordinates for scrolling, display the Wix Editor Toolbar. In the Editor, ", - " move the cursor to the top-left pixel where you want the page to scroll to. The **X** ", - " and **Y** axis **Position** values show the coordinates.", + "> **Tip**: To get the coordinates for scrolling, click on an element to open the [Inspector panel](https://support.wix.com/en/article/studio-editor-using-the-inspector-panel) (Wix Studio), or open the [Editor toolbar](https://support.wix.com/en/article/wix-editor-using-the-editor-toolbar-to-adjust-elements) (Wix Editor). Then move the cursor to the top-left pixel where you want the page to scroll to. The **X** and **Y** axis **Position** values show the coordinates.", "", - " To scroll to a specific element on the page, see the `$w.Node`", - " [`scrollTo()`]($w.Node.html) function.", "", " Use the `options` parameter to specify the options to use when scrolling." ], "links": [], @@ -1141,7 +1134,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 1055, + [ { "lineno": 1049, "filename": "window.js" } ], "docs": { "summary": "Sends a tracking event to external analytics tools.", @@ -1340,7 +1333,7 @@ "labels": [] }, { "name": "CustomType", "locations": - [ { "lineno": 921, + [ { "lineno": 915, "filename": "window.js" } ], "docs": { "summary": "A custom parameter used when sending a CustomEvent track event.", @@ -1393,7 +1386,7 @@ "labels": [] }, { "name": "OpenModalOptions", "locations": - [ { "lineno": 1114, + [ { "lineno": 1108, "filename": "window.js" } ], "docs": { "summary": "An object used when opening a modal window.", @@ -1570,7 +1563,7 @@ "labels": [] }, { "name": "trackingParameters", "locations": - [ { "lineno": 812, + [ { "lineno": 806, "filename": "window.js" } ], "docs": { "summary": "Objects used when calling the [`trackEvent()`](wix-window.html#trackEvent) function.", @@ -1634,7 +1627,7 @@ "labels": [] }, { "name": "trackingParametersAddPaymentInfoEvent", "locations": - [ { "lineno": 805, + [ { "lineno": 799, "filename": "window.js" } ], "docs": { "summary": "An object used when sending an `AddPaymentInfo` track event.", @@ -1658,7 +1651,7 @@ "labels": [] }, { "name": "trackingParametersAddProductImpressionEvent", "locations": - [ { "lineno": 842, + [ { "lineno": 836, "filename": "window.js" } ], "docs": { "summary": "An object used when sending an AddProductImpression track event.", @@ -1713,7 +1706,7 @@ "labels": [] }, { "name": "trackingParametersAddProductImpressionEventContents", "locations": - [ { "lineno": 852, + [ { "lineno": 846, "filename": "window.js" } ], "docs": { "summary": "An object used when sending an AddProductImpression track event.", @@ -1797,7 +1790,7 @@ "labels": [] }, { "name": "trackingParametersAddToCartEvent", "locations": - [ { "lineno": 870, + [ { "lineno": 864, "filename": "window.js" } ], "docs": { "summary": "An object used when sending an AddToCart track event.", @@ -1873,7 +1866,7 @@ "labels": [] }, { "name": "trackingParametersCheckoutStepEvent", "locations": - [ { "lineno": 889, + [ { "lineno": 883, "filename": "window.js" } ], "docs": { "summary": "An object used when sending an CheckoutStep track event.", @@ -1916,7 +1909,7 @@ "labels": [] }, { "name": "trackingParametersClickProductEvent", "locations": - [ { "lineno": 902, + [ { "lineno": 896, "filename": "window.js" } ], "docs": { "summary": "An object used when sending a ClickProduct track event.", @@ -1991,7 +1984,7 @@ "labels": [] }, { "name": "trackingParametersCustomEvent", "locations": - [ { "lineno": 928, + [ { "lineno": 922, "filename": "window.js" } ], "docs": { "summary": "An object used when sending a CustomEvent track event.", @@ -2047,7 +2040,7 @@ "labels": [] }, { "name": "trackingParametersInitiateCheckoutEvent", "locations": - [ { "lineno": 941, + [ { "lineno": 935, "filename": "window.js" } ], "docs": { "summary": "An object used when sending an InitiateCheckout track event.", @@ -2100,7 +2093,7 @@ "labels": [] }, { "name": "trackingParametersInitiateCheckoutEventContents", "locations": - [ { "lineno": 951, + [ { "lineno": 945, "filename": "window.js" } ], "docs": { "summary": "An object used when sending an InitiateCheckout track event.", @@ -2178,7 +2171,7 @@ "labels": [] }, { "name": "trackingParametersLeadEvent", "locations": - [ { "lineno": 967, + [ { "lineno": 961, "filename": "window.js" } ], "docs": { "summary": "An object used when sending a Lead track event.", @@ -2205,7 +2198,7 @@ "labels": [] }, { "name": "trackingParametersPurchaseEvent", "locations": - [ { "lineno": 976, + [ { "lineno": 970, "filename": "window.js" } ], "docs": { "summary": "An object used when sending a Purchase track event.", @@ -2280,7 +2273,7 @@ "labels": [] }, { "name": "trackingParametersPurchaseEventContents", "locations": - [ { "lineno": 992, + [ { "lineno": 986, "filename": "window.js" } ], "docs": { "summary": "An object used when sending an Purchase track event.", @@ -2352,7 +2345,7 @@ "labels": [] }, { "name": "trackingParametersRemoveFromCartEvent", "locations": - [ { "lineno": 1008, + [ { "lineno": 1002, "filename": "window.js" } ], "docs": { "summary": "An object used when sending a RemoveFromCart track event.", @@ -2424,7 +2417,7 @@ "labels": [] }, { "name": "trackingParametersStartPaymentEvent", "locations": - [ { "lineno": 1026, + [ { "lineno": 1020, "filename": "window.js" } ], "docs": { "summary": "An object used when sending an StartPayment track event.", @@ -2457,7 +2450,7 @@ "labels": [] }, { "name": "trackingParametersViewContentEvent", "locations": - [ { "lineno": 1036, + [ { "lineno": 1030, "filename": "window.js" } ], "docs": { "summary": "An object used when sending a ViewContent track event.", diff --git a/js-wixcode-sdk/wix-window/ConsentPolicy.service.json b/js-wixcode-sdk/wix-window/ConsentPolicy.service.json index 51b9ef63e3..d445cce809 100644 --- a/js-wixcode-sdk/wix-window/ConsentPolicy.service.json +++ b/js-wixcode-sdk/wix-window/ConsentPolicy.service.json @@ -3,7 +3,7 @@ "mixes": [], "labels": [], "location": - { "lineno": 1333, + { "lineno": 1327, "filename": "window.js" }, "docs": { "summary": "The ConsentPolicy API is used to perform actions related to the user's allowed cookies and 3rd-party data transfer, such as for GDPR or CCPA purposes.", @@ -32,7 +32,7 @@ "ret": { "type": "wix-window.ConsentPolicy.PolicyDetails" }, "locations": - [ { "lineno": 1371, + [ { "lineno": 1365, "filename": "window.js" } ], "docs": { "summary": "Gets the visitor's consent policy regarding allowed cookies and 3rd-party data transfer, such as for GDPR or CCPA purposes.", @@ -88,7 +88,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 1460, + [ { "lineno": 1454, "filename": "window.js" } ], "docs": { "summary": "Sets the function that runs\nwhen a visitor's consent policy was changed using\n[`setConsentPolicy()`](#setConsentPolicy) or reset using\n[`resetConsentPolicy()`](#resetConsentPolicy).", @@ -149,7 +149,7 @@ [ "void" ] }, "doc": "Fulfilled - When the reset is complete.\nRejected - Error message." }, "locations": - [ { "lineno": 1391, + [ { "lineno": 1385, "filename": "window.js" } ], "docs": { "summary": "Removes the current policy from the visitor's browser\nand resets the visitor's consent policy to the default policy for the site.", @@ -198,7 +198,7 @@ [ "wix-window.ConsentPolicy.PolicyDetails" ] }, "doc": "Fulfilled - All the details of the visitor's consent policy, including if the the current policy is the default site policy and the policy's allowed cookies.\nRejected - Error message." }, "locations": - [ { "lineno": 1412, + [ { "lineno": 1406, "filename": "window.js" } ], "docs": { "summary": "Sets the current visitor's consent policy\nregarding allowed cookies and data transfer to 3rd parties,\nsuch as for GDPR or CCPA purposes.", @@ -272,7 +272,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 1443, + [ { "lineno": 1437, "filename": "window.js" } ], "docs": { "summary": "Function that runs when a user's consent policy was changed using [`setConsentPolicy()`](#setConsentPolicy).", @@ -285,7 +285,7 @@ "messages": [ { "name": "ConsentPolicyChangedEvent", "locations": - [ { "lineno": 1451, + [ { "lineno": 1445, "filename": "window.js" } ], "docs": { "summary": "The event that occurred when the consent policy changed.", @@ -324,7 +324,7 @@ "labels": [] }, { "name": "Policy", "locations": - [ { "lineno": 1505, + [ { "lineno": 1499, "filename": "window.js" } ], "docs": { "summary": "The current user's consent policy settings.", @@ -380,7 +380,7 @@ "labels": [] }, { "name": "PolicyDetails", "locations": - [ { "lineno": 1492, + [ { "lineno": 1486, "filename": "window.js" } ], "docs": { "summary": "The complete details of the current user's consent policy.", diff --git a/js-wixcode-sdk/wix-window/Multilingual.service.json b/js-wixcode-sdk/wix-window/Multilingual.service.json index 3516c0b0a2..52a58c553f 100644 --- a/js-wixcode-sdk/wix-window/Multilingual.service.json +++ b/js-wixcode-sdk/wix-window/Multilingual.service.json @@ -3,7 +3,7 @@ "mixes": [], "labels": [], "location": - { "lineno": 1175, + { "lineno": 1169, "filename": "window.js" }, "docs": { "summary": "The Multilingual API is used when working with the languages in a multilingual site.", @@ -30,9 +30,9 @@ "set": true, "type": "string", "locations": - [ { "lineno": 1176, + [ { "lineno": 1170, "filename": "window.js" }, - { "lineno": 1224, + { "lineno": 1218, "filename": "window.js" } ], "docs": { "summary": "Sets or gets the site's current display language.", @@ -135,7 +135,7 @@ "set": false, "type": "boolean", "locations": - [ { "lineno": 1167, + [ { "lineno": 1161, "filename": "window.js" } ], "docs": { "summary": "Gets whether the site has been set up to be shown in multiple languages.", @@ -163,7 +163,7 @@ "typeParams": [ "wix-window.Multilingual.SiteLanguage" ] }, "locations": - [ { "lineno": 1306, + [ { "lineno": 1300, "filename": "window.js" } ], "docs": { "summary": "Gets information about the site's languages.", @@ -240,7 +240,7 @@ "messages": [ { "name": "SiteLanguage", "locations": - [ { "lineno": 1279, + [ { "lineno": 1273, "filename": "window.js" } ], "docs": { "summary": "An object returned by the `siteLanguages` property that contains information about the site's languages.",