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

Avoid inheritance #4256

Draft
wants to merge 1 commit into
base: master-mysterious-egg
Choose a base branch
from
+40 −26
Draft

Avoid inheritance #4256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 3 additions & 10 deletions addons/html_builder/static/src/plugins/background_option/background_option_plugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,20 @@
import { applyFunDependOnSelectorAndExclude } from "@html_builder/plugins/utils";
import { getSelectorParams } from "@html_builder/utils/utils";
import { Plugin } from "@html_editor/plugin";
import { registry } from "@web/core/registry";
import { BackgroundOption } from "./background_option";

class BackgroundOptionPlugin extends Plugin {
static id = "backgroundOption";
resources = {
normalize_handlers: this.normalize.bind(this),
system_classes: ["o_colored_level"],
};
setup() {
this.coloredLevelBackgroundParams = getSelectorParams(
this.getResource("builder_options"),
BackgroundOption
);
}
normalize(root) {
for (const coloredLevelBackgroundParam of this.coloredLevelBackgroundParams) {
const markColorLevelSelectorParams = this.getResource("mark_color_level_selector_params");
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If in the future, some code creates a component in which there is BackgroundOption with the withColors and withColorCombinations, it will have to think to add its selector in mark_color_level_selector_params.
I thought to do something like:

this.backgroundOptionParams = getSelectorParams(
     this.getResource("builder_options"),
     BackgroundOption
 );
 this.markColorLevelSelectorParams = this.backgroundOptionParams.filter(
     (el) => el.props.withColors && el.props.withColorCombinations
 );

But it does not work if BackgroundOption is used inside another Component

for (const markColorLevelSelectorParam of markColorLevelSelectorParams) {
applyFunDependOnSelectorAndExclude(
this.markColorLevel,
root,
coloredLevelBackgroundParam
markColorLevelSelectorParam
);
}
}
Expand Down
10 changes: 5 additions & 5 deletions addons/html_builder/static/src/website_builder/plugins/options/background_option.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { useDomState } from "@html_builder/core/utils";
import { BaseOptionComponent, useDomState } from "@html_builder/core/utils";
import { BackgroundImageOption } from "@html_builder/plugins/background_option/background_image_option";
import { BackgroundOption } from "@html_builder/plugins/background_option/background_option";
import { BackgroundPositionOption } from "@html_builder/plugins/background_option/background_position_option";
import { BackgroundShapeOption } from "@html_builder/plugins/background_option/background_shape_option";
import { ParallaxOption } from "../parallax_option";

export class WebsiteBackgroundOption extends BackgroundOption {
export class WebsiteBackgroundOption extends BaseOptionComponent {
static template = "website.WebsiteBackgroundOption";
static components = {
BackgroundImageOption,
Expand All @@ -14,11 +14,11 @@ export class WebsiteBackgroundOption extends BackgroundOption {
ParallaxOption,
};
static props = {
...super.props,
...BackgroundOption.props,
withVideos: { type: Boolean, optional: true },
};
static defaultProps = {
...super.defaultProps,
...BackgroundOption.defaultProps,
withVideos: false,
};
setup() {
Expand All @@ -28,6 +28,6 @@ export class WebsiteBackgroundOption extends BackgroundOption {
}));
}
showColorFilter() {
return super.showColorFilter() || this.isActiveItem("toggle_bg_video_id");
return this.isActiveItem("toggle_bg_image_id") || this.isActiveItem("toggle_bg_video_id");
}
}
6 changes: 4 additions & 2 deletions addons/html_builder/static/src/website_builder/plugins/options/blockquote_option_plugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ import { WebsiteBackgroundOption } from "@html_builder/website_builder/plugins/o

class BlockquoteOptionPlugin extends Plugin {
static id = "blockquoteOption";
selector = ".s_blockquote";
resources = {
mark_color_level_selector_params: [{ selector: this.selector }],
builder_options: [
withSequence(30, {
selector: ".s_blockquote",
selector: this.selector,
OptionComponent: WebsiteBackgroundOption,
props: {
withColors: true,
Expand All @@ -19,7 +21,7 @@ class BlockquoteOptionPlugin extends Plugin {
}),
withSequence(40, {
template: "website.BlockquoteOption",
selector: ".s_blockquote",
selector: this.selector,
}),
],
};
Expand Down
17 changes: 13 additions & 4 deletions addons/html_builder/static/src/website_builder/plugins/options/card_option_plugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,29 @@ import { WebsiteBackgroundOption } from "./background_option";

class CardOptionPlugin extends Plugin {
static id = "cardOption";
cardSelector = ".s_card";
cardExclude = `div:is(${CARD_PARENT_HANDLERS}) > .s_card`;
cardDisableWidthApplyTo = ":scope > .s_card:not(.s_carousel_cards_card)";
websiteBgApplyTo = ":scope > .s_carousel_cards_card";
resources = {
builder_options: [
{
OptionComponent: CardOption,
selector: ".s_card",
exclude: `div:is(${CARD_PARENT_HANDLERS}) > .s_card`,
selector: this.cardSelector,
exclude: this.cardExclude,
},
{
OptionComponent: CardOption,
selector: CARD_PARENT_HANDLERS,
applyTo: ":scope > .s_card:not(.s_carousel_cards_card)",
applyTo: this.cardDisableWidthApplyTo,
props: {
disableWidth: true,
},
},
{
OptionComponent: WebsiteBackgroundOption,
selector: CARD_PARENT_HANDLERS,
applyTo: ":scope > .s_carousel_cards_card",
applyTo: this.websiteBgApplyTo,
props: {
withColors: true,
withImages: true,
Expand All @@ -33,6 +37,11 @@ class CardOptionPlugin extends Plugin {
},
},
],
mark_color_level_selector_params: [
{ selector: this.cardSelector, exclude: this.cardExclude },
{ selector: CARD_PARENT_HANDLERS, applyTo: this.cardDisableWidthApplyTo },
{ selector: CARD_PARENT_HANDLERS, applyTo: this.websiteBgApplyTo },
],
};
}

Expand Down
4 changes: 3 additions & 1 deletion addons/html_builder/static/src/website_builder/plugins/options/media_list_option_plugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { MediaListItemOption } from "./media_list_item_option";

class MediaListOptionPlugin extends Plugin {
static id = "mediaListOption";
mediaListItemOptionSelector = ".s_media_list_item";
resources = {
builder_options: [
withSequence(5, {
Expand All @@ -13,10 +14,11 @@ class MediaListOptionPlugin extends Plugin {
}),
withSequence(20, {
OptionComponent: MediaListItemOption,
selector: ".s_media_list_item",
selector: this.mediaListItemOptionSelector,
}),
],
builder_actions: this.getActions(),
mark_color_level_selector_params: [{ selector: this.mediaListItemOptionSelector }],
};

getActions() {
Expand Down
12 changes: 10 additions & 2 deletions ...ml_builder/static/src/website_builder/plugins/options/website_background_option_plugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,15 @@ import {

class WebsiteBackgroundOptionPlugin extends Plugin {
static id = "websiteOption";
static dependencies = ["backgroundOption"];
sectionSelector = "section";
carouselApplyTo = ":scope > .carousel:not(.s_carousel_cards)";
resources = {
builder_options: [
{
OptionComponent: WebsiteBackgroundOption,
selector: "section",
applyTo: ":scope > .carousel:not(.s_carousel_cards)",
selector: this.sectionSelector,
applyTo: this.carouselApplyTo,
props: {
withColors: true,
withImages: true,
Expand Down Expand Up @@ -60,6 +63,11 @@ class WebsiteBackgroundOptionPlugin extends Plugin {
},
},
],
mark_color_level_selector_params: [
{ selector: this.cardSelector, applyTo: this.carouselApplyTo },
{ selector: BOTH_BG_COLOR_IMAGE_SELECTOR, exclude: BOTH_BG_COLOR_IMAGE_EXCLUDE },
{ selector: ONLY_BG_COLOR_SELECTOR, exclude: ONLY_BG_COLOR_EXCLUDE },
],
};
}

Expand Down
4 changes: 2 additions & 2 deletions addons/html_builder/static/src/website_builder/plugins/parallax_option.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { BackgroundOption } from "@html_builder/plugins/background_option/background_option";
import { BaseOptionComponent } from "@html_builder/core/utils";

export class ParallaxOption extends BackgroundOption {
export class ParallaxOption extends BaseOptionComponent {
static template = "website.ParallaxOption";
static props = {};
}