From 65bdd44cf822921dcc16892b0c43cc1c546193c5 Mon Sep 17 00:00:00 2001 From: Akim Juillerat Date: Wed, 10 Jul 2024 21:24:05 +0200 Subject: [PATCH 1/3] Create module web_datetime_picker_default_time --- .../addons/web_datetime_picker_default_time | 1 + .../web_datetime_picker_default_time/setup.py | 6 + web_datetime_picker_default_time/README.rst | 108 ++++++++++++++++++ web_datetime_picker_default_time/__init__.py | 0 .../__manifest__.py | 20 ++++ .../readme/CONTRIBUTORS.md | 2 + .../readme/DESCRIPTION.md | 7 ++ .../readme/ROADMAP.md | 1 + .../readme/USAGE.md | 5 + .../static/src/js/datepicker.esm.js | 36 ++++++ 10 files changed, 186 insertions(+) create mode 120000 setup/web_datetime_picker_default_time/odoo/addons/web_datetime_picker_default_time create mode 100644 setup/web_datetime_picker_default_time/setup.py create mode 100644 web_datetime_picker_default_time/README.rst create mode 100644 web_datetime_picker_default_time/__init__.py create mode 100644 web_datetime_picker_default_time/__manifest__.py create mode 100644 web_datetime_picker_default_time/readme/CONTRIBUTORS.md create mode 100644 web_datetime_picker_default_time/readme/DESCRIPTION.md create mode 100644 web_datetime_picker_default_time/readme/ROADMAP.md create mode 100644 web_datetime_picker_default_time/readme/USAGE.md create mode 100644 web_datetime_picker_default_time/static/src/js/datepicker.esm.js diff --git a/setup/web_datetime_picker_default_time/odoo/addons/web_datetime_picker_default_time b/setup/web_datetime_picker_default_time/odoo/addons/web_datetime_picker_default_time new file mode 120000 index 000000000..0306220d0 --- /dev/null +++ b/setup/web_datetime_picker_default_time/odoo/addons/web_datetime_picker_default_time @@ -0,0 +1 @@ +../../../../web_datetime_picker_default_time \ No newline at end of file diff --git a/setup/web_datetime_picker_default_time/setup.py b/setup/web_datetime_picker_default_time/setup.py new file mode 100644 index 000000000..28c57bb64 --- /dev/null +++ b/setup/web_datetime_picker_default_time/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +) diff --git a/web_datetime_picker_default_time/README.rst b/web_datetime_picker_default_time/README.rst new file mode 100644 index 000000000..ac0fe1a53 --- /dev/null +++ b/web_datetime_picker_default_time/README.rst @@ -0,0 +1,108 @@ +================================ +Web Datetime Picker Default Time +================================ + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:876c728e4efe7028ccfa4c129a7fd0be521b76bbc7dc2add21ff0d3a7f903860 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github + :target: https://github.com/OCA/web/tree/16.0/web_datetime_picker_default_time + :alt: OCA/web +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_datetime_picker_default_time + :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=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module customizes the datetime picker widget and allows to define a +default time to be applied in case the user selects only a Date. + +For example, if a user wants to define a commitment date without having +to specify the time on that date, setting the default time value on the +field in the Form view allows to ensure the commitment date will be set +to this time instead of the time when the page was loaded by the +browser. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +You can define the default time as follows : + +.. code-block:: xml + +.. raw:: html + + + +Known issues / Roadmap +====================== + +- Handle Timezone related to the default time + +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 +------- + +* Camptocamp + +Contributors +------------ + +- Akim Juillerat akim.juillerat@camptocamp.com +- Iván Todorovich ivan.todorovich@camptocamp.com + +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-grindtildeath| image:: https://github.com/grindtildeath.png?size=40px + :target: https://github.com/grindtildeath + :alt: grindtildeath + +Current `maintainer `__: + +|maintainer-grindtildeath| + +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_datetime_picker_default_time/__init__.py b/web_datetime_picker_default_time/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/web_datetime_picker_default_time/__manifest__.py b/web_datetime_picker_default_time/__manifest__.py new file mode 100644 index 000000000..fab4d6e85 --- /dev/null +++ b/web_datetime_picker_default_time/__manifest__.py @@ -0,0 +1,20 @@ +# Copyright 2024 Camptocamp SA +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl) +{ + "name": "Web Datetime Picker Default Time", + "summary": "Allows to define a default time on datetime picker", + "version": "16.0.1.0.0", + "category": "web", + "website": "https://github.com/OCA/web", + "author": "Camptocamp, Odoo Community Association (OCA)", + "maintainers": ["grindtildeath"], + "license": "AGPL-3", + "depends": [ + "web", + ], + "assets": { + "web.assets_backend": [ + "/web_datetime_picker_default_time/static/src/js/datepicker.esm.js", + ], + }, +} diff --git a/web_datetime_picker_default_time/readme/CONTRIBUTORS.md b/web_datetime_picker_default_time/readme/CONTRIBUTORS.md new file mode 100644 index 000000000..6168e901d --- /dev/null +++ b/web_datetime_picker_default_time/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +* Akim Juillerat +* Iván Todorovich diff --git a/web_datetime_picker_default_time/readme/DESCRIPTION.md b/web_datetime_picker_default_time/readme/DESCRIPTION.md new file mode 100644 index 000000000..4e15c7e13 --- /dev/null +++ b/web_datetime_picker_default_time/readme/DESCRIPTION.md @@ -0,0 +1,7 @@ +This module customizes the datetime picker widget and allows to define a default +time to be applied in case the user selects only a Date. + +For example, if a user wants to define a commitment date without having to specify +the time on that date, setting the default time value on the field in the Form view +allows to ensure the commitment date will be set to this time instead of the time +when the page was loaded by the browser. diff --git a/web_datetime_picker_default_time/readme/ROADMAP.md b/web_datetime_picker_default_time/readme/ROADMAP.md new file mode 100644 index 000000000..53bc26362 --- /dev/null +++ b/web_datetime_picker_default_time/readme/ROADMAP.md @@ -0,0 +1 @@ +* Handle Timezone related to the default time diff --git a/web_datetime_picker_default_time/readme/USAGE.md b/web_datetime_picker_default_time/readme/USAGE.md new file mode 100644 index 000000000..3e66343a5 --- /dev/null +++ b/web_datetime_picker_default_time/readme/USAGE.md @@ -0,0 +1,5 @@ +You can define the default time as follows : + +.. code-block:: xml + + diff --git a/web_datetime_picker_default_time/static/src/js/datepicker.esm.js b/web_datetime_picker_default_time/static/src/js/datepicker.esm.js new file mode 100644 index 000000000..c23e7280c --- /dev/null +++ b/web_datetime_picker_default_time/static/src/js/datepicker.esm.js @@ -0,0 +1,36 @@ +/** @odoo-module **/ +/* Copyright 2024 Camptocamp + * License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl) */ + +import {DatePicker, DateTimePicker} from "@web/core/datepicker/datepicker"; +import {patch} from "@web/core/utils/patch"; + +patch(DateTimePicker.prototype, "DateTimePickerDefaultTime", { + onMounted() { + this._super.apply(this, arguments); + this.addPickerListener("change", ({date, oldDate}) => { + const default_time = this.props.defaultTime; + if (date && !oldDate && default_time) { + // FIXME: Consider TZ + date.set({ + hour: default_time.hour, + minute: default_time.minute, + second: default_time.second, + }); + window.$(this.rootRef.el).datetimepicker("date", date); + } + }); + }, +}); + +DateTimePicker.props = _.extend({}, DatePicker.props, { + defaultTime: { + type: Object, + shape: { + hour: Number, + minute: Number, + second: Number, + }, + optional: true, + }, +}); From 3af6b1d7f4be88463c7593ed960d893035f6ed01 Mon Sep 17 00:00:00 2001 From: Akim Juillerat Date: Tue, 16 Jul 2024 21:03:12 +0200 Subject: [PATCH 2/3] Support dynamic default time from another field --- web_datetime_picker_default_time/README.rst | 22 +- .../__manifest__.py | 3 +- .../readme/USAGE.md | 22 +- .../static/description/index.html | 457 ++++++++++++++++++ .../static/src/js/datepicker.esm.js | 4 +- .../static/src/js/datetime_field.esm.js | 42 ++ .../static/src/xml/datetime_field.xml | 8 + 7 files changed, 548 insertions(+), 10 deletions(-) create mode 100644 web_datetime_picker_default_time/static/description/index.html create mode 100644 web_datetime_picker_default_time/static/src/js/datetime_field.esm.js create mode 100644 web_datetime_picker_default_time/static/src/xml/datetime_field.xml diff --git a/web_datetime_picker_default_time/README.rst b/web_datetime_picker_default_time/README.rst index ac0fe1a53..529a383db 100644 --- a/web_datetime_picker_default_time/README.rst +++ b/web_datetime_picker_default_time/README.rst @@ -45,13 +45,27 @@ browser. Usage ===== -You can define the default time as follows : +You can define the default time as follows for a static value: -.. code-block:: xml +.. code:: xml -.. raw:: html + - +Otherwise you can also use a JSON field to make it dynamic through a +compute function, and reference this field in the view: + +.. code:: python + + start_time = field.Json(compute="_compute_start_time") + + def _compute_start_time(self): + for rec in self: + rec.start_time = {'hour': 8, 'minute': 30, 'second': 15 } + +.. code:: xml + + + Known issues / Roadmap ====================== diff --git a/web_datetime_picker_default_time/__manifest__.py b/web_datetime_picker_default_time/__manifest__.py index fab4d6e85..98d289a2b 100644 --- a/web_datetime_picker_default_time/__manifest__.py +++ b/web_datetime_picker_default_time/__manifest__.py @@ -14,7 +14,8 @@ ], "assets": { "web.assets_backend": [ - "/web_datetime_picker_default_time/static/src/js/datepicker.esm.js", + "/web_datetime_picker_default_time/static/src/js/*.js", + "/web_datetime_picker_default_time/static/src/xml/*.xml", ], }, } diff --git a/web_datetime_picker_default_time/readme/USAGE.md b/web_datetime_picker_default_time/readme/USAGE.md index 3e66343a5..03e2fc174 100644 --- a/web_datetime_picker_default_time/readme/USAGE.md +++ b/web_datetime_picker_default_time/readme/USAGE.md @@ -1,5 +1,21 @@ -You can define the default time as follows : +You can define the default time as follows for a static value: -.. code-block:: xml +```xml + +``` - +Otherwise you can also use a JSON field to make it dynamic through a compute function, +and reference this field in the view: + +```python + start_time = field.Json(compute="_compute_start_time") + + def _compute_start_time(self): + for rec in self: + rec.start_time = {'hour': 8, 'minute': 30, 'second': 15 } +``` + +```xml + + +``` diff --git a/web_datetime_picker_default_time/static/description/index.html b/web_datetime_picker_default_time/static/description/index.html new file mode 100644 index 000000000..f87f617e4 --- /dev/null +++ b/web_datetime_picker_default_time/static/description/index.html @@ -0,0 +1,457 @@ + + + + + +Web Datetime Picker Default Time + + + +
+

Web Datetime Picker Default Time

+ + +

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

+

This module customizes the datetime picker widget and allows to define a +default time to be applied in case the user selects only a Date.

+

For example, if a user wants to define a commitment date without having +to specify the time on that date, setting the default time value on the +field in the Form view allows to ensure the commitment date will be set +to this time instead of the time when the page was loaded by the +browser.

+

Table of contents

+ +
+

Usage

+

You can define the default time as follows for a static value:

+
+<field name="your_datetime_field" options="{'defaultTime': {'hour': 8, 'minute': 30, 'second': 15 }}"/>
+
+

Otherwise you can also use a JSON field to make it dynamic through a +compute function, and reference this field in the view:

+
+start_time = field.Json(compute="_compute_start_time")
+
+def _compute_start_time(self):
+    for rec in self:
+        rec.start_time = {'hour': 8, 'minute': 30, 'second': 15 }
+
+
+<field name="start_time" invisible="1" />
+<field name="your_datetime_field" options="{'defaultTime': 'start_time'}"/>
+
+
+
+

Known issues / Roadmap

+
    +
  • Handle Timezone related to the default time
    • +
+
+
+

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

+
    +
  • Camptocamp
    • +
+
+ +
+

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 maintainer:

+

grindtildeath

+

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_datetime_picker_default_time/static/src/js/datepicker.esm.js b/web_datetime_picker_default_time/static/src/js/datepicker.esm.js index c23e7280c..65f5425d6 100644 --- a/web_datetime_picker_default_time/static/src/js/datepicker.esm.js +++ b/web_datetime_picker_default_time/static/src/js/datepicker.esm.js @@ -2,7 +2,7 @@ /* Copyright 2024 Camptocamp * License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl) */ -import {DatePicker, DateTimePicker} from "@web/core/datepicker/datepicker"; +import {DateTimePicker} from "@web/core/datepicker/datepicker"; import {patch} from "@web/core/utils/patch"; patch(DateTimePicker.prototype, "DateTimePickerDefaultTime", { @@ -23,7 +23,7 @@ patch(DateTimePicker.prototype, "DateTimePickerDefaultTime", { }, }); -DateTimePicker.props = _.extend({}, DatePicker.props, { +DateTimePicker.props = _.extend({}, DateTimePicker.props, { defaultTime: { type: Object, shape: { diff --git a/web_datetime_picker_default_time/static/src/js/datetime_field.esm.js b/web_datetime_picker_default_time/static/src/js/datetime_field.esm.js new file mode 100644 index 000000000..58f46609f --- /dev/null +++ b/web_datetime_picker_default_time/static/src/js/datetime_field.esm.js @@ -0,0 +1,42 @@ +/** @odoo-module **/ +/* Copyright 2024 Camptocamp + * License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl) */ + +import {DateTimeField} from "@web/views/fields/datetime/datetime_field"; +import {patch} from "@web/core/utils/patch"; + +patch(DateTimeField.prototype, "DateTimeFieldDefaultTime", { + get defaultTime() { + if (typeof this.props.defaultTime === "string") { + return this.props.record.data[this.props.defaultTime]; + } + return this.props.defaultTime; + }, +}); + +DateTimeField.props = _.extend({}, DateTimeField.props, { + defaultTime: { + type: [ + String, + { + type: Object, + shape: { + hour: Number, + minute: Number, + second: Number, + }, + optional: true, + }, + ], + optional: true, + }, +}); + +const super_extractProps = DateTimeField.extractProps; + +DateTimeField.extractProps = ({attrs}) => { + return { + ...super_extractProps({attrs}), + defaultTime: attrs.options.defaultTime, + }; +}; diff --git a/web_datetime_picker_default_time/static/src/xml/datetime_field.xml b/web_datetime_picker_default_time/static/src/xml/datetime_field.xml new file mode 100644 index 000000000..df9affad0 --- /dev/null +++ b/web_datetime_picker_default_time/static/src/xml/datetime_field.xml @@ -0,0 +1,8 @@ + + + + + defaultTime + + + From bda8836396f9516c52310c437e104614074867c7 Mon Sep 17 00:00:00 2001 From: Akim Juillerat Date: Tue, 13 Aug 2024 17:38:08 +0200 Subject: [PATCH 3/3] Apply default time on manual entry of date string --- .../static/src/js/datepicker.esm.js | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/web_datetime_picker_default_time/static/src/js/datepicker.esm.js b/web_datetime_picker_default_time/static/src/js/datepicker.esm.js index 65f5425d6..f453cbf7c 100644 --- a/web_datetime_picker_default_time/static/src/js/datepicker.esm.js +++ b/web_datetime_picker_default_time/static/src/js/datepicker.esm.js @@ -4,6 +4,7 @@ import {DateTimePicker} from "@web/core/datepicker/datepicker"; import {patch} from "@web/core/utils/patch"; +import {localization} from "@web/core/l10n/localization"; patch(DateTimePicker.prototype, "DateTimePickerDefaultTime", { onMounted() { @@ -21,6 +22,27 @@ patch(DateTimePicker.prototype, "DateTimePickerDefaultTime", { } }); }, + isStrDate(input_string) { + return input_string.trim().length == localization.dateFormat.length; + }, + customParseValue(input_value, options) { + const default_time = this.props.defaultTime; + let [res, error] = this.parseValueOriginal(input_value, options); + if (default_time && this.isStrDate(input_value)) { + const new_value = res.set({ + hour: default_time.hour, + minute: default_time.minute, + second: default_time.second, + }); + res = new_value; + } + return [res, error]; + }, + initFormat() { + this._super.apply(this, arguments); + this.parseValueOriginal = this.parseValue; + this.parseValue = this.customParseValue; + }, }); DateTimePicker.props = _.extend({}, DateTimePicker.props, {