Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions js-wixcode-sdk/$w/AppointmentField.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
"$w.FocusMixin",
"$w.ClickableMixin",
"$w.RequiredMixin" ],
"labels":
[ "changed" ],
"labels": [],
"location":
{ "lineno": 1,
"filename": "AppointmentField.js" },
Expand Down Expand Up @@ -361,8 +360,7 @@
"extra":
{ } },
{ "name": "value",
"labels":
[ "changed" ],
"labels": [],
"get": true,
"set": true,
"type": "Date",
Expand Down Expand Up @@ -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)" ],
Expand Down
13 changes: 5 additions & 8 deletions js-wixcode-sdk/$w/Button.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@
"$w.LabelMixin",
"$w.EffectsMixin",
"$w.FocusMixin" ],
"labels":
[ "changed" ],
"labels": [],
"location":
{ "lineno": 1,
"filename": "Button.js" },
Expand Down Expand Up @@ -172,8 +171,7 @@
"extra":
{ } },
{ "name": "label",
"labels":
[ "changed" ],
"labels": [],
"get": true,
"set": true,
"type": "string",
Expand All @@ -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",
Expand Down Expand Up @@ -478,8 +476,7 @@
"extra":
{ } },
{ "name": "onMouseOut",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params":
[ { "name": "handler",
Expand Down Expand Up @@ -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';",
"});" ],
Expand Down
5 changes: 2 additions & 3 deletions js-wixcode-sdk/$w/CustomClassList.service.json
Original file line number Diff line number Diff line change
@@ -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.",
Expand Down
8 changes: 3 additions & 5 deletions js-wixcode-sdk/$w/Dataset.service.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{ "name": "Dataset",
"memberOf": "$w",
"mixes": [],
"labels":
[ "changed" ],
"labels": [],
"location":
{ "lineno": 1,
"filename": "datasetApi.js" },
Expand Down Expand Up @@ -811,8 +810,7 @@
"extra":
{ } },
{ "name": "loadPage",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params":
[ { "name": "pageIndex",
Expand All @@ -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.",
Expand Down
8 changes: 3 additions & 5 deletions js-wixcode-sdk/$w/DatePicker.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@
"$w.ReadOnlyMixin",
"$w.ClickableMixin",
"$w.RequiredMixin" ],
"labels":
[ "changed" ],
"labels": [],
"location":
{ "lineno": 1,
"filename": "DatePicker.js" },
Expand Down Expand Up @@ -607,8 +606,7 @@
"extra":
{ } },
{ "name": "value",
"labels":
[ "changed" ],
"labels": [],
"get": true,
"set": true,
"type": "Date",
Expand All @@ -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":
Expand Down
8 changes: 3 additions & 5 deletions js-wixcode-sdk/$w/Dropdown.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@
"$w.ClickableMixin",
"$w.StyleMixin",
"$w.RequiredMixin" ],
"labels":
[ "changed" ],
"labels": [],
"location":
{ "lineno": 1,
"filename": "DropDown.js" },
Expand Down Expand Up @@ -304,8 +303,7 @@
"extra":
{ } },
{ "name": "value",
"labels":
[ "changed" ],
"labels": [],
"get": true,
"set": true,
"type": "string",
Expand All @@ -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":
Expand Down
8 changes: 3 additions & 5 deletions js-wixcode-sdk/$w/Element.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
"mixes":
[ "$w.Node",
"$w.ViewportMixin" ],
"labels":
[ "changed" ],
"labels": [],
"location":
{ "lineno": 1,
"filename": "Element.js" },
Expand Down Expand Up @@ -42,8 +41,7 @@
{ } },
"properties":
[ { "name": "customClassList",
"labels":
[ "changed" ],
"labels": [],
"get": true,
"set": false,
"type": "$w.CustomClassList",
Expand All @@ -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.",
Expand Down
14 changes: 7 additions & 7 deletions js-wixcode-sdk/$w/Gallery.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
[ "$w.Element",
"$w.HiddenCollapsedMixin",
"$w.PlayableMixin" ],
"labels":
[ "changed" ],
"labels": [],
"location":
{ "lineno": 43,
"filename": "BaseGallery.js" },
Expand Down Expand Up @@ -476,8 +475,7 @@
"extra":
{ } },
{ "name": "navigateToIndex",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params":
[ { "name": "index",
Expand All @@ -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)",
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down
33 changes: 23 additions & 10 deletions js-wixcode-sdk/$w/Menu.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
"mixes":
[ "$w.Element",
"$w.HiddenCollapsedMixin" ],
"labels":
[ "changed" ],
"labels": [],
"location":
{ "lineno": 1,
"filename": "Menu.js" },
Expand All @@ -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, ",
Expand All @@ -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.",
"",
"</blockquote>" ],
"</blockquote>",
"",
"### 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":
Expand All @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down
27 changes: 20 additions & 7 deletions js-wixcode-sdk/$w/MultiStateBox.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -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).",
"",
Expand All @@ -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.",
Expand All @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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":
Expand All @@ -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.",
Expand Down
Loading