diff --git a/web_remember_tree_column_width/README.rst b/web_remember_tree_column_width/README.rst new file mode 100644 index 000000000000..3fd1078844bc --- /dev/null +++ b/web_remember_tree_column_width/README.rst @@ -0,0 +1,104 @@ +============================== +Web Remember Tree Column Width +============================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:ec03536e8e88c5e3dbb117d391ba923b60e328998f72c81cee3b41c8ecaea9c2 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html + :alt: License: LGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github + :target: https://github.com/OCA/web/tree/18.0/web_remember_tree_column_width + :alt: OCA/web +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-18-0/web-18-0-web_remember_tree_column_width + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=18.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +Remember the tree columns' widths across sessions, and after filtering, +grouping, or reordering. + +**Table of contents** + +.. contents:: + :local: + +Known issues / Roadmap +====================== + +In certain cases, an event may pass a th element that cannot be used to +retrieve the corresponding td element. When this happens, the modified +column width is not stored. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Vauxoo + +Contributors +------------ + +- Francisco Javier Luna Vázquez +- Tomás Álvarez +- `Komit `__: + + - Cuong Nguyen Mtm + +- Jasmin Solanki + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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-frahikLV| image:: https://github.com/frahikLV.png?size=40px + :target: https://github.com/frahikLV + :alt: frahikLV +.. |maintainer-luisg123v| image:: https://github.com/luisg123v.png?size=40px + :target: https://github.com/luisg123v + :alt: luisg123v +.. |maintainer-cuongnmtm| image:: https://github.com/cuongnmtm.png?size=40px + :target: https://github.com/cuongnmtm + :alt: cuongnmtm + +Current `maintainers `__: + +|maintainer-frahikLV| |maintainer-luisg123v| |maintainer-cuongnmtm| + +This module is part of the `OCA/web `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/web_remember_tree_column_width/__init__.py b/web_remember_tree_column_width/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/web_remember_tree_column_width/__manifest__.py b/web_remember_tree_column_width/__manifest__.py new file mode 100644 index 000000000000..f2a63b3ba710 --- /dev/null +++ b/web_remember_tree_column_width/__manifest__.py @@ -0,0 +1,24 @@ +{ + "name": "Web Remember Tree Column Width", + "summary": "Remember the tree columns' widths across sessions.", + "author": "Vauxoo, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/web", + "license": "LGPL-3", + "category": "Extra Tools", + "version": "18.0.1.0.0", + "maintainers": [ + "frahikLV", + "luisg123v", + "cuongnmtm", + ], + "depends": [ + "web", + ], + "data": [], + "assets": { + "web.assets_backend": [ + "web_remember_tree_column_width/static/src/**/*", + ], + }, + "installable": True, +} diff --git a/web_remember_tree_column_width/i18n/it.po b/web_remember_tree_column_width/i18n/it.po new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/web_remember_tree_column_width/i18n/web_remember_tree_column_width.pot b/web_remember_tree_column_width/i18n/web_remember_tree_column_width.pot new file mode 100644 index 000000000000..716a0702d88a --- /dev/null +++ b/web_remember_tree_column_width/i18n/web_remember_tree_column_width.pot @@ -0,0 +1,13 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 17.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" diff --git a/web_remember_tree_column_width/pyproject.toml b/web_remember_tree_column_width/pyproject.toml new file mode 100644 index 000000000000..4231d0cccb3d --- /dev/null +++ b/web_remember_tree_column_width/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/web_remember_tree_column_width/readme/CONTRIBUTORS.md b/web_remember_tree_column_width/readme/CONTRIBUTORS.md new file mode 100644 index 000000000000..763d20923a59 --- /dev/null +++ b/web_remember_tree_column_width/readme/CONTRIBUTORS.md @@ -0,0 +1,5 @@ +- Francisco Javier Luna Vázquez \<\> +- Tomás Álvarez \<\> +- [Komit](https://komit-consulting.com/): + - Cuong Nguyen Mtm \<\> +- Jasmin Solanki \<\> \ No newline at end of file diff --git a/web_remember_tree_column_width/readme/DESCRIPTION.md b/web_remember_tree_column_width/readme/DESCRIPTION.md new file mode 100644 index 000000000000..28df572daeec --- /dev/null +++ b/web_remember_tree_column_width/readme/DESCRIPTION.md @@ -0,0 +1,2 @@ +Remember the tree columns' widths across sessions, and after filtering, +grouping, or reordering. diff --git a/web_remember_tree_column_width/readme/ROADMAP.md b/web_remember_tree_column_width/readme/ROADMAP.md new file mode 100644 index 000000000000..081cf202f00a --- /dev/null +++ b/web_remember_tree_column_width/readme/ROADMAP.md @@ -0,0 +1 @@ +In certain cases, an event may pass a th element that cannot be used to retrieve the corresponding td element. When this happens, the modified column width is not stored. \ No newline at end of file diff --git a/web_remember_tree_column_width/static/description/icon.png b/web_remember_tree_column_width/static/description/icon.png new file mode 100644 index 000000000000..3a0328b516c4 Binary files /dev/null and b/web_remember_tree_column_width/static/description/icon.png differ diff --git a/web_remember_tree_column_width/static/description/index.html b/web_remember_tree_column_width/static/description/index.html new file mode 100644 index 000000000000..dfbf6650a51f --- /dev/null +++ b/web_remember_tree_column_width/static/description/index.html @@ -0,0 +1,439 @@ + + + + + +Web Remember Tree Column Width + + + +
+

Web Remember Tree Column Width

+ + +

Beta License: LGPL-3 OCA/web Translate me on Weblate Try me on Runboat

+

Remember the tree columns’ widths across sessions, and after filtering, +grouping, or reordering.

+

Table of contents

+ +
+

Known issues / Roadmap

+

In certain cases, an event may pass a th element that cannot be used to +retrieve the corresponding td element. When this happens, the modified +column width is not stored.

+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Vauxoo
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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.

+

Current maintainers:

+

frahikLV luisg123v cuongnmtm

+

This module is part of the OCA/web project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/web_remember_tree_column_width/static/src/js/list_renderer.esm.js b/web_remember_tree_column_width/static/src/js/list_renderer.esm.js new file mode 100644 index 000000000000..92ac6f8a4c50 --- /dev/null +++ b/web_remember_tree_column_width/static/src/js/list_renderer.esm.js @@ -0,0 +1,132 @@ +import {useComponent, useEffect, useExternalListener} from "@odoo/owl"; +import {ListRenderer} from "@web/views/list/list_renderer"; +import {browser} from "@web/core/browser/browser"; +import {patch} from "@web/core/utils/patch"; +import {useDebounced} from "@web/core/utils/timing"; + +/** + * Override on useMagicColumnWidths from web/static/src/views/list/column_width_hook.js + * This is an exported function that returns two internals, one of which we will + * be overriding below. + * + * @param {tableRef} wrapper around the DOM element of the list view table + * @param {getState} some internals from the list view passed in its setUp + * @param {orig} the return value from upstream useMagicColumWidths, consisting + * of a _resizing variable reference and an onStartResize function reference. + */ +export function useMagicColumnWidths(tableRef, getState, orig) { + const onStartResizeOrig = orig.onStartResize; + const renderer = useComponent(); + + /** + * Override on onStartResize as returned from upstream's useMagicColumnWidths. + * We call super, then add event listeners for our own stopResize handler + * which stores column widths in the brower's localstorage. + */ + function onStartResize(evstart) { + // Call original method + const res = onStartResizeOrig(evstart); + const resizeStoppingEvents = ["keydown", "pointerdown", "pointerup"]; + + // Mouse or keyboard events : stop resize + const stopResize = (evstop) => { + // Ignores the 'left mouse button down' event as it used to start resizing + if (evstop.type === "pointerdown" && evstop.button === 0) { + return; + } + evstop.preventDefault(); + evstop.stopPropagation(); + + const th = evstop.target.closest("th"); + if (th === null || th === undefined) { + return; + } + const fieldName = th.dataset.name; + const resModel = this.props.list.model.config.resModel; + if (resModel && fieldName && browser.localStorage) { + var width = + parseInt((th.style.width || "0").replace("px", ""), 10) || 0; + browser.localStorage.setItem( + "odoo.columnWidth." + resModel + "." + fieldName, + width + ); + } + for (const eventType of resizeStoppingEvents) { + window.removeEventListener(eventType, stopResize); + } + }; + for (const eventType of resizeStoppingEvents) { + window.addEventListener(eventType, stopResize); + } + return res; + } + + /** + * Set stored column widths. + */ + function setStoredColumnWidths() { + const table = tableRef.el; + const headers = [...table.querySelectorAll("thead th")]; + const state = getState(); + const resModel = state.model.config.resModel; + const columnOffset = state.hasSelectors ? 1 : 0; + headers.forEach((el, elIndex) => { + var column = state.columns[elIndex - columnOffset]; + const fieldName = (column && column.name) || ""; + if ( + !el.classList.contains("o_list_button") && + fieldName && + resModel && + browser.localStorage + ) { + const storedWidth = browser.localStorage.getItem( + `odoo.columnWidth.${resModel}.${fieldName}` + ); + if (storedWidth) { + var width = `${Math.floor(parseInt(storedWidth, 10))}px`; + el.style.width = width; + } + } + }); + } + + /** + * Call setStoredColumnWidths on init and on window resize. + */ + if (renderer.constructor.useMagicColumnWidths) { + useEffect(setStoredColumnWidths); + const debouncedResizeCallback = useDebounced(() => { + setStoredColumnWidths(); + }, 300); + useExternalListener(window, "resize", debouncedResizeCallback); + } + + orig.onStartResize = onStartResize; + return orig; +} + +patch(ListRenderer.prototype, { + /** + * Replace this list view's columnWidths attribute + */ + setup() { + super.setup(); + const columnWidthsOrig = this.columnWidths; + this.columnWidths = useMagicColumnWidths( + this.tableRef, + () => { + return { + columns: this.columns, + isEmpty: + !this.props.list.records.length || + this.props.list.model.useSampleModel, + hasSelectors: this.hasSelectors, + hasOpenFormViewColumn: this.hasOpenFormViewColumn, + hasActionsColumn: this.hasActionsColumn, + model: this.props.list.model, + }; + }, + columnWidthsOrig + ); + }, +}); diff --git a/web_remember_tree_column_width/static/src/scss/main.scss b/web_remember_tree_column_width/static/src/scss/main.scss new file mode 100644 index 000000000000..07b5aa024fbc --- /dev/null +++ b/web_remember_tree_column_width/static/src/scss/main.scss @@ -0,0 +1,4 @@ +th.o_column_sortable { + max-width: none !important; + min-width: 0 !important; +}