Skip to content

Commit

Permalink
[ADD] new module web_widget_many2one_colored
Browse files Browse the repository at this point in the history
  • Loading branch information
huguesdk committed Jul 2, 2024
1 parent 19c94c8 commit 447c82e
Show file tree
Hide file tree
Showing 19 changed files with 893 additions and 0 deletions.
6 changes: 6 additions & 0 deletions setup/web_widget_many2one_colored/setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import setuptools

setuptools.setup(
setup_requires=['setuptools-odoo'],
odoo_addon=True,
)
121 changes: 121 additions & 0 deletions web_widget_many2one_colored/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
=============================
Colored Many2one field widget
=============================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:6c665bb94dac0f660a9ae65679c32b7c2ea4450ba8d507bd8a0faae5a143abf6
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |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_widget_many2one_colored
: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_widget_many2one_colored
: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|

Display ``Many2one`` fields using a color field of their model.

**Table of contents**

.. contents::
:local:

Usage
=====

To use this widget, use the ``widget`` attribute on a ``Many2one`` field:

.. code-block:: XML
<field
name="type_id"
widget="many2one_colored"
options="{'no_open': True}"
/>
The ``no_open`` option is required for the field to appear in color, otherwise
it will be a hyperlink allowing to open the corresponding record, and thus
styled as a hyperlink.

By default, the widget uses a field named ``color`` of the target model to
determine the color. It should be an ``Integer`` field with values from 0 to
12 (corresponding to the colors available in the ``color_picker`` field
widget). To use another field of the target model, use the ``color_field``
option:

.. code-block:: XML
<field
name="type_id"
widget="many2one_colored"
options="{'no_open': True, 'color_field': 'display_color'}"
/>
Known issues / Roadmap
======================

* In mobile mode (``env.isSmall`` is true), the view displaying the available
choices does not display the records with their corresponding color.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/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 <https://github.com/OCA/web/issues/new?body=module:%20web_widget_many2one_colored%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

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

Credits
=======

Authors
~~~~~~~

* Coop IT Easy SC

Contributors
~~~~~~~~~~~~

* `Coop IT Easy SC <https://coopiteasy.be>`_:

* hugues de keyzer

Other credits
~~~~~~~~~~~~~

The development of this module has been funded by `iMio sc
<https://www.imio.be/>`_.

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 <https://github.com/OCA/web/tree/16.0/web_widget_many2one_colored>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
3 changes: 3 additions & 0 deletions web_widget_many2one_colored/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# SPDX-FileCopyrightText: 2024 Coop IT Easy SC
#
# SPDX-License-Identifier: AGPL-3.0-or-later
21 changes: 21 additions & 0 deletions web_widget_many2one_colored/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# SPDX-FileCopyrightText: 2024 Coop IT Easy SC
#
# SPDX-License-Identifier: AGPL-3.0-or-later

{
"name": "Colored Many2one field widget",
"summary": "Display Many2one fields using a color field of their model",
"version": "16.0.1.0.0",
"category": "Web",
"website": "https://github.com/OCA/web",
"author": "Coop IT Easy SC, Odoo Community Association (OCA)",
"license": "AGPL-3",
"depends": [
"web",
],
"assets": {
"web.assets_backend": [
"web_widget_many2one_colored/static/src/*",
],
},
}
3 changes: 3 additions & 0 deletions web_widget_many2one_colored/readme/CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* `Coop IT Easy SC <https://coopiteasy.be>`_:

* hugues de keyzer
2 changes: 2 additions & 0 deletions web_widget_many2one_colored/readme/CREDITS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The development of this module has been funded by `iMio sc
<https://www.imio.be/>`_.
1 change: 1 addition & 0 deletions web_widget_many2one_colored/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Display ``Many2one`` fields using a color field of their model.
2 changes: 2 additions & 0 deletions web_widget_many2one_colored/readme/ROADMAP.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* In mobile mode (``env.isSmall`` is true), the view displaying the available
choices does not display the records with their corresponding color.
27 changes: 27 additions & 0 deletions web_widget_many2one_colored/readme/USAGE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
To use this widget, use the ``widget`` attribute on a ``Many2one`` field:

.. code-block:: XML
<field
name="type_id"
widget="many2one_colored"
options="{'no_open': True}"
/>
The ``no_open`` option is required for the field to appear in color, otherwise
it will be a hyperlink allowing to open the corresponding record, and thus
styled as a hyperlink.

By default, the widget uses a field named ``color`` of the target model to
determine the color. It should be an ``Integer`` field with values from 0 to
12 (corresponding to the colors available in the ``color_picker`` field
widget). To use another field of the target model, use the ``color_field``
option:

.. code-block:: XML
<field
name="type_id"
widget="many2one_colored"
options="{'no_open': True, 'color_field': 'display_color'}"
/>
Loading

0 comments on commit 447c82e

Please sign in to comment.