forked from Techsystech/web
[MIG] web_chatter_position: Migration to 17.0
[IMP] web_chatter_position: improve function compile web_chatter_position: propose myself as maintainer17.0
ptsuva
trisdoan
parent
2d1004ec7c
commit
a03e8e0d73
Binary file not shown.
|
|
@ -61,6 +61,7 @@ Authors
|
|||
|
||||
* Hynsys Technologies
|
||||
* Camptocamp
|
||||
* Alitec Pte Ltd
|
||||
|
||||
Contributors
|
||||
------------
|
||||
|
|
@ -71,6 +72,14 @@ Contributors
|
|||
|
||||
- Iván Todorovich <ivan.todorovich@camptocamp.com>
|
||||
|
||||
- `Alitec Pte Ltd <http://www.alitec.sg>`__
|
||||
|
||||
- Jay Patel <jay@alitec.sg>
|
||||
|
||||
- Trobz
|
||||
|
||||
- Tris Doan <tridm@trobz.com>
|
||||
|
||||
Maintainers
|
||||
-----------
|
||||
|
||||
|
|
@ -84,6 +93,14 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose
|
|||
mission is to support the collaborative development of Odoo features and
|
||||
promote its widespread use.
|
||||
|
||||
.. |maintainer-trisdoan| image:: https://github.com/trisdoan.png?size=40px
|
||||
:target: https://github.com/trisdoan
|
||||
:alt: trisdoan
|
||||
|
||||
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|
||||
|
||||
|maintainer-trisdoan|
|
||||
|
||||
This module is part of the `OCA/web <https://github.com/OCA/web/tree/17.0/web_chatter_position>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,14 @@
|
|||
# Copyright 2022 Hynsys Technologies
|
||||
# Copyright 2024 Alitec Pte Ltd
|
||||
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
|
||||
|
||||
{
|
||||
"name": "Chatter Position",
|
||||
"summary": "Add an option to change the chatter position",
|
||||
"version": "16.0.1.0.2",
|
||||
"author": "Hynsys Technologies, Camptocamp, Odoo Community Association (OCA)",
|
||||
"version": "17.0.1.0.1",
|
||||
"author": "Hynsys Technologies, Camptocamp, Alitec Pte Ltd, "
|
||||
"Odoo Community Association (OCA)",
|
||||
"maintainers": ["trisdoan"],
|
||||
"website": "https://github.com/OCA/web",
|
||||
"license": "LGPL-3",
|
||||
"category": "Extra Tools",
|
||||
|
|
@ -14,6 +17,7 @@
|
|||
"assets": {
|
||||
"web.assets_backend": [
|
||||
"/web_chatter_position/static/src/**/*.js",
|
||||
"/web_chatter_position/static/src/**/*.scss",
|
||||
],
|
||||
},
|
||||
}
|
||||
|
|
|
|||
|
|
@ -2,3 +2,7 @@
|
|||
- Juan Miguel Sánchez Arce \<<juan.sanchez@camptocamp.com>\>
|
||||
- [Camptocamp](https://www.camptocamp.com)
|
||||
- Iván Todorovich \<<ivan.todorovich@camptocamp.com>\>
|
||||
- [Alitec Pte Ltd](http://www.alitec.sg)
|
||||
- Jay Patel \<<jay@alitec.sg>\>
|
||||
- Trobz
|
||||
- Tris Doan \<<tridm@trobz.com>\>
|
||||
|
|
|
|||
|
|
@ -405,6 +405,7 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
|
|||
<ul class="simple">
|
||||
<li>Hynsys Technologies</li>
|
||||
<li>Camptocamp</li>
|
||||
<li>Alitec Pte Ltd</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="contributors">
|
||||
|
|
@ -416,6 +417,14 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
|
|||
<li>Iván Todorovich <<a class="reference external" href="mailto:ivan.todorovich@camptocamp.com">ivan.todorovich@camptocamp.com</a>></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference external" href="http://www.alitec.sg">Alitec Pte Ltd</a><ul>
|
||||
<li>Jay Patel <<a class="reference external" href="mailto:jay@alitec.sg">jay@alitec.sg</a>></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Trobz<ul>
|
||||
<li>Tris Doan <<a class="reference external" href="mailto:tridm@trobz.com">tridm@trobz.com</a>></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="maintainers">
|
||||
|
|
@ -427,6 +436,8 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
|
|||
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
|
||||
mission is to support the collaborative development of Odoo features and
|
||||
promote its widespread use.</p>
|
||||
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
|
||||
<p><a class="reference external image-reference" href="https://github.com/trisdoan"><img alt="trisdoan" src="https://github.com/trisdoan.png?size=40px" /></a></p>
|
||||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/17.0/web_chatter_position">OCA/web</a> project on GitHub.</p>
|
||||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -5,161 +5,85 @@
|
|||
*/
|
||||
|
||||
import {FormCompiler} from "@web/views/form/form_compiler";
|
||||
import {FormController} from "@web/views/form/form_controller";
|
||||
import {MailFormCompiler} from "@mail/views/form/form_compiler";
|
||||
import {append} from "@web/core/utils/xml";
|
||||
import {patch} from "@web/core/utils/patch";
|
||||
import {append, setAttributes} from "@web/core/utils/xml";
|
||||
import {SIZES} from "@web/core/ui/ui_service";
|
||||
|
||||
/**
|
||||
* So, you've landed here and you have no idea what this is about. Don't worry, you're
|
||||
* not the only one. Here's a quick summary of what's going on:
|
||||
*
|
||||
* In core, the chatter position depends on the size of the screen and wether there is
|
||||
* an attachment viewer or not. There are 3 possible positions, and for each position a
|
||||
* different chatter instance is displayed.
|
||||
*
|
||||
* So, in fact, we have 3 chatter instances running, and we switch their visibility
|
||||
* depending on the desired position.
|
||||
*
|
||||
* A) Bottom position
|
||||
* https://github.com/odoo/odoo/blob/2ef010907/addons/mail/static/src/views/form/form_compiler.js#L160
|
||||
* Condition: `!this.props.hasAttachmentViewer and uiService.size < ${SIZES.XXL}`
|
||||
*
|
||||
* This is the bottom position you would except. However it can only be there until
|
||||
* XXL screen sizes, because the container is a flexbox and changes from row to
|
||||
* column display. It's hidden in the presence of an attachment viewer.
|
||||
*
|
||||
* B) Bottom In-sheet position
|
||||
* https://github.com/odoo/odoo/blob/2ef010907/addons/mail/static/src/views/form/form_compiler.js#L181
|
||||
* Condition: `this.props.hasAttachmentViewer`
|
||||
*
|
||||
* This is the bottom position that's used when there's an attachment viewer in place.
|
||||
* It's rendered within the form sheet, possibly to by-pass the flexbox issue
|
||||
* beforementioned. It's only instanciated when there's an attachment viewer.
|
||||
*
|
||||
* C) Sided position
|
||||
* https://github.com/odoo/odoo/blob/2ef010907/addons/mail/static/src/views/form/form_compiler.js#L83
|
||||
* Condition: `!hasAttachmentViewer() and uiService.size >= ${SIZES.XXL}`
|
||||
*
|
||||
* This is the sided position, hidden in the presence of an attachment viewer.
|
||||
* It's the better half of `A`.
|
||||
*
|
||||
* The patches and overrides you see below are here to alter these conditions to force
|
||||
* a specific position regardless of the screen size, depending on an user setting.
|
||||
*/
|
||||
|
||||
patch(MailFormCompiler.prototype, "web_chatter_position", {
|
||||
patch(FormCompiler.prototype, {
|
||||
/**
|
||||
* Patch the visibility of the Sided chatter (`C` above).
|
||||
*
|
||||
* @override
|
||||
*/
|
||||
compile() {
|
||||
const res = this._super.apply(this, arguments);
|
||||
const chatterContainerHookXml = res.querySelector(
|
||||
".o_FormRenderer_chatterContainer"
|
||||
);
|
||||
if (!chatterContainerHookXml) {
|
||||
return res;
|
||||
}
|
||||
// Don't patch anything if the setting is "auto": this is the core behaviour
|
||||
if (odoo.web_chatter_position === "auto") {
|
||||
return res;
|
||||
} else if (odoo.web_chatter_position === "sided") {
|
||||
chatterContainerHookXml.setAttribute("t-if", "!hasAttachmentViewer()");
|
||||
} else if (odoo.web_chatter_position === "bottom") {
|
||||
chatterContainerHookXml.setAttribute("t-if", false);
|
||||
}
|
||||
return res;
|
||||
},
|
||||
});
|
||||
|
||||
patch(FormCompiler.prototype, "web_chatter_position", {
|
||||
/**
|
||||
* Patch the css classes of the `Form`, to include an extra `h-100` class.
|
||||
* Without it, the form sheet will not be full height in some situations,
|
||||
* looking a bit weird.
|
||||
*
|
||||
* @override
|
||||
*/
|
||||
compileForm() {
|
||||
const res = this._super.apply(this, arguments);
|
||||
if (odoo.web_chatter_position === "sided") {
|
||||
const classes = res.getAttribute("t-attf-class");
|
||||
res.setAttribute("t-attf-class", `${classes} h-100`);
|
||||
}
|
||||
return res;
|
||||
},
|
||||
/**
|
||||
* Patch the visibility of bottom chatters (`A` and `B` above).
|
||||
* `B` may not exist in some situations, so we ensure it does by creating it.
|
||||
*
|
||||
* @override
|
||||
*/
|
||||
compile(node, params) {
|
||||
const res = this._super.apply(this, arguments);
|
||||
const res = super.compile(node, params);
|
||||
const webClientViewAttachmentViewHookXml = res.querySelector(
|
||||
".o_attachment_preview"
|
||||
);
|
||||
const chatterContainerHookXml = res.querySelector(
|
||||
".o_FormRenderer_chatterContainer:not(.o-isInFormSheetBg)"
|
||||
".o-mail-Form-chatter:not(.o-isInFormSheetBg)"
|
||||
);
|
||||
if (!chatterContainerHookXml) {
|
||||
return res;
|
||||
return res; // No chatter, keep the result as it is
|
||||
}
|
||||
if (chatterContainerHookXml.parentNode.classList.contains("o_form_sheet")) {
|
||||
return res;
|
||||
const chatterContainerXml = chatterContainerHookXml.querySelector(
|
||||
"t[t-component='__comp__.mailComponents.Chatter']"
|
||||
);
|
||||
const formSheetBgXml = res.querySelector(".o_form_sheet_bg");
|
||||
const parentXml = formSheetBgXml && formSheetBgXml.parentNode;
|
||||
if (!parentXml) {
|
||||
return res; // Miss-config: a sheet-bg is required for the rest
|
||||
}
|
||||
|
||||
// Don't patch anything if the setting is "auto": this is the core behaviour
|
||||
if (odoo.web_chatter_position === "auto") {
|
||||
return res;
|
||||
// For "sided", we have to remote the bottom chatter
|
||||
// (except if there is an attachment viewer, as we have to force bottom)
|
||||
} else if (odoo.web_chatter_position === "sided") {
|
||||
const formSheetBgXml = res.querySelector(".o_form_sheet_bg");
|
||||
if (!formSheetBgXml) {
|
||||
return res;
|
||||
}
|
||||
chatterContainerHookXml.setAttribute("t-if", false);
|
||||
setAttributes(chatterContainerXml, {
|
||||
isInFormSheetBg: `__comp__.uiService.size < ${SIZES.XXL}`,
|
||||
isChatterAside: `__comp__.uiService.size >= ${SIZES.XXL}`,
|
||||
});
|
||||
setAttributes(chatterContainerHookXml, {
|
||||
"t-attf-class": `{{ __comp__.uiService.size >= ${SIZES.XXL} ? "o-aside" : "" }}`,
|
||||
});
|
||||
// For "bottom", we keep the chatter in the form sheet
|
||||
// (the one used for the attachment viewer case)
|
||||
// If it's not there, we create it.
|
||||
} else if (odoo.web_chatter_position === "bottom") {
|
||||
if (params.hasAttachmentViewerInArch) {
|
||||
if (webClientViewAttachmentViewHookXml) {
|
||||
const sheetBgChatterContainerHookXml = res.querySelector(
|
||||
".o_FormRenderer_chatterContainer.o-isInFormSheetBg"
|
||||
".o-mail-Form-chatter.o-isInFormSheetBg"
|
||||
);
|
||||
sheetBgChatterContainerHookXml.setAttribute("t-if", true);
|
||||
chatterContainerHookXml.setAttribute("t-if", false);
|
||||
setAttributes(sheetBgChatterContainerHookXml, {
|
||||
"t-if": "true",
|
||||
});
|
||||
setAttributes(chatterContainerHookXml, {
|
||||
"t-if": "false",
|
||||
});
|
||||
} else {
|
||||
const formSheetBgXml = res.querySelector(".o_form_sheet_bg");
|
||||
if (!formSheetBgXml) {
|
||||
return res;
|
||||
}
|
||||
const sheetBgChatterContainerHookXml =
|
||||
chatterContainerHookXml.cloneNode(true);
|
||||
sheetBgChatterContainerHookXml.classList.add("o-isInFormSheetBg");
|
||||
sheetBgChatterContainerHookXml.setAttribute("t-if", true);
|
||||
setAttributes(sheetBgChatterContainerHookXml, {
|
||||
"t-if": "true",
|
||||
"t-attf-class": `{{ (__comp__.uiService.size >= ${SIZES.XXL} && ${
|
||||
odoo.web_chatter_position != "bottom"
|
||||
}) ? "o-aside" : "mt-4 mt-md-0" }}`,
|
||||
});
|
||||
append(formSheetBgXml, sheetBgChatterContainerHookXml);
|
||||
const sheetBgChatterContainerXml =
|
||||
sheetBgChatterContainerHookXml.querySelector("ChatterContainer");
|
||||
sheetBgChatterContainerXml.setAttribute("isInFormSheetBg", "true");
|
||||
chatterContainerHookXml.setAttribute("t-if", false);
|
||||
sheetBgChatterContainerHookXml.querySelector(
|
||||
"t[t-component='__comp__.mailComponents.Chatter']"
|
||||
);
|
||||
|
||||
setAttributes(sheetBgChatterContainerXml, {
|
||||
isInFormSheetBg: "true",
|
||||
});
|
||||
setAttributes(chatterContainerHookXml, {
|
||||
"t-if": "false",
|
||||
});
|
||||
}
|
||||
}
|
||||
return res;
|
||||
},
|
||||
});
|
||||
|
||||
patch(FormController.prototype, "web_chatter_position", {
|
||||
/**
|
||||
* Patch the css classes of the form container, to include an extra `flex-row` class.
|
||||
* Without it, it'd go for flex columns direction and it won't look good.
|
||||
*
|
||||
* @override
|
||||
*/
|
||||
get className() {
|
||||
const result = this._super();
|
||||
if (odoo.web_chatter_position === "sided") {
|
||||
result["flex-row"] = true;
|
||||
}
|
||||
return result;
|
||||
},
|
||||
});
|
||||
|
|
|
|||
|
|
@ -0,0 +1,17 @@
|
|||
/*
|
||||
Copyright 2024 Alitec Pte Ltd (https://www.alitec.sg).
|
||||
License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).
|
||||
*/
|
||||
|
||||
.o_form_view {
|
||||
.o_form_sheet_bg {
|
||||
max-width: none;
|
||||
}
|
||||
.o_form_sheet {
|
||||
max-width: $o-form-view-sheet-max-width;
|
||||
width: 100%;
|
||||
@include media-breakpoint-up(md) {
|
||||
margin: $o-sheet-vpadding * 0.2 auto;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
/*
|
||||
Copyright 2024 Alitec Pte Ltd (https://www.alitec.sg).
|
||||
License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).
|
||||
*/
|
||||
|
||||
.o-mail-Form-chatter {
|
||||
&:not(.o-aside):not(.o-full-width) .o-mail-Chatter {
|
||||
max-width: $o-form-view-sheet-max-width;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
.o_xxl_form_view .o_form_sheet_bg .o_form_sheet {
|
||||
overflow: unset !important;
|
||||
}
|
||||
Loading…
Reference in New Issue