Skip to content

Commit

Permalink
Merge branch 'master' into editor-x-effects-note
Browse files Browse the repository at this point in the history
  • Loading branch information
ryangec authored Jul 31, 2024
2 parents 7965f92 + 621df47 commit 7db490a
Show file tree
Hide file tree
Showing 8 changed files with 59 additions and 43 deletions.
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
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
24 changes: 14 additions & 10 deletions js-wixcode-sdk/$w/HiddenMixin.service.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{ "name": "HiddenMixin",
"memberOf": "$w",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "HiddenMixin.js" },
Expand Down Expand Up @@ -36,7 +37,8 @@
{ } },
"properties":
[ { "name": "hidden",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": false,
"type": "boolean",
Expand All @@ -60,7 +62,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** for the current breakpoint.",
"",
"",
" Even if the element is not displayed due to the conditions",
Expand Down Expand Up @@ -108,7 +110,8 @@
"extra":
{ } },
{ "name": "isVisible",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": false,
"type": "boolean",
Expand Down Expand Up @@ -140,7 +143,7 @@
"> another element completely covers it so that a user cannot see it.",
">",
">",
"> + In Editor X, even if the `isVisible` property of the element is `true`, it will not be displayed if the element has been set to \"Don't Display\" for the current breakpoint." ],
"> + In Wix Studio, even if the `isVisible` property of the element is `true`, it will not be displayed if the element has been set to **Hide** for the current breakpoint in the Layers more actions menu." ],
"links":
[ "[hidden](#hidden)",
"[collapsed]($w.CollapsedMixin.html#collapsed)",
Expand Down Expand Up @@ -277,7 +280,8 @@
"extra":
{ } },
{ "name": "show",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "effectName",
Expand Down Expand Up @@ -344,10 +348,10 @@
"",
"> **Notes:**",
">",
"> + In Editor X, `show ()` will not make an element visible for a given breakpoint",
"> if the element has been set to \"Don't Display\" for that breakpoint.",
"> Calling `show()` will however, change the `hidden` property of the element to `false`.",
"> + It is recommended not to mix `show` and `hide` with \"Don't Display\" in Editor X." ],
"> + In Wix Studio, the `show ()` function will not make an element visible for a given breakpoint",
"> if the element has been set to \"**Hide** for that breakpoint in the Layers more actions menu.",
"> Calling `show()` however, will change the `hidden` property of the element to `false`.",
"> + It is recommended **not** to mix `show()` and `hide()` with **Hide** and **Show** in Wix Studio." ],
"links":
[ "[hide( )](#hide)",
"[hidden](#hidden)",
Expand Down
29 changes: 15 additions & 14 deletions js-wixcode-sdk/$w/Image.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"$w.LinkableMixin",
"$w.ClickableMixin",
"$w.EffectsMixin" ],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "Image.js" },
Expand Down Expand Up @@ -61,14 +62,15 @@
"extra":
{ } },
{ "name": "clickAction",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": true,
"type": "string",
"locations":
[ { "lineno": 118,
[ { "lineno": 117,
"filename": "Image.js" },
{ "lineno": 145,
{ "lineno": 143,
"filename": "Image.js" } ],
"docs":
{ "summary": "Sets or gets the action that occurs when an image is clicked.",
Expand All @@ -85,8 +87,7 @@
"",
"",
" Getting the `clickAction` property returns what happens when",
" an image is clicked.",
"> **Note:** `expand ` and `magnified` are not supported in Editor X. [Learn more](https://support.wix.com/en/article/editor-x-adding-and-editing-images-on-your-site) about Editor X and images." ],
" an image is clicked." ],
"links": [],
"examples":
[ { "title": "Get the action that occurs when an image is clicked",
Expand All @@ -110,9 +111,9 @@
"type": "string",
"defaultValue": "\"fill\"",
"locations":
[ { "lineno": 152,
[ { "lineno": 150,
"filename": "Image.js" },
{ "lineno": 217,
{ "lineno": 215,
"filename": "Image.js" } ],
"docs":
{ "summary": "Sets or gets how an image is placed inside an image element.",
Expand Down Expand Up @@ -190,9 +191,9 @@
"type": "string",
"defaultValue": "An empty string",
"locations":
[ { "lineno": 81,
[ { "lineno": 80,
"filename": "Image.js" },
{ "lineno": 111,
{ "lineno": 110,
"filename": "Image.js" } ],
"docs":
{ "summary": "Sets or gets the file location of the image.",
Expand Down Expand Up @@ -234,22 +235,22 @@
"extra":
{ } },
{ "name": "tooltip",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": true,
"type": "string",
"defaultValue": "An empty string",
"locations":
[ { "lineno": 56,
"filename": "Image.js" },
{ "lineno": 74,
{ "lineno": 73,
"filename": "Image.js" } ],
"docs":
{ "summary": "Sets or gets an image's tooltip.",
"description":
[ "An image's tooltip text is displayed when a user hovers over the image",
" or when the image opens in a popup.",
"> **Note:** `tooltip` is not supported in Editor X. [Learn more](https://support.wix.com/en/article/editor-x-adding-and-editing-images-on-your-site) about Editor X and images." ],
" or when the image opens in a popup." ],
"links": [],
"examples":
[ { "title": "Get the image's tooltip text",
Expand Down
8 changes: 5 additions & 3 deletions js-wixcode-sdk/wix-window-frontend.service.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{ "name": "wix-window-frontend",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "window-frontend.js" },
Expand Down Expand Up @@ -89,7 +90,8 @@
"extra":
{ } },
{ "name": "formFactor",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": false,
"type": "string",
Expand All @@ -101,7 +103,7 @@
"description":
[ "<br/>",
"",
">**Note:** This property only checks the site visitor's device, and not which [Editor X breakpoint](https://support.wix.com/en/article/editor-x-managing-breakpoints) they are using. ",
">**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. ",
"",
" The `formFactor` property gets one of:",
"",
Expand Down
8 changes: 5 additions & 3 deletions js-wixcode-sdk/wix-window.service.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{ "name": "wix-window",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "window.js" },
Expand Down Expand Up @@ -89,7 +90,8 @@
"extra":
{ } },
{ "name": "formFactor",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": false,
"type": "string",
Expand All @@ -101,7 +103,7 @@
"description":
[ "<br/>",
"",
">**Note:** This property only checks the site visitor's device, and not which [Editor X breakpoint](https://support.wix.com/en/article/editor-x-managing-breakpoints) they are using. ",
">**Note:** This property only checks the site visitor's device, and not which [Wix Studio breakpoint](https://support.wix.com/en/article/studio-editor-designing-across-breakpoints#defining-breakpoints) they are using. ",
"",
" The `formFactor` property gets one of:",
"",
Expand Down

0 comments on commit 7db490a

Please sign in to comment.