Skip to content

Commit

Permalink
Merge branch 'master' into fixCommentCreateExample-docbugAG
Browse files Browse the repository at this point in the history
  • Loading branch information
AriGoldWix authored Jul 31, 2024
2 parents bbd7e83 + 56915fd commit 7686098
Show file tree
Hide file tree
Showing 11 changed files with 112 additions and 83 deletions.
16 changes: 9 additions & 7 deletions js-wixcode-sdk/$w.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@
"",
" You do not need to import `$w`.",
"",
" > **Note:** Most `$w` elements, nodes, and events are described here under Wix Editor Elements. Some `$w` ",
" elements are described in context of their functionality. For example, the [`WixForms`](wix-crm-frontend.html#$w-wixforms) ",
" element is described under the `wix-crm-frontend` namespace because using the API for the Wix Forms app is most relevant in the ",
" context of site contacts and visitors. ",
" > **Notes:**",
" > - Most `$w` elements, nodes, and events are described here under Wix Editor Elements. Some `$w`",
" elements are described in context of their functionality. For example, the [`WixForms`](wix-crm-frontend.html#$w-wixforms)",
" element is described under the `wix-crm-frontend` namespace because using the API for the Wix Forms app is most relevant in the",
" context of site contacts and visitors.",
" > - Some `$w` elements change their size dynamically, which can [affect the page layout](https://dev.wix.com/docs/develop-websites/articles/wix-editor-elements/formatting-layout/how-page-layout-is-affected-when-elements-change-size).",
"",
" Get hands-on experience with the `$w` API on our [Hello World](https://www.wix.com/velo/example/hello-world) example page." ],
"links": [],
Expand All @@ -42,7 +44,7 @@
[ "$w.Element" ] } ],
"doc": "A single selected element or an array of selected elements." },
"locations":
[ { "lineno": 23,
[ { "lineno": 24,
"filename": "wixCode.js" } ],
"docs":
{ "summary": "Selects and returns elements from a page.",
Expand Down Expand Up @@ -129,7 +131,7 @@
{ "type": "$w.$w",
"doc": "A selector function for the given context." },
"locations":
[ { "lineno": 127,
[ { "lineno": 125,
"filename": "wixCode.js" } ],
"docs":
{ "summary": "Gets a selector function for a specific context.",
Expand Down Expand Up @@ -165,7 +167,7 @@
"ret":
{ "type": "void" },
"locations":
[ { "lineno": 72,
[ { "lineno": 71,
"filename": "wixCode.js" } ],
"docs":
{ "summary": "Sets the function that runs when all the page elements have finished loading.",
Expand Down
5 changes: 3 additions & 2 deletions js-wixcode-sdk/$w/Accordion.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@
"memberOf": "$w",
"mixes":
[ "$w.Element" ],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "Accordion.js" },
"docs":
{ "summary": "An [accordion element](https://support.wix.com/en/article/editor-x-adding-and-customizing-an-accordion-5177642#adding-and-managing-accordion-items)\nis a container that holds multiple collapsible accordion item elements.",
"description":
[ "> This feature is currently only available in Wix Studio and Editor X.",
[ "> This feature is currently only available in Wix Studio.",
"",
"An accordion element holds multiple, collapsible item elements in a vertical stack,",
"each with different content.",
Expand Down
15 changes: 9 additions & 6 deletions js-wixcode-sdk/$w/CollapsedMixin.service.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{ "name": "CollapsedMixin",
"memberOf": "$w",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "CollapsedMixin.js" },
Expand Down Expand Up @@ -36,7 +37,8 @@
{ } },
"properties":
[ { "name": "collapsed",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": false,
"type": "boolean",
Expand Down Expand Up @@ -65,7 +67,7 @@
" + Its [parent element]($w.Node.html#parent) is hidden or collapsed.",
" + It is a slide in a [Slideshow]($w.Slideshow.html) which is",
" currently not being displayed.",
" + In Editor X, it has been marked as \"Don't Display\" for the current breakpoint.",
" + In Wix Studio, it has been set to **Hide** in the [Layers panel](https://wix.wixanswers.com/apps/widget/v1/wix/53f85d67-f8b0-41ca-9dc8-5a16390cc74f/view/en/article/9b13ee7a-06b1-4fde-80e7-8f978d9d3195#:~:text=a%20specific%20breakpoint%3F-,Yes,-.%C2%A0You%20can%20hide) in that breakpoint. ",
"",
"",
" Even if the element is not displayed due to the conditions",
Expand Down Expand Up @@ -164,7 +166,8 @@
"extra":
{ } },
{ "name": "expand",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params": [],
"ret":
Expand All @@ -186,10 +189,10 @@
" see the [`collapsed`](#collapsed) property.",
"",
"> **Notes:** ",
"> + In Editor X, an element will not become visible by using `expand()` if it has been marked as \"Don't Display\" for the current breakpoint. Calling `expand()` will however, change the `collapsed` property of the element to `false`.",
"> + In Wix Studio, an element will not become visible by using `expand()` if it has been marked as \"Don't Display\" for the current breakpoint. Calling `expand()` will however, change the `collapsed` property of the element to `false`.",
"> ",
">",
"> + It is recommended not to mix `expand()` and `collapse()` with \"Don't Display\" in Editor X." ],
"> + It is recommended **not** to mix `expand()` and `collapse()` with [**Hide**](https://wix.wixanswers.com/apps/widget/v1/wix/53f85d67-f8b0-41ca-9dc8-5a16390cc74f/view/en/article/9b13ee7a-06b1-4fde-80e7-8f978d9d3195#:~:text=a%20specific%20breakpoint%3F-,Yes,-.%C2%A0You%20can%20hide) and **Show** in Wix Studio." ],
"links":
[ "[expand( )](#expand)",
"[collapsed](#collapsed)",
Expand Down
5 changes: 3 additions & 2 deletions js-wixcode-sdk/$w/CustomClassList.service.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{ "name": "CustomClassList",
"memberOf": "$w",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "CustomClassList.js" },
Expand All @@ -20,7 +21,7 @@
"see [Add CSS to your site](https://www.wix.com/velo/reference/$w/styling-elements-with-css#$w_styling-elements-with-css_add-css-to-your-site) ",
"and [About CSS editing](https://support.wix.com/en/article/editor-x-about-css-editing). ",
"",
"> **Note:** This mixin is currently only available in Editor X. ",
"> **Note:** This mixin is currently only available in Wix Studio. ",
" ",
"**About Mixins**",
"",
Expand Down
49 changes: 28 additions & 21 deletions js-wixcode-sdk/$w/Effects.service.json
Original file line number Diff line number Diff line change
@@ -1,27 +1,29 @@
{ "name": "Effects",
"memberOf": "$w",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 50,
"filename": "EffectsMixin.js" },
"docs":
{ "summary": "Functionality for displaying the [effects](https://support.wix.com/en/article/editor-x-about-click-and-hover-interactions-beta#choosing-and-customizing-effects) defined for an element using Editor X.",
{ "summary": "Functionality for displaying the [effects](https://support.wix.com/en/article/studio-editor-about-animations#:~:text=client%27s%20exact%20needs.-,Hover%20and%20click%20interactions,-Add%20cool%20effects) defined for an element using Wix Studio.",
"description":
[ ">**Note:** This API can only be used in Editor X.",
[ ">**Note:** This API can only be used in Wix Studio.",
"",
"Editor X allows you to create [effects](https://support.wix.com/en/article/editor-x-about-click-and-hover-interactions-beta#choosing-and-customizing-effects) that change the way elements are displayed on your site.",
"Wix Studio allows you to create [effects](https://support.wix.com/en/article/studio-editor-about-animations#:~:text=client%27s%20exact%20needs.-,Hover%20and%20click%20interactions,-Add%20cool%20effects) that change the way elements are displayed on your site.",
"The Effects API allows you to programatically display the effects defined for an element. ",
"",
"For example, with the API you can trigger an effect using anything happening on your site or in your code. ",
"This means you can expand the set of effects [triggers](https://support.wix.com/en/article/editor-x-about-click-and-hover-interactions#how-do-interactions-work) provided in Editor X to suit your needs." ],
"This means you can expand the set of effects triggers provided in Wix Studio to suit your needs." ],
"links": [],
"examples": [],
"extra":
{ } },
"properties":
[ { "name": "activeEffects",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": false,
"type":
Expand All @@ -37,7 +39,7 @@
[ "This property contains the names of all of an element's currently applied effects.",
"",
">**Note:**",
">This property can only be used in Editor X." ],
">This property can only be used in Wix Studio." ],
"links": [],
"examples":
[ { "title": "Retrieve all of an element's applied effects",
Expand Down Expand Up @@ -68,7 +70,8 @@
"extra":
{ } },
{ "name": "allEffects",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": false,
"type":
Expand All @@ -81,10 +84,10 @@
"docs":
{ "summary": "Gets all of the effects defined for an element.",
"description":
[ "This property contains the names of all the effects that were defined for an element using Editor X.",
[ "This property contains the names of all the effects that were defined for an element using Wix Studio.",
"",
">**Note:**",
">This property can only be used in Editor X." ],
">This property can only be used in Wix Studio." ],
"links": [],
"examples":
[ { "title": "Retrieve all of the effects defined for an element",
Expand Down Expand Up @@ -116,7 +119,8 @@
{ } } ],
"operations":
[ { "name": "applyEffects",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "effects",
Expand All @@ -133,11 +137,11 @@
"docs":
{ "summary": "Applies one or more of an element's effects.",
"description":
[ "This function applies effects that you previously defined for an element using Editor X, making the effects visible on your site.",
[ "This function applies effects that you previously defined for an element using Wix Studio, making the effects visible on your site.",
"",
"You can find the names of the effects defined for an element using the [`allEffects`](#allEffects) property.",
"",
"The Effects panel in Editor X has two sections, **Adjust** and **Design**, that allow you to adjust the appearance of an element or change its design characteristics.",
"The Effects panel in Wix Studio has two sections, **Adjust** and **Design**, that allow you to adjust the appearance of an element or change its design characteristics.",
"You can't simultaneously apply 2 effects that both change properties in the same section. ",
"If you try to do this, only one of the effects is visible on your site. ",
"You can, however, apply 1 effect that changes the **Adjust** properties and another effect that changes the **Design** properties simultaneously.",
Expand All @@ -149,7 +153,7 @@
"If you create 2 effects that each change properties in the **Adjust** section and try to apply them together, only",
"one is visible on your site. The same is true for 2 effects that change properties in the **Design** section.",
"",
">**Note:** This function can only be used in Editor X." ],
">**Note:** This function can only be used in Wix Studio." ],
"links": [],
"examples":
[ { "title": "Apply one of an element's effects",
Expand All @@ -174,7 +178,8 @@
"extra":
{ } },
{ "name": "removeAllEffects",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params": [],
"ret":
Expand All @@ -188,7 +193,7 @@
[ "This function removes all of an element's previously applied effects. Once you remove effects, they're unapplied from an element and no longer visible on your site.",
"",
">**Note:**",
">This function can only be used in Editor X." ],
">This function can only be used in Wix Studio." ],
"links": [],
"examples":
[ { "title": "Remove all of an element's applied effects",
Expand Down Expand Up @@ -217,7 +222,8 @@
"extra":
{ } },
{ "name": "removeEffects",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "effects",
Expand All @@ -240,7 +246,7 @@
"You can find the names of the effects defined for an element using the [`allEffects`](#allEffects) property.",
"",
">**Note:**",
">This function can only be used in Editor X." ],
">This function can only be used in Wix Studio." ],
"links": [],
"examples":
[ { "title": "Remove one of an element's effects",
Expand All @@ -265,7 +271,8 @@
"extra":
{ } },
{ "name": "toggleEffects",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "effects",
Expand All @@ -288,7 +295,7 @@
"",
"You can find the names of the effects defined for an element using the [`allEffects`](#allEffects) property.",
"",
"The Effects panel in Editor X has two sections, **Adjust** and **Design**, that allow you to adjust the appearance of an element or change its design characteristics.",
"The Effects panel in Wix Studio has two sections, **Adjust** and **Design**, that allow you to adjust the appearance of an element or change its design characteristics.",
"You can't simultaneously apply 2 effects that both change properties in the same section. ",
"If you try to do this, only one of the effects is visible on your site. ",
"You can, however, apply 1 effect that changes the **Adjust** properties and another effect that changes the **Design** properties simultaneously.",
Expand All @@ -301,7 +308,7 @@
"one is visible on your site. The same is true for 2 effects that change properties in the **Design** section.",
"",
">**Note:**",
">This function can only be used in Editor X." ],
">This function can only be used in Wix Studio." ],
"links": [],
"examples":
[ { "title": "Toggle one of an element's effects",
Expand Down
14 changes: 8 additions & 6 deletions js-wixcode-sdk/$w/EffectsMixin.service.json
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
{ "name": "EffectsMixin",
"memberOf": "$w",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "EffectsMixin.js" },
"docs":
{ "summary": "Provides functionality for elements with [effects](https://support.wix.com/en/article/editor-x-about-click-and-hover-interactions-beta#choosing-and-customizing-effects) defined using Editor X.",
{ "summary": "Provides functionality for elements with [effects](https://support.wix.com/en/article/studio-editor-adding-a-preset-click-or-hover-interaction) defined using Wix Studio.",
"description":
[ "Editor X allows you to create [effects](https://support.wix.com/en/article/editor-x-about-click-and-hover-interactions-beta#choosing-and-customizing-effects) that change the way elements are displayed on your site.",
[ "Wix Studio allows you to create [effects](https://support.wix.com/en/article/studio-editor-creating-a-custom-click-or-hover-interaction) that change the way elements are displayed on your site.",
"",
"This mixin provides functionality that allows you to control the display of effects defined for an element.",
"",
"",
" >**Note:** ",
" >This mixin can only be used in Editor X.",
" >This mixin can only be used in Wix Studio.",
"",
" **About Mixins**",
"",
Expand All @@ -41,15 +42,16 @@
{ } },
"properties":
[ { "name": "effects",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": false,
"type": "$w.Effects",
"locations":
[ { "lineno": 36,
"filename": "EffectsMixin.js" } ],
"docs":
{ "summary": "An object containing functionality for displaying the [effects](https://support.wix.com/en/article/editor-x-about-click-and-hover-interactions-beta#choosing-and-customizing-effects) defined for an element using Editor X.\n\n>**Note:** This API can only be used in Editor X.",
{ "summary": "An object containing functionality for displaying the [effects](https://support.wix.com/en/article/studio-editor-adding-a-preset-click-or-hover-interaction) defined for an element using Wix Studio.\n\n>**Note:** This API can only be used in Wix Studio.",
"links": [],
"examples":
[ { "title": "Get an element's effects",
Expand Down
8 changes: 5 additions & 3 deletions js-wixcode-sdk/$w/Element.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
"mixes":
[ "$w.Node",
"$w.ViewportMixin" ],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "Element.js" },
Expand Down Expand Up @@ -75,7 +76,8 @@
"extra":
{ } },
{ "name": "deleted",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": false,
"type": "boolean",
Expand All @@ -91,7 +93,7 @@
"",
">**Notes:**",
"> - An element whose `deleted` status is `true` can be edited.",
"> - In Editor X, an element whose `deleted` status is `false` will not be displayed if the element has been set to \"Don't Display\"." ],
"> - In Wix Studio, an element whose `deleted` status is `false` will not be displayed if the element has been set to **Hide**." ],
"links":
[ "[collapsed]($w.HiddenCollapsedMixin.html#collapsed)",
"[hidden]($w.HiddenCollapsedMixin.html#hidden)",
Expand Down
Loading

0 comments on commit 7686098

Please sign in to comment.