Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Effects Mixin - Remove Editor X #3074

Merged
merged 3 commits into from
Jul 31, 2024
Merged

Update Effects Mixin - Remove Editor X #3074

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7965f92
DocWorks for js-wixcode-sdk - 12 changes detected, but 15 issue detected
ryangec Jul 31, 2024
7db490a
Merge branch 'master' into editor-x-effects-note
ryangec Jul 31, 2024
91dba03
Merge branch 'master' into editor-x-effects-note
ryangec Jul 31, 2024
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
49 changes: 28 additions & 21 deletions js-wixcode-sdk/$w/Effects.service.json
View file
Open in desktop
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
View file
Open in desktop
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
Loading