Merge pull request #3074 from wix-incubator/editor-x-effects-note

Update Effects Mixin - Remove Editor X
wix-incubator · Jul 31, 2024 · 56915fd · 56915fd
2 parents 1df1355 + 91dba03
commit 56915fd
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 27 deletions.
diff --git a/js-wixcode-sdk/$w/Effects.service.json b/js-wixcode-sdk/$w/Effects.service.json
@@ -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":
@@ -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",
@@ -68,7 +70,8 @@
         "extra":
           {  } },
       { "name": "allEffects",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "get": true,
         "set": false,
         "type":
@@ -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",
@@ -116,7 +119,8 @@
           {  } } ],
   "operations":
     [ { "name": "applyEffects",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "nameParams": [],
         "params":
           [ { "name": "effects",
@@ -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.",
@@ -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",
@@ -174,7 +178,8 @@
         "extra":
           {  } },
       { "name": "removeAllEffects",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "nameParams": [],
         "params": [],
         "ret":
@@ -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",
@@ -217,7 +222,8 @@
         "extra":
           {  } },
       { "name": "removeEffects",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "nameParams": [],
         "params":
           [ { "name": "effects",
@@ -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",
@@ -265,7 +271,8 @@
         "extra":
           {  } },
       { "name": "toggleEffects",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "nameParams": [],
         "params":
           [ { "name": "effects",
@@ -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.",
@@ -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",

diff --git a/js-wixcode-sdk/$w/EffectsMixin.service.json b/js-wixcode-sdk/$w/EffectsMixin.service.json
@@ -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**",
           "",
@@ -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",