diff --git a/setup/web_widget_url_advanced/odoo/addons/web_widget_url_advanced b/setup/web_widget_url_advanced/odoo/addons/web_widget_url_advanced new file mode 120000 index 000000000..53c82b305 --- /dev/null +++ b/setup/web_widget_url_advanced/odoo/addons/web_widget_url_advanced @@ -0,0 +1 @@ +../../../../web_widget_url_advanced \ No newline at end of file diff --git a/setup/web_widget_url_advanced/setup.py b/setup/web_widget_url_advanced/setup.py new file mode 100644 index 000000000..28c57bb64 --- /dev/null +++ b/setup/web_widget_url_advanced/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +) diff --git a/web_widget_url_advanced/README.rst b/web_widget_url_advanced/README.rst new file mode 100644 index 000000000..5b96f855f --- /dev/null +++ b/web_widget_url_advanced/README.rst @@ -0,0 +1,139 @@ +======================= +Web URL widget advanced +======================= + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/14.0/web_widget_url_advanced + :alt: OCA/web +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-14-0/web-14-0-web_widget_url_advanced + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/162/14.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +Extend URL widget features to ease customization of anchor's text. + +By default, the URL widget will show the plain URL. +You can specify an attribute to provide a static label too. + +With this module, you can use a field for link's inner text using attribute +'text_field'. You can also add a prefix to the link using attribute +'prefix_name'. + +Until 13.0 this functionality was separated in modules 'web_widget_url_advanced' +and 'web_widget_prefixed_url' + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +Use `url` widget as you do usually, then add an extra parameter `text_field` +to indicate which field (present in the view already) must be used for the anchor text. + + +.. code-block:: xml + + + +M2O fields are supported: `display_name` is used automatically. + + +For example, in the partner form, +if you want to display the website link with partner's name as anchor you can do: + + +.. code-block:: xml + + + +This is going to change the rendering from + +.. figure:: https://raw.githubusercontent.com/OCA/web/14.0/web_widget_url_advanced/static/description/before.png + + +to + +.. figure:: https://raw.githubusercontent.com/OCA/web/14.0/web_widget_url_advanced/static/description/after.png + +Or user can add any hyperlink text using 'prefix_name' attribute + +.. code-block:: xml + + + +both can be applied inside the options attribute too: + +.. code-block:: xml + + + +Known issues / Roadmap +====================== + +* ```` is not supported in tree views. + +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 smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Camptocamp + +Contributors +~~~~~~~~~~~~ + +* Simone Orsi +* `CorporateHub `__ + + * Alexey Pelykh + +* Jay Vora +* Swapnesh Shah +* Joan Sisquella +* Peerapong Supasompob + +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. + +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_widget_url_advanced/__init__.py b/web_widget_url_advanced/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/web_widget_url_advanced/__manifest__.py b/web_widget_url_advanced/__manifest__.py new file mode 100644 index 000000000..bfd7b8a06 --- /dev/null +++ b/web_widget_url_advanced/__manifest__.py @@ -0,0 +1,18 @@ +# Copyright 2018 Simone Orsi - Camptocamp SA +# License LGPLv3.0 or later (https://www.gnu.org/licenses/lgpl-3.0.en.html). +{ + "name": "Web URL widget advanced", + "summary": "This module extends URL widget " + "for displaying anchors with custom labels.", + "category": "Web", + "version": "15.0.1.0.0", + "license": "LGPL-3", + "author": "Camptocamp, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/web", + "depends": ["web"], + "data": [], + "assets": { + "web.assets_backend": ["web_widget_url_advanced/static/src/js/url_widget.js"], + }, + "installable": True, +} diff --git a/web_widget_url_advanced/i18n/es.po b/web_widget_url_advanced/i18n/es.po new file mode 100644 index 000000000..e69de29bb diff --git a/web_widget_url_advanced/i18n/web_widget_url_advanced.pot b/web_widget_url_advanced/i18n/web_widget_url_advanced.pot new file mode 100644 index 000000000..4d8b20f91 --- /dev/null +++ b/web_widget_url_advanced/i18n/web_widget_url_advanced.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 14.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_widget_url_advanced/i18n/zh_CN.po b/web_widget_url_advanced/i18n/zh_CN.po new file mode 100644 index 000000000..e69de29bb diff --git a/web_widget_url_advanced/readme/CONTRIBUTORS.rst b/web_widget_url_advanced/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..eaab2758a --- /dev/null +++ b/web_widget_url_advanced/readme/CONTRIBUTORS.rst @@ -0,0 +1,9 @@ +* Simone Orsi +* `CorporateHub `__ + + * Alexey Pelykh + +* Jay Vora +* Swapnesh Shah +* Joan Sisquella +* Peerapong Supasompob diff --git a/web_widget_url_advanced/readme/DESCRIPTION.rst b/web_widget_url_advanced/readme/DESCRIPTION.rst new file mode 100644 index 000000000..880e48a64 --- /dev/null +++ b/web_widget_url_advanced/readme/DESCRIPTION.rst @@ -0,0 +1,11 @@ +Extend URL widget features to ease customization of anchor's text. + +By default, the URL widget will show the plain URL. +You can specify an attribute to provide a static label too. + +With this module, you can use a field for link's inner text using attribute +'text_field'. You can also add a prefix to the link using attribute +'prefix_name'. + +Until 13.0 this functionality was separated in modules 'web_widget_url_advanced' +and 'web_widget_prefixed_url' diff --git a/web_widget_url_advanced/readme/ROADMAP.rst b/web_widget_url_advanced/readme/ROADMAP.rst new file mode 100644 index 000000000..200b385d5 --- /dev/null +++ b/web_widget_url_advanced/readme/ROADMAP.rst @@ -0,0 +1 @@ +* ```` is not supported in tree views. diff --git a/web_widget_url_advanced/readme/USAGE.rst b/web_widget_url_advanced/readme/USAGE.rst new file mode 100644 index 000000000..fbd872911 --- /dev/null +++ b/web_widget_url_advanced/readme/USAGE.rst @@ -0,0 +1,39 @@ +Use `url` widget as you do usually, then add an extra parameter `text_field` +to indicate which field (present in the view already) must be used for the anchor text. + + +.. code-block:: xml + + + +M2O fields are supported: `display_name` is used automatically. + + +For example, in the partner form, +if you want to display the website link with partner's name as anchor you can do: + + +.. code-block:: xml + + + +This is going to change the rendering from + +.. figure:: ../static/description/before.png + + +to + +.. figure:: ../static/description/after.png + +Or user can add any hyperlink text using 'prefix_name' attribute + +.. code-block:: xml + + + +both can be applied inside the options attribute too: + +.. code-block:: xml + + diff --git a/web_widget_url_advanced/static/description/after.png b/web_widget_url_advanced/static/description/after.png new file mode 100644 index 000000000..fff2176e7 Binary files /dev/null and b/web_widget_url_advanced/static/description/after.png differ diff --git a/web_widget_url_advanced/static/description/before.png b/web_widget_url_advanced/static/description/before.png new file mode 100644 index 000000000..10d6fc764 Binary files /dev/null and b/web_widget_url_advanced/static/description/before.png differ diff --git a/web_widget_url_advanced/static/description/icon.png b/web_widget_url_advanced/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/web_widget_url_advanced/static/description/icon.png differ diff --git a/web_widget_url_advanced/static/description/index.html b/web_widget_url_advanced/static/description/index.html new file mode 100644 index 000000000..ac9ecc0ad --- /dev/null +++ b/web_widget_url_advanced/static/description/index.html @@ -0,0 +1,472 @@ + + + + + + +Web URL widget advanced + + + +
+

Web URL widget advanced

+ + +

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

+

Extend URL widget features to ease customization of anchor’s text.

+

By default, the URL widget will show the plain URL. +You can specify an attribute to provide a static label too.

+

With this module, you can use a field for link’s inner text using attribute +‘text_field’. You can also add a prefix to the link using attribute +‘prefix_name’.

+

Until 13.0 this functionality was separated in modules ‘web_widget_url_advanced’ +and ‘web_widget_prefixed_url’

+

Table of contents

+ +
+

Usage

+

Use url widget as you do usually, then add an extra parameter text_field +to indicate which field (present in the view already) must be used for the anchor text.

+
+<field name="some_url" widget="url" text_field="another_field" />
+
+

M2O fields are supported: display_name is used automatically.

+

For example, in the partner form, +if you want to display the website link with partner’s name as anchor you can do:

+
+<field name="website" widget="url" text_field="name" placeholder="e.g. www.odoo.com"/>
+
+

This is going to change the rendering from

+
+https://raw.githubusercontent.com/OCA/web/14.0/web_widget_url_advanced/static/description/before.png +
+

to

+
+https://raw.githubusercontent.com/OCA/web/14.0/web_widget_url_advanced/static/description/after.png +
+

Or user can add any hyperlink text using ‘prefix_name’ attribute

+
+<field name="skype_name" widget="url" 'prefix_name': 'skype'/>
+
+

both can be applied inside the options attribute too:

+
+<field name="skype_name" widget="url" options="{'prefix_name': 'skype'}"/>
+
+
+
+

Known issues / Roadmap

+
    +
  • <field text_field="foo"/> is not supported in tree views.
    • +
+
+
+

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 smashing it by providing a detailed and welcomed +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Camptocamp
    • +
+
+
+

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.

+

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_widget_url_advanced/static/src/js/url_widget.js b/web_widget_url_advanced/static/src/js/url_widget.js new file mode 100644 index 000000000..64ec85f81 --- /dev/null +++ b/web_widget_url_advanced/static/src/js/url_widget.js @@ -0,0 +1,50 @@ +/* Copyright 2018 Simone Orsi - Camptocamp SA +License LGPLv3.0 or later (https://www.gnu.org/licenses/lgpl-3.0.en.html). */ + +odoo.define("web_widget_url_advanced", function (require) { + "use strict"; + var basic_fields = require("web.basic_fields"); + + basic_fields.UrlWidget.include({ + /** + * @override + */ + init: function () { + this._super.apply(this, arguments); + // Retrieve customized `` text from a field + // via `text_field` attribute or `options.text_field` + this.text_field = this.attrs.text_field || this.attrs.options.text_field; + }, + /** + * Retrieve anchor text based on options. + * @returns {String} + */ + _get_text: function () { + if (this.text_field) { + var field_value = this.recordData[this.text_field]; + if (_.isObject(field_value) && _.has(field_value.data)) { + field_value = field_value.data.display_name; + } + return field_value; + } + return this.attrs.text; + }, + /** + * + * @override + * @private + */ + _renderReadonly: function () { + // Base widget uses `this.attrs.text` instead of `this.value` when available. + // TODO: To check better way for update link + this.attrs.text = this._get_text(); + this._super.apply(this, arguments); + var prefix = this.attrs.prefix_name || this.attrs.options.prefix_name; + if (prefix) { + this.$el.html( + $(this.$el.html()).attr("href", prefix + ":" + this.value) + ); + } + }, + }); +});